Interface IQueryRunner

The system entity for a Query Runner, which allows each result of a query to be run against a QueryRunHandler

See https://help.lemonedge.com/help/enterprise-data-tools/reporting/query-runners/intro.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.QueryRunner, "dbo.LT_QueryRunners", "QueryRunner", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "help/enterprise-data-tools/reporting/query-runners/intro.html")]
[DefaultEntityIcon(ImageType.Broadcast)]
[EntityIndex(Name = "Name", ColumnNames = new string[] { "UserID", "Name" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "SafeID", "Version", "FolderID", "AlgorithmStepID" }, IsClustered = false, IsUnique = false)]
public interface IQueryRunner : IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

Base64SerializedQueryExecuter

An optional QueryableExecuter used to filter the SQLWrapperID or EntityTypeID result set

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("An optional QueryableExecuter used to filter the SQLWrapperID or EntityTypeID result set")]
string Base64SerializedQueryExecuter { get; set; }
Property Value
Type Description
string

Description

A user friendly description for this query runner

Declaration
[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this query runner.")]
string Description { get; set; }
Property Value
Type Description
string

DisableTestRuns

Indicates if this query runner can be run in test mode or not by the user

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates if this query runner can be run in test mode or not by the user")]
bool DisableTestRuns { get; set; }
Property Value
Type Description
bool

EntityTypeID

The type of entity to use as results to call other QueryRunHandlers.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The type of entity to use as results to call other QueryRunHandlers.")]
Guid? EntityTypeID { get; set; }
Property Value
Type Description
Guid?

MergeSameFileTypes

Indicates if this query runner should attempt to merge the resulting files in certain ways. Currently only works on the client for excel files.

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates if this query runner should attempt to merge the resulting files in certain ways. Currently only works on the client for excel files.")]
QueryRunnerMergOption MergeSameFileTypes { get; set; }
Property Value
Type Description
QueryRunnerMergOption

Name

[Key] The unique name for this query runner

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this query runner.")]
[Unique]
[Required(AllowEmptyStrings = false)]
string Name { get; set; }
Property Value
Type Description
string

SQLWrapperID

The sql wrapper this query runner executes and uses the results of to call other QueryRunHandlers

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The sql wrapper this query runner executes and uses the results of to call other QueryRunHandlers.")]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper", "Query Runners", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = true, InheritPermissions = false)]
Guid? SQLWrapperID { get; set; }
Property Value
Type Description
Guid?

Extension Methods