Class QueryDefinition

This contains the structure / definition of a query, which was originally stored in an IEntity

Inheritance
object
EntityBasedType
EntityBasedWithLog
QueryDefinition
Implements
Namespace: ToSic.Eav.DataSource.Query
Assembly: ToSic.Eav.DataSources.dll
Syntax
[InternalApi_DoNotUse_MayChangeWithoutNotice("this is just fyi")]
public class QueryDefinition : EntityBasedWithLog, IHasDecorators<IEntity>, IHasLog

Fields

| Improve this Doc View Source

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.

Declaration
public int AppId
Field Value
Type Description
int
| Improve this Doc View Source

ParamRegex

Regex to detect key=value.
Keys must always be the first thing optionally followed by a = and then anything till a newline. Anything that doesn't match will be ignored.
Comments should start with a //

Declaration
public static Regex ParamRegex
Field Value
Type Description
Regex

Properties

| Improve this Doc View Source

Connections

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

Declaration
public IList<Connection> Connections { get; }
Property Value
Type Description
IList<Connection>
| Improve this Doc View Source

Params

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

Declaration
public IDictionary<string, string> Params { get; }
Property Value
Type Description
IDictionary<string, string>
| Improve this Doc View Source

ParamsLookUp

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

Declaration
public ILookUp ParamsLookUp { get; }
Property Value
Type Description
ILookUp

Always returns a valid ILookup, even if no params found.
| Improve this Doc View Source

ParamsRaw

The raw Params used in this query, as stored in the IEntity

Declaration
public string ParamsRaw { get; }
Property Value
Type Description
string
| Improve this Doc View Source

Parts

The parts of the query

Declaration
public List<QueryPartDefinition> Parts { get; }
Property Value
Type Description
List<QueryPartDefinition>
| Improve this Doc View Source

TestParameters

The test parameters as stored in the IEntity

Declaration
public string TestParameters { get; }
Property Value
Type Description
string

Methods

| Improve this Doc View Source

Reset()

Will reset all the parameters so you can run the query again with different parameters.

Declaration
public void Reset()

Implements