Table of Contents

Class QueryDefinition

Namespace
ToSic.Eav.DataSource.Query.Sys
Assembly
ToSic.Eav.DataSource.dll

This contains the structure / definition of a query, which is internally stored in an IEntity

[InternalApi_DoNotUse_MayChangeWithoutNotice]
public record QueryDefinition : ModelOfEntity, IModelSetup<IEntity>, IWrapper<IEntity>, IEquatable<ModelOfEntityCore>, IModelOfEntity, ICanBeEntity, IEquatable<ModelOfEntity>, IEquatable<QueryDefinition>
Inheritance
object
QueryDefinition
Implements
Inherited Members

Remarks

Made visible in the docs v21.02, but still just fyi/internal.

Properties

AppId

The appid inside which the query will run, not where it is stored!
This can differ, because certain global queries (stored in the global app) will run in a specific app - for example to retrieve all ContentTypes of that app.

public int AppId { get; }

Property Value

int

Connections

Connections used in the query to map various DataSource Out-Streams to various other DataTarget In-Streams

public IList<QueryWire> Connections { get; }

Property Value

IList<QueryWire>

Name

public string Name { get; }

Property Value

string

ParamsDic

The param-dictionary used for the LookUp. All keys will be available in the token [Params:key]

public IDictionary<string, string> ParamsDic { get; set; }

Property Value

IDictionary<string, string>

ParamsLookUp

The ILookUp for the params of this query - based on the Params.

public ILookUp ParamsLookUp { get; set; }

Property Value

ILookUp

Always returns a valid ILookup, even if no params found.

Parts

The parts of the query

public List<QueryPartDefinition> Parts { get; }

Property Value

List<QueryPartDefinition>

TestParameters

The test parameters as stored in the IEntity

public string? TestParameters { get; }

Property Value

string