Namespace ToSic.Eav.DataSources

DataSources are objects which deliver one or many DataStreams, which contain a bunch of content-items. They are then attached to each other (from one sources Out to another ones In) creating a Query. Queries can be customized at will. The whole system is used to prepare/process data for views, WebApi or anything else.

In most cases there will be a VisualQuery which connects all the parts automatically, but when you want to work with them programatically, here you'll find the API.

Note

We've hidden the constructors for all DataSource objects in these docs, because you should usually use the CreateSource<T>(...) command on the Razor template or WebApi, which will auto-configure things behind the scenes.

Tip

Read about DataSources here. It also explains how the configuration system works and how to create custom DataSources to deliver your data to EAV/2sxc.

Classes

App

All the data inside an App.
For example, it has a variable amount of Out-streams, one for each content-type in the app.

AppRoot

The App Root is the entry point for all data. It takes it's data from a hidden AppState Cache. It's implemented as a DataSource so that other DataSources can easily attach to it.
This is also the object returned as the root in any query.

AttributeFilter

DataSource to only pass through configured AttributeNames - other attributes/properties are removed from the entities.

AttributeRename

DataSource to only pass through configured AttributeNames - other attributes/properties are removed from the entities.

CsvDataSource

DataSource for importing/reading CSV files.

DataSourceBase

The base class, which should always be inherited. Already implements things like Get One / Get many, Caching and a lot more.

DataTable

Provide Entities from a System.Data.DataTable.
This is not meant for VisualQuery, but for code which pre-processes data in a DataTable and then wants to provide it as entities.

EntityIdFilter

A DataSource that filters Entities by Ids

EntityTypeFilter

Return only entities of a specific content-type

ExternalData

Base DataSource class for providing data from external systems

ItemFilterDuplicates

A DataSource that merges two streams

OwnerFilter

Filter entities to show Drafts or only Published Entities

Paging

A DataSource that filters Entities by Ids

PassThrough

A DataSource that passes through all In Connections. Can be used con consolidate/merge multiple Sources into one.

PublishingFilter

Filter entities to show Drafts or only Published Entities

QueryRun

Run another query and provide the resulting data. The settings will provide the params for the query.

RelationshipFilter

Filter Entities by Value in a Related Entity. For example: Find all Books (desired Entity), whose Authors (related Entity) have a Country (Attribute) with 'Switzerland' (Value).

Shuffle

A DataSource that filters Entities by Ids

Sql

Provide Entities from a SQL Server

StreamFallback

A DataSource that returns the first stream which has content

StreamMerge

A DataSource that merges two streams

StreamPick

A DataSource that returns a stream by the provided name. Usually this will be configured through [Params:SomeName]

ValueFilter

Return only Entities having a specific value in an Attribute

ValueSort

Sort Entity by values in specified Attributes

Interfaces

IAppRoot

Interface for the App Root - usually the very first node in any data-delivery or query.
It's just like a normal IDataSource but will internally access the AppState from the IAppsCache.

IDataSource

Public interface for an Eav DataSource. All DataSource objects are based on this.

IDataSourceConfiguration

This helps a data source get configured. It manages all the properties which the data source will want to look up, as well as the LookUp engine which will perform the token resolution

IDataStream

Represents a DataStream object. This is a stream of IEntity objects, which has a source and a name. A stream can be read from, and it can be attached to upstream data-sources for further processing.

IDataTarget

Represents a data source that can be the recipient of Data. This basically means it has an In IDataStream