Fix Breaking Change DataSource in v15

Keywords: #DataSource #CustomDataSource

2sxc/EAV has a powerful extension system called DataSource which allows you to create new data providers.

We completely reworked object hierarchy and Dependency Injection. Because of this, any custom DataSource will have to be adjusted and recompiled.

Reason for Change

The DataSource concept was created in times before Dependency Injection. This means that the architecture was very problematic, and we had a lot of hacky implementations to make it work.

History - How it Used to Work

Previously all DataSources inherited from

1. ToSic.Eav.DataSources.DataSourceBase
2. ToSic.Eav.DataSources.ExternalData
3. ...from another data source

These had empty constructors, so your DataSource could also have an empty constructor.

Internally it still needed some helper objects which were only available because a special factory added them later on.

What we Changed

1. Base Class with Parameters in Constructor

1. The base class was renamed to ToSic.Eav.DataSources.DataSource
2. The base class now always expects 2 parameters in the constructor
   1. Dependencies dependencies - type TODO
   2. string logName - for any messages which appear in Insights

To make this work, any inheriting class must implement a minimal constructor like this:

class MyDataSource
{
  // Constructor
  public MyDataSource(Dependencies dependencies): base(dependencies, $"My.DataSc")
  {
    //...
  }
}

2. Changes in Logging

If your DataSource does any logging, see also breaking changes in logging

3. Removed Old Base Classes

Some old base classes may have still been in use, but because the code must be recompiled anyhow we decided to remove these.

These are the classes and their replacement:

1. ToSic.Eav.DataSources.BaseDataSource - > DataSource
2. ToSic.Eav.DataSources.DataTableDataSource -> ToSic.Eav.DataSources.DataTable
3. ToSic.Eav.DataSources.ExternalDataDataSource: ToSic.Eav.DataSources.ExternalData
4. ToSic.Eav.DataSources.SqlDataSource: ToSic.Eav.DataSources.Sql

Also

1. ToSic.Eav.DataSources.VisualQuery.VisualQueryAttribute -> DataSources.Queries.VisualQueryAttribute

4. Changes in Provide signature

Previously there were many Provide(...) methods but we reduced it to 2 and renamed to ProvideOut for better readability. Now you should use:

• ProvideOut(function) or the named stream ProvideOut(function, "MyStream")

Where function can be

1. () => IEnumerable<IEntity>
2. () => IImmutableList<IEntity>

They will behave the same, but providing an IImmutableList is slightly more performant.

5. Changes in how Configuration is retrieved

Now it uses the attribute [Configuration] and Configuration.GetThis() and Configuration.SetThis(value).

6. Changes in VisualQuery attribute

1. GlobalName is now NameId
2. PreviousNames is now NameIds

7. Changes in Error handling

1. Use TryGetIn() to see if an in-stream exists and get the data

TODO:

---

History

• Introduced ca. 2sxc 5
• Completely reworked in 2sxc/eav 15

---