Class CustomDataSource

Namespace

ToSic.Eav.DataSource

Assembly

ToSic.Eav.DataSource.dll

DataSource base for lightweight data sources which are quite simple and convention based.

[PublicApi]
public class CustomDataSource : DataSourceBase, IDataSource, IAppIdentity, IZoneIdentity, IAppIdentityLight, ICacheKey, ICacheExpiring, ITimestamped, IHasLog, IDataSourceLinkable, IServiceWithSetup<IDataSourceOptions>

Inheritance

object

ServiceBase

ServiceBase<DataSourceBase.Dependencies>

DataSourceBase

CustomDataSource

Implements

IDataSource

IAppIdentity

IZoneIdentity

IAppIdentityLight

ICacheKey

ICacheExpiring

ITimestamped

IHasLog

IDataSourceLinkable

IServiceWithSetup<IDataSourceOptions>

Derived

Csv

DataTable

RecycleBin

Sql

Apps

Attributes

ContentTypes

Features

Licenses

MetadataTargetTypes

QueryInfo

Scopes

SystemStack

Zones

AppAssets

Pages

Sites

UserRoles

Users

DnnUserProfile

Inherited Members

DataSourceBase.AppId

DataSourceBase.ZoneId

DataSourceBase.Guid

DataSourceBase.Error

DataSourceBase.CacheTimestamp

DataSourceBase.CacheChanged(long)

DataSourceBase.Configuration

DataSourceBase.In

DataSourceBase.TryGetIn(string)

DataSourceBase.TryGetOut(string)

DataSourceBase.Out

DataSourceBase.this[string]

DataSourceBase.GetStream(string, NoParamOrder, bool, bool)

DataSourceBase.List

DataSourceBase.ProvideOut(Func<IEnumerable<IEntity>>, string)

DataSourceBase.ProvideOut(Func<IImmutableList<IEntity>>, string)

ServiceBase<DataSourceBase.Dependencies>.Services

ServiceBase.ConnectLogs(object[])

Constructors

CustomDataSource(Dependencies, string?, object[]?)

Constructor for creating a Custom DataSource.

protected CustomDataSource(CustomDataSource.Dependencies services, string? logName = null, object[]? connect = null)

Parameters

services CustomDataSource.Dependencies

All the needed services - see Convention: Dependencies Class

logName string

Optional name for logging such as My.JsonDS

connect object[]

Properties

Immutable

Every new DataSource based on this is immutable.

public override bool Immutable { get; }

Property Value

bool

Methods

GetDefault()

Default method called to return data. If the inheriting class overrides this, it can go without having a full constructor.

protected virtual IEnumerable<IRawData> GetDefault()

Returns

IEnumerable<IRawData>