Class EntitySchemaQuery

Represents the entity schema query. It is a high-level class that enables to build complex queries using only paths to columns of the table entity (schema) against the root table.

Inheritance

System.Object

EntitySchemaQuery

EntitySegmentProcessor

Implements

IManagerItemInstance

System.ICloneable

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Terrasoft.Core.Entities

Assembly: Terrasoft.Core.dll

Syntax

[MetaType("{DBE36562-96FA-4d4f-B171-8C18EAAEA20D}")]
[DesignModeClass(ResourceManager = "Terrasoft.Core")]
public class EntitySchemaQuery : IManagerItemInstance, ICloneable

Constructors

EntitySchemaQuery()

Initializes the EntitySchemaQuery instance.

Declaration

public EntitySchemaQuery()

Remarks

Used internally and not applied for the workspace.

EntitySchemaQuery(EntitySchema)

Initializes the EntitySchemaQuery instance with the specified root schema.

Declaration

public EntitySchemaQuery(EntitySchema rootSchema)

Parameters

Type	Name	Description
EntitySchema	rootSchema	The root schema.

Remarks

The passed-in rootSchema instance is set as the root schema. The manager of the passed-in instance of the root schema is set as the schema manager.

EntitySchemaQuery(EntitySchema, CancellationToken)

Initialises instance of EntitySchemaQuery whith the given root schema.

Declaration

public EntitySchemaQuery(EntitySchema rootSchema, CancellationToken cancellationToken)

Parameters

Type	Name	Description
EntitySchema	rootSchema	Root schema.
System.Threading.CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Remarks

The manager of the root schema will be used as a manager for this instance of EntitySchemaQuery

EntitySchemaQuery(EntitySchemaManager, String)

Initializes the EntitySchemaQuery instance with the specified schema manager and root schema name.

Declaration

public EntitySchemaQuery(EntitySchemaManager entitySchemaManager, string sourceSchemaName)

Parameters

Type	Name	Description
EntitySchemaManager	entitySchemaManager	The instance of the schema manager.
System.String	sourceSchemaName	Name of the root schema.

Remarks

If the schema with the sourceSchemaName name is found in the entitySchemaManager schema manager, its instance is used as the root schema.

EntitySchemaQuery(EntitySchemaQuery)

Initializes the EntitySchemaQuery instance that is a clone of the passed-in entity schema query.

Declaration

public EntitySchemaQuery(EntitySchemaQuery source)

Parameters

Type	Name	Description
EntitySchemaQuery	source	The EntitySchemaQuery instance whose clone is being created.

Properties

AdminUnitRoleSources

Declaration

public AdminUnitRoleSources AdminUnitRoleSources { get; set; }

Property Value

Type	Description
AdminUnitRoleSources

Cache

The query cache.

Declaration

public ICacheStore Cache { get; set; }

Property Value

Type	Description
ICacheStore

CacheItemName

Name of the cache item.

Declaration

public string CacheItemName { get; set; }

Property Value

Type	Description
System.String

CanReadUncommitedData

Determines whether the query results will include the data for which the transaction is not completed.

Declaration

public bool CanReadUncommitedData { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

If the property is equal to true, data for which the transaction has not been completed qualifies as output for the query; if it is equal to false, only data for which the transaction has been completed qualify as output for the query. Default value: true.

Caption

Header.

Declaration

public LocalizableString Caption { get; set; }

Property Value

Type	Description
LocalizableString

Remarks

Is by default initialized by the query schema caption.

ChunkSize

Rows to read from DB in single chunk.

Declaration

public int ChunkSize { get; set; }

Property Value

Type	Description
System.Int32

Columns

Collection of columns of the current entity schema query.

Declaration

public EntitySchemaQueryColumnCollection Columns { get; }

Property Value

Type	Description
EntitySchemaQueryColumnCollection

Remarks

Default value: contains a column from the PrimaryQueryColumn property.

DataValueTypeManager

Manager of the data type values.

Declaration

public DataValueTypeManager DataValueTypeManager { get; }

Property Value

Type	Description
DataValueTypeManager

EntitySchemaManager

Entity schema manager.

Declaration

public EntitySchemaManager EntitySchemaManager { get; }

Property Value

Type	Description
EntitySchemaManager

Filters

Collection of filters of the current entity schema query.

Declaration

public EntitySchemaQueryFilterCollection Filters { get; }

Property Value

Type	Description
EntitySchemaQueryFilterCollection

HideSecurityValue

The parameter that defines whether the values of the encrypted columns will be hidden.

Declaration

public bool HideSecurityValue { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Default value: false. If the parameter is true, the encrypted columns value will be null.

IgnoreDisplayValues

Indicates whether displayed values of columns are used in the query.

Declaration

public bool IgnoreDisplayValues { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

If the property is equal to true, the query returns displayed values of columns; if it is equal to false, the query returns stored values of columns.

IsDistinct

Indicates whether to remove duplicates in the resulting data set.

Declaration

public bool IsDistinct { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

The default value: false.

IsInherited

Indicates whether the query is inherited.

Declaration

public bool IsInherited { get; set; }

Property Value

Type	Description
System.Boolean

JoinRightState

The parameter that defines conditions for applying permissions when using related tables if the schema is managed by records.

Declaration

public QueryJoinRightLevel JoinRightState { get; set; }

Property Value

Type	Description
QueryJoinRightLevel

Remarks

Default value: is read from the QueryJoinRightLevel system setting. If the setting is not specified, the value is EnabledForAdditionalColumns.

Manager

Schema manager.

Declaration

public IManager Manager { get; }

Property Value

Type	Description
IManager

ManagerItem

Manager item.

Declaration

public IManagerItem ManagerItem { get; set; }

Property Value

Type	Description
IManagerItem

Name

Name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Exceptions

Type	Condition
System.ArgumentException	When trying to change the name of the base view.
System.ArgumentException	If a value that is not an actual identifier or an empty string is assigned to the property.

ParentCollection

A collection of queries to which the current request to the object schema belongs.

Declaration

public EntitySchemaQueryCollection ParentCollection { get; }

Property Value

Type	Description
EntitySchemaQueryCollection

ParentEntitySchema

Parent schema of the query.

Declaration

public EntitySchema ParentEntitySchema { get; }

Property Value

Type	Description
EntitySchema

PrimaryQueryColumn

The column created from the primary column of the root schema. Initialized during the first access.

Declaration

public EntitySchemaQueryColumn PrimaryQueryColumn { get; }

Property Value

Type	Description
EntitySchemaQueryColumn

Remarks

Default value: instance created from the primary column of the root schema.

QueryOptimize

Allows using query optimization.

Declaration

public bool QueryOptimize { get; set; }

Property Value

Type	Description
System.Boolean

RootSchema

The root schema.

Declaration

public EntitySchema RootSchema { get; }

Property Value

Type	Description
EntitySchema

Remarks

All paths to columns of schemas are relative to this root schema. Property is initialized in the constructor. The default value: null.

RootSchemaAlias

Gets or sets alias for the root schema.

Declaration

public string RootSchemaAlias { get; }

Property Value

Type	Description
System.String

RowCount

Number of rows that are returned by the query.

Declaration

public int RowCount { get; set; }

Property Value

Type	Description
System.Int32

SchemaAliasPrefix

Gets or sets the prefix, that is used in schemas aliases generation.

Declaration

public string SchemaAliasPrefix { get; set; }

Property Value

Type	Description
System.String

SkipRowCount

Number of rows to skip in the resulting data set.

Declaration

public int SkipRowCount { get; set; }

Property Value

Type	Description
System.Int32

UseAdminRights

The parameter that defines whether permissions will be taken into account when constructing a data acquisition request.

Declaration

public bool UseAdminRights { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Default value: true

UseLocalization

The parameter that defines whether localized data will be used.

Declaration

public bool UseLocalization { get; set; }

Property Value

Type	Description
System.Boolean

UseOffsetFetchPaging

Declaration

public bool UseOffsetFetchPaging { get; set; }

Property Value

Type	Description
System.Boolean

UseRecordDeactivation

Represent parameter which determines disabling data in filtering.

Declaration

public bool UseRecordDeactivation { get; set; }

Property Value

Type	Description
System.Boolean

Methods

AddAllSchemaColumns(Boolean)

The object schema adds all the columns of the root schema in the column collection of the current query.

Declaration

public void AddAllSchemaColumns(bool skipSystemColumns = false)

Parameters

Type	Name	Description
System.Boolean	skipSystemColumns

AddColumn(Object, DataValueType)

In the current entity schema query, creates and inserts a column of the parameter type with the specified value of a specific type.

Declaration

public EntitySchemaQueryColumn AddColumn(object parameterValue, DataValueType parameterDataValueType)

Parameters

Type	Name	Description
System.Object	parameterValue	The value of the parameter.
DataValueType	parameterDataValueType	The type of the parameter value.

Returns

Type	Description
EntitySchemaQueryColumn	Instance of the created EntitySchemaQueryColumn column.

AddColumn(String)

Creates and inserts a column in the current entity schema query by the specified path to column in relation to the root schema.

Declaration

public EntitySchemaQueryColumn AddColumn(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to the schema column in relation to the root schema.

Returns

Type	Description
EntitySchemaQueryColumn	Instance of the created column.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If the empty value or null value is passed as the columnPath parameter.

AddColumn(String, AggregationTypeStrict, out EntitySchemaQuery)

Creates and adds a column to the current query for the object schema in the form of a subquery that returns the result of the specified aggregate function, along the path to the schema column relative to the root schema.

Declaration

public EntitySchemaQueryColumn AddColumn(string columnPath, AggregationTypeStrict aggregationType, out EntitySchemaQuery subQuery)

Parameters

Type	Name	Description
System.String	columnPath	Path to the schema column in relation to the root schema.
AggregationTypeStrict	aggregationType	The type of aggregate function. The enumeration values of the AggregationTypeStrict aggregate function are passed as a parameter.
EntitySchemaQuery	subQuery	Reference to the created subquery placed in the column.

Returns

Type	Description
EntitySchemaQueryColumn	Instance of the created EntitySchemaQueryColumn column.

AddColumn(EntitySchemaQuery)

Creates and adds given instance of EntitySchemaQuery as a column of current query entity schema.

Declaration

public EntitySchemaQueryColumn AddColumn(EntitySchemaQuery subQuery)

Parameters

Type	Name	Description
EntitySchemaQuery	subQuery	An instance of EntitySchemaQuery, which is added as a column of current query.

Returns

Type	Description
EntitySchemaQueryColumn	An instance of created column EntitySchemaQueryColumn.

AddColumn(EntitySchemaQueryColumn)

Adds passed column to the collection of columns of the current entity schema query.

Declaration

public void AddColumn(EntitySchemaQueryColumn queryColumn)

Parameters

Type	Name	Description
EntitySchemaQueryColumn	queryColumn	The EntitySchemaQueryColumn instance to be added to the column collection of the current query.

AddColumn(EntitySchemaQueryFunction)

Creates and inserts a column in the current entity schema query by the passed function.

Declaration

public EntitySchemaQueryColumn AddColumn(EntitySchemaQueryFunction function)

Parameters

Type	Name	Description
EntitySchemaQueryFunction	function	The instance of the EntitySchemaQueryFunction function.

Returns

Type	Description
EntitySchemaQueryColumn	Instance of the created EntitySchemaQueryColumn column.

ClearCache()

Declaration

[Obsolete("7.14.2 | Method is not in use and will be removed in upcoming builds")]
public void ClearCache()

ClearDefCache(String)

Declaration

[Obsolete("7.14.2 | Method is not in use and will be removed in upcoming builds")]
public static void ClearDefCache(string cacheItemName)

Parameters

Type	Name	Description
System.String	cacheItemName

ClearDefCache(UserConnection, String)

Declaration

public static void ClearDefCache(UserConnection userConnection, string cacheItemName)

Parameters

Type	Name	Description
UserConnection	userConnection
System.String	cacheItemName

Clone()

Creates the clone of the current EntitySchemaQuery instance.

Declaration

public object Clone()

Returns

Type	Description
System.Object	The System.Object instance that is a clone of the current entity schema query.

CreateAggregationEntitySchemaExpression(String, AggregationTypeStrict)

Gets an expression of the aggregating function of the specified type to express a column that is located along a specified path.

Declaration

public EntitySchemaQueryExpression CreateAggregationEntitySchemaExpression(string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType)

Parameters

Type	Name	Description
System.String	leftExprColumnPath	Path to the column for whose expression the aggregate function is built.
AggregationTypeStrict	leftExprAggregationType	The type of aggregate function.

Returns

Type	Description
EntitySchemaQueryExpression	The expression instance of the created aggregate function.

CreateAggregationFunction(AggregationTypeStrict, String)

Gets the instance of the EntitySchemaAggregationQueryFunction aggregate function with the specified type of column in a specified path in relation to the root schema.

Declaration

public EntitySchemaAggregationQueryFunction CreateAggregationFunction(AggregationTypeStrict aggregationType, string columnPath)

Parameters

Type	Name	Description
AggregationTypeStrict	aggregationType	Type of aggregating function.
System.String	columnPath	Path to the schema column in relation to the root schema.

Returns

Type	Description
EntitySchemaAggregationQueryFunction	The instance of the created EntitySchemaAggregationQueryFunction aggregate function.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If an empty string or null is received as the columnPath parameter.

CreateCaseNotNullFunction(EntitySchemaCaseNotNullQueryFunctionWhenItem[])

Gets the instance of the EntitySchemaCaseNotNullQueryFunction function for the specified array of condition expressions.

Declaration

public EntitySchemaCaseNotNullQueryFunction CreateCaseNotNullFunction(params EntitySchemaCaseNotNullQueryFunctionWhenItem[] whenItems)

Parameters

Type	Name	Description
EntitySchemaCaseNotNullQueryFunctionWhenItem[]	whenItems	Array of condition expressions for the function being created.

Returns

Type	Description
EntitySchemaCaseNotNullQueryFunction	The instance of the created EntitySchemaCaseNotNullQueryFunction function.

CreateCaseNotNullQueryFunctionWhenItem(String, Object)

Returns an instance of an expression for the sql construct of the WHEN <Expression_1> IS NOT NULL THEN <Expression_2> form.

Declaration

public EntitySchemaCaseNotNullQueryFunctionWhenItem CreateCaseNotNullQueryFunctionWhenItem(string whenColumnPath, object thenParameterValue)

Parameters

Type	Name	Description
System.String	whenColumnPath	Path to the column that contains the expression of the WHEN clause.
System.Object	thenParameterValue	Path to the column that contains the expression of the THEN clause.

Returns

Type	Description
EntitySchemaCaseNotNullQueryFunctionWhenItem	Instance of the created EntitySchemaCaseNotNullQueryFunctionWhenItem condition expression.

CreateCastFunction(String, DBDataValueType)

Returns an instance of the EntitySchemaCastQueryFunction function for the specified column expression by the specified path relative to the root schema and specified target data type.

Declaration

public EntitySchemaCastQueryFunction CreateCastFunction(string columnPath, DBDataValueType castType)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.
DBDataValueType	castType	The target data type.

Returns

Type	Description
EntitySchemaCastQueryFunction	The instance of the created EntitySchemaCastQueryFunction function.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If an empty string or null is received as the columnPath parameter.

CreateCoalesceFunction(String[])

Returns an instance of the EntitySchemaCoalesceQueryFunction function for the specified array of paths to columns relative to the root schema.

Declaration

public EntitySchemaCoalesceQueryFunction CreateCoalesceFunction(params string[] columnPaths)

Parameters

Type	Name	Description
System.String[]	columnPaths	Array of paths to columns in relation to the root schema.

Returns

Type	Description
EntitySchemaCoalesceQueryFunction	The instance of the created EntitySchemaCoalesceQueryFunction function.

CreateCoalesceFunction(EntitySchema, String[])

Gets the instance of the EntitySchemaCoalesceQueryFunction function for the specified root schema and array of paths to columns.

Declaration

public static EntitySchemaCoalesceQueryFunction CreateCoalesceFunction(EntitySchema rootSchema, params string[] columnPaths)

Parameters

Type	Name	Description
EntitySchema	rootSchema	The root schema.
System.String[]	columnPaths	Array of paths to columns in relation to the root schema.

Returns

Type	Description
EntitySchemaCoalesceQueryFunction	The created EntitySchemaCoalesceQueryFunction instance.

CreateCoalesceFunction(EntitySchemaQuery, EntitySchema, String[])

Gets the instance of the EntitySchemaCoalesceQueryFunction function for the specified parent query, root schema and array of paths to columns.

Declaration

public static EntitySchemaCoalesceQueryFunction CreateCoalesceFunction(EntitySchemaQuery parentQuery, EntitySchema rootSchema, params string[] columnPaths)

Parameters

Type	Name	Description
EntitySchemaQuery	parentQuery	Query to entity schema, for which the function instance is created.
EntitySchema	rootSchema	The root schema.
System.String[]	columnPaths	Array of paths to columns in relation to the root schema.

Returns

Type	Description
EntitySchemaCoalesceQueryFunction	The created EntitySchemaCoalesceQueryFunction instance.

Exceptions

Type	Condition
ArgumentEmptyException	If null is passed as the columnPaths parameter.

CreateConcatFunction(EntitySchemaQueryExpression[])

Gets the instance of the EntitySchemaConcatQueryFunction function for the specified array of expressions.

Declaration

public EntitySchemaConcatQueryFunction CreateConcatFunction(params EntitySchemaQueryExpression[] expressions)

Parameters

Type	Name	Description
EntitySchemaQueryExpression[]	expressions	Array of expressions.

Returns

Type	Description
EntitySchemaConcatQueryFunction	The instance of the created EntitySchemaConcatQueryFunction function.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If the null value is passed as the expressions parameter, or if the array of expressions has no items.

CreateCurrentDateFunction()

Gets the instance of the EntitySchemaCurrentDateQueryFunction function that returns the current date.

Declaration

public EntitySchemaCurrentDateQueryFunction CreateCurrentDateFunction()

Returns

Type	Description
EntitySchemaCurrentDateQueryFunction	The instance of the created EntitySchemaCurrentDateQueryFunction function.

CreateCurrentDateTimeFunction()

Gets the instance of the EntitySchemaCurrentDateTimeQueryFunction function that returns the current date and time.

Declaration

public EntitySchemaCurrentDateTimeQueryFunction CreateCurrentDateTimeFunction()

Returns

Type	Description
EntitySchemaCurrentDateTimeQueryFunction	The instance of the created EntitySchemaCurrentDateTimeQueryFunction function.

CreateCurrentTimeFunction()

Gets the instance of the EntitySchemaCurrentTimeQueryFunction function that defines the current date and time.

Declaration

public EntitySchemaCurrentTimeQueryFunction CreateCurrentTimeFunction()

Returns

Type	Description
EntitySchemaCurrentTimeQueryFunction	The instance of the created EntitySchemaCurrentTimeQueryFunction function.

CreateCurrentUserAccountFunction()

Gets the instance of the EntitySchemaCurrentUserAccountQueryFunction function that defines the account Id of the current user.

Declaration

public EntitySchemaCurrentUserAccountQueryFunction CreateCurrentUserAccountFunction()

Returns

Type	Description
EntitySchemaCurrentUserAccountQueryFunction	The instance of the created EntitySchemaCurrentUserAccountQueryFunction function.

CreateCurrentUserContactFunction()

Gets the instance of the EntitySchemaCurrentUserContactQueryFunction function that defines the contact Id of the current user.

Declaration

public EntitySchemaCurrentUserContactQueryFunction CreateCurrentUserContactFunction()

Returns

Type	Description
EntitySchemaCurrentUserContactQueryFunction	The instance of the created EntitySchemaCurrentUserContactQueryFunction function.

CreateCurrentUserFunction()

Gets the instance of the EntitySchemaCurrentUserQueryFunction function that defines the current user.

Declaration

public EntitySchemaCurrentUserQueryFunction CreateCurrentUserFunction()

Returns

Type	Description
EntitySchemaCurrentUserQueryFunction	The instance of the created EntitySchemaCurrentUserQueryFunction function.

CreateDatePartFunction(EntitySchemaDatePartQueryFunctionInterval, String)

Gets an instance of the EntitySchemaDatePartQueryFunction function that returns a specified date range for a column value that is located along the specified path relative to the root schema.

Declaration

public EntitySchemaDatePartQueryFunction CreateDatePartFunction(EntitySchemaDatePartQueryFunctionInterval interval, string columnPath)

Parameters

Type	Name	Description
EntitySchemaDatePartQueryFunctionInterval	interval	The datepart returned by the function.
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaDatePartQueryFunction	The instance of the created EntitySchemaDatePartQueryFunction function.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If the empty value or null value is passed as the columnPath parameter.

CreateDatePartFunctionExpression(EntitySchemaDatePartQueryFunctionInterval, EntitySchemaQueryExpression)

Returns an instance EntitySchemaQueryExpression with nested function EntitySchemaDatePartQueryFunction returns the specified date range for the value of the column located along the specified path relative to the root schema.

Declaration

public EntitySchemaQueryExpression CreateDatePartFunctionExpression(EntitySchemaDatePartQueryFunctionInterval interval, EntitySchemaQueryExpression expression)

Parameters

Type	Name	Description
EntitySchemaDatePartQueryFunctionInterval	interval	The date part returned by the function.
EntitySchemaQueryExpression	expression	The expression on the left side of the filter.

Returns

Type	Description
EntitySchemaQueryExpression	An instance of an expression from a given function.

CreateDayFunction(String)

Gets an instance of the EntitySchemaDatePartQueryFunction function that returns a [Day] date range for a column value that is located along the specified path relative to the root schema.

Declaration

public EntitySchemaDatePartQueryFunction CreateDayFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaDatePartQueryFunction	The instance of the created EntitySchemaDatePartQueryFunction function.

CreateExistsFilter(String)

For the current entity schema query, gets the comparison filter of the type [exists by the specified condition] and sets the expression of column in a specified path as the value to test for.

Declaration

public EntitySchemaQueryFilter CreateExistsFilter(string rightExpressionColumnPath)

Parameters

Type	Name	Description
System.String	rightExpressionColumnPath	Path to the column for whose expression the filter is built.

Returns

Type	Description
EntitySchemaQueryFilter	Instance of the created EntitySchemaQueryFilter filter.

CreateFilter(FilterComparisonType, String, String[])

Gets the filter with the specified comparison type for expressions of two columns in paths specified in relation to the root schema.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, params string[] rightExpressionColumnPaths)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
System.String[]	rightExpressionColumnPaths	Array of paths that contain the filter's right side expressions.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, AggregationTypeStrict, DateTime)

Gets the filter with the specified comparison type for the expression of column in a specified path, specified type of the aggregate function and passed-in parameter value of the System.DateTime type. The aggregate function in the filter's right side is applied to this parameter value.

Declaration

public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, DateTime rightExprParameterValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExprColumnPath	Path to the column that contains the filter's left side expression.
AggregationTypeStrict	leftExprAggregationType	Type of aggregating function.
System.DateTime	rightExprParameterValue	Value of the parameter to which the filter's right side aggregate function is applied.

Returns

Type	Description
EntitySchemaQueryFilter	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, AggregationTypeStrict, Double)

Gets the filter with the specified comparison type for the expression of column in a specified path, specified type of the aggregate function and passed-in parameter value of the System.Double type. The aggregate function in the filter's right side is applied to this parameter value.

Declaration

public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, double rightExprParameterValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExprColumnPath	Path to the column that contains the filter's left side expression.
AggregationTypeStrict	leftExprAggregationType	Type of aggregating function.
System.Double	rightExprParameterValue	Value of the parameter to which the filter's right side aggregate function is applied.

Returns

Type	Description
EntitySchemaQueryFilter	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, AggregationTypeStrict, Int32)

Gets the filter with the specified comparison type for the expression of column in a specified path, specified type of the aggregate function and passed-in parameter value of the System.Int32 type. The aggregate function in the filter's right side is applied to this parameter value.

Declaration

public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, int rightExprParameterValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExprColumnPath	Path to the column that contains the filter's left side expression.
AggregationTypeStrict	leftExprAggregationType	Type of aggregating function.
System.Int32	rightExprParameterValue	Value of the parameter to which the filter's right side aggregate function is applied.

Returns

Type	Description
EntitySchemaQueryFilter	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, AggregationTypeStrict, Object, out EntitySchemaQuery)

Gets the filter with the specified comparison type for the expression of column in a specified path, specified type of the aggregate function and passed-in parameter value. The aggregate function in the filter's right side is applied to this parameter value. In this case, the outgoing parameter returns a subquery for the expression from the left side of the filter, or a subquery for the first expression from the right side of the filter, if the left expression of the filter is null.

Declaration

public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, object rightExprParameterValue, out EntitySchemaQuery leftExprSubQuery)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExprColumnPath	Path to the column that contains the filter's left side expression.
AggregationTypeStrict	leftExprAggregationType	Type of aggregating function.
System.Object	rightExprParameterValue	Value of the parameter to which the filter's right side aggregate function is applied.
EntitySchemaQuery	leftExprSubQuery	A parameter that returns a subquery for the expression on the left side of the filter (if it is not null) or a subquery for the first expression on the right side of the filter (if the left-hand side of the filter is null).

Returns

Type	Description
EntitySchemaQueryFilter	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, AggregationTypeStrict, String)

Gets the filter with the specified comparison type for the column in a specified path, specified type of the aggregate function and passed-in parameter value of the System.String type. The aggregate function in the filter's right side is applied to this parameter value.

Declaration

public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, string rightExprParameterValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExprColumnPath	Path to the column that contains the filter's left side expression.
AggregationTypeStrict	leftExprAggregationType	Type of aggregating function.
System.String	rightExprParameterValue	Value of the parameter to which the filter's right side aggregate function is applied.

Returns

Type	Description
EntitySchemaQueryFilter	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, AggregationTypeStrict, EntitySchemaQueryMacrosType, Int32)

Gets the filter with the specified comparison type for the expression of column in a specified path, specified type of the aggregate function, specified macro type and value for which the macro is applied in the filter’s right side. T

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, EntitySchemaQueryMacrosType macrosType, int daysCount = 0)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExprColumnPath	Path to the column that contains the filter's left side expression.
AggregationTypeStrict	leftExprAggregationType	Type of aggregating function.
EntitySchemaQueryMacrosType	macrosType	Macro type.
System.Int32	daysCount	Value to which the filter's right side macro is applied. Optional parameter, default value is 0.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, AggregationTypeStrict, EntitySchemaQueryMacrosType, out EntitySchemaQuery, Int32)

Gets the filter with the specified comparison type for the expression of column in a specified path, specified type of the aggregate function, specified macro type and value for which the macro is applied in the filter’s right side. T In this case, the outgoing parameter returns a subquery for the expression from the left side of the filter.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, EntitySchemaQueryMacrosType macrosType, out EntitySchemaQuery leftExprSubQuery, int daysCount = 0)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExprColumnPath	Path to the column that contains the filter's left side expression.
AggregationTypeStrict	leftExprAggregationType	Type of aggregating function.
EntitySchemaQueryMacrosType	macrosType	Macro type.
EntitySchemaQuery	leftExprSubQuery	Parameter where a subquery for the expression from the left side of the filter is returned.
System.Int32	daysCount	Value processed by the macro in the filter's right side. Optional parameter, default value is 0.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, EntitySchemaQuery)

Gets the filter with the specified comparison type for the expression of column in a specified path and the passed-in subquery.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQuery rightExpressionValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
EntitySchemaQuery	rightExpressionValue	Subquery expression in the filter's right side.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, EntitySchemaQueryExpression)

Gets the filter with the specified comparison type for the expression of column in a specified path relative to the root schema and the passed-in expression.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryExpression rightExpression)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
EntitySchemaQueryExpression	rightExpression	Expression in the filter's right side.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, EntitySchemaQueryFunction)

Gets the filter with the specified comparison type for the expression of column in a specified path relative to the root schema and the passed-in function instance.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryFunction rightExpressionValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
EntitySchemaQueryFunction	rightExpressionValue	An instance of the expression function in the filter's right side.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, EntitySchemaQueryMacrosType, DateTime)

Gets the filter with the specified comparison type for the expression of column in a specified path, the macro type and the System.DateTime type value that is processed by the macro in the filter's right side.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryMacrosType macrosType, DateTime rightValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
EntitySchemaQueryMacrosType	macrosType	Macro type.
System.DateTime	rightValue	Value of the System.DateTime type processed by the macro in the filter's right side.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, EntitySchemaQueryMacrosType, DayOfWeek)

Gets the filter with the specified comparison type for the expression of column in a specified path, the macro type and the System.DayOfWeek type value that is processed by the macro in the filter's right side.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryMacrosType macrosType, DayOfWeek rightValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
EntitySchemaQueryMacrosType	macrosType	Macro type.
System.DayOfWeek	rightValue	Value of the System.DayOfWeek type processed by the macro in the filter's right side.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, String, EntitySchemaQueryMacrosType, Int32)

Gets the filter with the specified comparison type for the expression of column in a specified path, specified macro type and numeric value that is processed by the macro in the filter's right side.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryMacrosType macrosType, int rightValue = 0)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
EntitySchemaQueryMacrosType	macrosType	Macro type.
System.Int32	rightValue	Value processed by the macro in the filter's right side. Used for the NextNDays and PreviousNDays macro types. Optional parameter, default value is 0.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilter(FilterComparisonType, EntitySchemaQueryExpression, EntitySchemaQueryMacrosType, DateTime, Int32)

Returns a filter with the specified comparison type for the specified parameters.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, EntitySchemaQueryExpression leftExpression, EntitySchemaQueryMacrosType macrosType, DateTime dateValue, int daysOffset = 0)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
EntitySchemaQueryExpression	leftExpression	The expression on the left side of the filter.
EntitySchemaQueryMacrosType	macrosType	Macros type.
System.DateTime	dateValue	Type value System.DateTime, which is processed by a macro on the right side of the filter.
System.Int32	daysOffset	Number of days to be added to create filter range boundary.

Returns

Type	Description
IEntitySchemaQueryFilterItem	An instance of a filter.

Exceptions

Type	Condition
UnsupportedTypeException	If unsupported macros type is passed.

CreateFilter(FilterComparisonType, EntitySchemaQueryExpression, EntitySchemaQueryMacrosType, DayOfWeek)

Gets the filter with the specified comparison type for the specified filter's left side expression, macro type and the System.DayOfWeek type value that is processed by the macro in the filter's right side.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, EntitySchemaQueryExpression leftExpression, EntitySchemaQueryMacrosType macrosType, DayOfWeek rightValue)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
EntitySchemaQueryExpression	leftExpression	Expression in the filter's left side.
EntitySchemaQueryMacrosType	macrosType	Macro type.
System.DayOfWeek	rightValue	Value of the System.DayOfWeek type processed by the macro in the filter's right side.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

Exceptions

Type	Condition
UnsupportedTypeException	If the unsupported macro type is passed as the macrosType parameter.

CreateFilter(FilterComparisonType, EntitySchemaQueryExpression, EntitySchemaQueryMacrosType, Int32)

Gets the filter with the specified comparison type for the specified filter's left side expression, macro type and the value that is processed by the macro in the filter's right side.

Declaration

public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, EntitySchemaQueryExpression leftExpression, EntitySchemaQueryMacrosType macrosType, int rightValue = 0)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
EntitySchemaQueryExpression	leftExpression	Expression in the filter's left side.
EntitySchemaQueryMacrosType	macrosType	Macro type.
System.Int32	rightValue	Value processed by the macro in the filter's right side. Optional parameter, default value is 0.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilterWithParameters(EntitySchema, FilterComparisonType, Boolean, String, Object[])

Gets the filter with the specified parameters for the entity schema query expression.

Declaration

public static IEntitySchemaQueryFilterItem CreateFilterWithParameters(EntitySchema rootSchema, FilterComparisonType comparisonType, bool useDisplayValue, string leftExpressionColumnPath, params object[] rightExpressionParameterValues)

Parameters

Type	Name	Description
EntitySchema	rootSchema	The root schema.
FilterComparisonType	comparisonType	The comparison type in the filter.
System.Boolean	useDisplayValue	Defines the column value type that is used in the filter: true for the displayed value; false for the stored value.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
System.Object[]	rightExpressionParameterValues	Array of values of parameter expressions in the filter's right part.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Filter instance IEntitySchemaQueryFilterItem.

CreateFilterWithParameters(EntitySchemaQuery, EntitySchema, FilterComparisonType, Boolean, String, Object[])

Gets the filter with the specified parameters for the entity schema query expression.

Declaration

public static IEntitySchemaQueryFilterItem CreateFilterWithParameters(EntitySchemaQuery parentQuery, EntitySchema rootSchema, FilterComparisonType comparisonType, bool useDisplayValue, string leftExpressionColumnPath, params object[] rightExpressionParameterValues)

Parameters

Type	Name	Description
EntitySchemaQuery	parentQuery	The parent query for which the filter is being created.
EntitySchema	rootSchema	The root schema.
FilterComparisonType	comparisonType	The comparison type in the filter.
System.Boolean	useDisplayValue	Defines the column value type that is used in the filter: true for the displayed value; false for the stored value.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
System.Object[]	rightExpressionParameterValues	Array of values of parameter expressions in the filter's right part.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Filter instance IEntitySchemaQueryFilterItem.

CreateFilterWithParameters(FilterComparisonType, Boolean, String, Object[])

Gets a parameterized filter with a specified comparison type for the column expression located along the specified path and the passed list of parameter values from the right side of the filter. For a lookup type of column, you can determine the type of its value used in the filter.

Declaration

public IEntitySchemaQueryFilterItem CreateFilterWithParameters(FilterComparisonType comparisonType, bool useDisplayValue, string leftExpressionColumnPath, params object[] rightExpressionParameterValues)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.Boolean	useDisplayValue	For the lookup column, indicates the value type that is used in the filter: true for the displayed value; false for the stored value.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
System.Object[]	rightExpressionParameterValues	List of parameter values from the filter's right side.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilterWithParameters(FilterComparisonType, String, IEnumerable<Object>, Boolean)

Gets a parameterized filter with a specified comparison type for the column expression located along the specified path and the list of parameter values from the passed enumeration. For a lookup type of column, you can determine the type of its value used in the filter.

Declaration

public IEntitySchemaQueryFilterItem CreateFilterWithParameters(FilterComparisonType comparisonType, string leftExpressionColumnPath, IEnumerable<object> rightExpressionParameterValues, bool useDisplayValue = false)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
System.Collections.Generic.IEnumerable<System.Object>	rightExpressionParameterValues	Enumerator of parameter values from the filter's right side.
System.Boolean	useDisplayValue	For the lookup column, indicates the value type that is used in the filter: true for the displayed value; false for the stored value.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateFilterWithParameters(FilterComparisonType, String, Object[])

Gets a parameterized filter with a specified comparison type for the column expression located along the specified path and the passed list of parameter values from the right side of the filter.

Declaration

public IEntitySchemaQueryFilterItem CreateFilterWithParameters(FilterComparisonType comparisonType, string leftExpressionColumnPath, params object[] rightExpressionParameterValues)

Parameters

Type	Name	Description
FilterComparisonType	comparisonType	Comparison type.
System.String	leftExpressionColumnPath	Path to the column that contains the filter's left side expression.
System.Object[]	rightExpressionParameterValues	List of parameter values from the filter's right side.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateHourFunction(String)

Gets an instance of the EntitySchemaDatePartQueryFunction function that returns a part of the [Hour] date for a column value that is located along the specified path relative to the root schema.

Declaration

public EntitySchemaDatePartQueryFunction CreateHourFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaDatePartQueryFunction	The instance of the created EntitySchemaDatePartQueryFunction function.

CreateHourMinuteFunction(String)

Gets an instance of the EntitySchemaDatePartQueryFunction function that returns a part of the [Minute] date for a column value that is located along the specified path relative to the root schema.

Declaration

public EntitySchemaDatePartQueryFunction CreateHourMinuteFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaDatePartQueryFunction	The instance of the created EntitySchemaDatePartQueryFunction function.

CreateIsNotNullFilter(String)

For the current entity schema query, gets the comparison filter of the type [is not null in database] and sets the expression of column in a specified path as the value to test for.

Declaration

public IEntitySchemaQueryFilterItem CreateIsNotNullFilter(string leftExpressionColumnPath)

Parameters

Type	Name	Description
System.String	leftExpressionColumnPath	Path to the column for which the filter is built.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateIsNullFilter(String)

For the current entity schema query, gets the comparison filter of the type [is null in database] and sets the expression of column in a specified path as the validation criteria.

Declaration

public IEntitySchemaQueryFilterItem CreateIsNullFilter(string leftExpressionColumnPath)

Parameters

Type	Name	Description
System.String	leftExpressionColumnPath	Path to the column for whose expression the filter is built.

Returns

Type	Description
IEntitySchemaQueryFilterItem	Instance of the created IEntitySchemaQueryFilterItem filter.

CreateIsNullFunction(String, String)

Returns instance of EntitySchemaIsNullQueryFunction for columns with checked and replacement values, that are located at specified paths relative to the root schema.

Declaration

public EntitySchemaIsNullQueryFunction CreateIsNullFunction(string checkColumnPath, string replacementColumnPath)

Parameters

Type	Name	Description
System.String	checkColumnPath	Path to the column containing the value to be checked.
System.String	replacementColumnPath	Path to the column containing replacement value if checked column value is null.

Returns

Type	Description
EntitySchemaIsNullQueryFunction	Instance of created EntitySchemaIsNullQueryFunction.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If checkColumnPath or replacementColumnPath is null or empty.

CreateIsNullWithParameterFunction(String, Object)

Returns instance of EntitySchemaIsNullQueryFunction for checked column and replacement parameter values.

Declaration

public EntitySchemaIsNullQueryFunction CreateIsNullWithParameterFunction(string checkColumnPath, object replacementParameterValue)

Parameters

Type	Name	Description
System.String	checkColumnPath	Path to the column containing the value to be checked.
System.Object	replacementParameterValue	Parameter containing replacement value if checked column value is null.

Returns

Type	Description
EntitySchemaIsNullQueryFunction	Instance of created EntitySchemaIsNullQueryFunction.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If checkColumnPath is null or empty.
System.ArgumentNullException	If replacementParameterValue is null.

CreateLengthFunction(String)

Returns an instance of the EntitySchemaLengthQueryFunction function for the specified column expression by the specified path relative to the root schema.

Declaration

public EntitySchemaLengthQueryFunction CreateLengthFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaLengthQueryFunction	The instance of the created EntitySchemaLengthQueryFunction function.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If an empty string or null is received as the columnPath parameter.

CreateLengthFunction(EntitySchemaQueryExpression[])

Gets the instance of the EntitySchemaLengthQueryFunction function for the specified array of expressions.

Declaration

public EntitySchemaLengthQueryFunction CreateLengthFunction(params EntitySchemaQueryExpression[] expressions)

Parameters

Type	Name	Description
EntitySchemaQueryExpression[]	expressions	Array of expressions.

Returns

Type	Description
EntitySchemaLengthQueryFunction	The instance of the created EntitySchemaLengthQueryFunction function.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If the null value is passed as the expressions parameter, or if the array of expressions has no items.

CreateMonthFunction(String)

Gets an instance of the EntitySchemaDatePartQueryFunction function that returns a part of the [Month] date for a column value that is located along the specified path relative to the root schema.

Declaration

public EntitySchemaDatePartQueryFunction CreateMonthFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaDatePartQueryFunction	The instance of the created EntitySchemaDatePartQueryFunction function.

CreateNotExistsFilter(String)

For the current entity schema query, gets the comparison filter of the type [exists by the specified condition] and sets the expression of column in a specified path as the value to test for.

Declaration

public EntitySchemaQueryFilter CreateNotExistsFilter(string rightExpressionColumnPath)

Parameters

Type	Name	Description
System.String	rightExpressionColumnPath	Path to the column for whose expression the filter is built.

Returns

Type	Description
EntitySchemaQueryFilter	Instance of the created EntitySchemaQueryFilter filter.

CreateParameterExpression(Object)

Gets the expression of the entity schema query for the parameter with the specified value.

Declaration

public static EntitySchemaQueryExpression CreateParameterExpression(object parameterValue)

Parameters

Type	Name	Description
System.Object	parameterValue	The value of the parameter.

Returns

Type	Description
EntitySchemaQueryExpression	Expression of the entity schema query for the parameter with the specified value.

CreateParameterExpression(Object, String, DataValueType)

Gets the expression of the entity schema query for the parameter with the specified value, value data type and displayed value.

Declaration

public static EntitySchemaQueryExpression CreateParameterExpression(object parameterValue, string displayValue, DataValueType valueType)

Parameters

Type	Name	Description
System.Object	parameterValue	The value of the parameter.
System.String	displayValue	Parameter displayed value.
DataValueType	valueType	The type of the parameter value.

Returns

Type	Description
EntitySchemaQueryExpression	Expression of the entity schema query for the parameter with the parameterValue value of the valueType data type and the displayValue displayed value.

CreateParameterExpression(Object, DataValueType)

Gets the expression of the entity schema query for the parameter with the specified value of a specific type.

Declaration

public static EntitySchemaQueryExpression CreateParameterExpression(object parameterValue, DataValueType valueType)

Parameters

Type	Name	Description
System.Object	parameterValue	The value of the parameter.
DataValueType	valueType	The type of the parameter value.

Returns

Type	Description
EntitySchemaQueryExpression	The expression of the entity schema query for the parameter with the parameterValue value of the valueType data type.

CreateParameterExpressions(DataValueType, IEnumerable<Object>)

Gets an enumerator of query expressions for parameters with passed values of a particular data type.

Declaration

public static IEnumerable<EntitySchemaQueryExpression> CreateParameterExpressions(DataValueType valueType, IEnumerable<object> parameterValues)

Parameters

Type	Name	Description
DataValueType	valueType	The data type of parameter values.
System.Collections.Generic.IEnumerable<System.Object>	parameterValues	Enumerator of the parameter values.

Returns

Type	Description
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression>	Enumerator of query expressions for parameters with the parameterValues values of the valueType data type.

CreateParameterExpressions(DataValueType, Object[])

Gets an enumerator of query expressions for parameters with passed values of a particular data type.

Declaration

public static IEnumerable<EntitySchemaQueryExpression> CreateParameterExpressions(DataValueType valueType, params object[] parameterValues)

Parameters

Type	Name	Description
DataValueType	valueType	The data type of parameter values.
System.Object[]	parameterValues	Array of the parameter values.

Returns

Type	Description
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression>	Enumerator of query expressions for parameters with the parameterValues values of the valueType data type.

CreateSchemaColumnExpression(String, Boolean)

Gets the entity schema column expression by the specified path to column in relation to the root schema.

Declaration

public EntitySchemaQueryExpression CreateSchemaColumnExpression(string columnPath, bool useCoalesceFunctionForMultiLookup = true)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.
System.Boolean	useCoalesceFunctionForMultiLookup	Indicates whether to use the COALESCE function for the column of the multilookup type. Optional parameter. Is equal to true by default.

Returns

Type	Description
EntitySchemaQueryExpression	The created EntitySchemaQueryExpression instance.

CreateSchemaColumnExpression(EntitySchema, String, Boolean)

Gets the expression of the entity schema query for the specified root schema and path to column in relation to the root schema.

Declaration

public static EntitySchemaQueryExpression CreateSchemaColumnExpression(EntitySchema rootSchema, string columnPath, bool useCoalesceFunctionForMultiLookup = true)

Parameters

Type	Name	Description
EntitySchema	rootSchema	The root schema.
System.String	columnPath	Path to column in relation to the root schema.
System.Boolean	useCoalesceFunctionForMultiLookup	Indicates whether to use the COALESCE function for the column of the lookup type. Optional parameter. Is equal to true by default.

Returns

Type	Description
EntitySchemaQueryExpression	The created EntitySchemaQueryExpression instance.

CreateSchemaColumnExpression(EntitySchemaQuery, EntitySchema, String, Boolean, Boolean)

Gets the entity schema column expression for the specified entity schema query, root schema, path to column in relation to the root schema.

Declaration

public static EntitySchemaQueryExpression CreateSchemaColumnExpression(EntitySchemaQuery parentQuery, EntitySchema rootSchema, string columnPath, bool useCoalesceFunctionForMultiLookup = true, bool useDisplayValue = false)

Parameters

Type	Name	Description
EntitySchemaQuery	parentQuery	The entity schema query for which the column expression is created.
EntitySchema	rootSchema	The root schema.
System.String	columnPath	Path to column in relation to the root schema.
System.Boolean	useCoalesceFunctionForMultiLookup	Indicates whether to use the COALESCE function for the column of the lookup type. Optional parameter. Is equal to true by default.
System.Boolean	useDisplayValue	Indicates whether to use the displayed value for the column. Optional parameter. Is equal to false by default.

Returns

Type	Description
EntitySchemaQueryExpression	The created EntitySchemaQueryExpression instance.

CreateSchemaColumnExpressions(IEnumerable<String>, Boolean)

Gets the enumerator of column expressions of the entity schema query by the specified set of paths to columns.

Declaration

public IEnumerable<EntitySchemaQueryExpression> CreateSchemaColumnExpressions(IEnumerable<string> columnPaths, bool useCoalesceFunctionForMultiLookup = true)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	columnPaths	Enumerator of paths to columns in relation to the root schema.
System.Boolean	useCoalesceFunctionForMultiLookup	Indicates whether to use the COALESCE function for the column of the multilookup type. Optional parameter. Is equal to true by default.

Returns

Type	Description
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression>	Enumerator of the EntitySchemaQueryExpression expressions for columns in the columnPaths paths.

CreateSchemaColumnExpressions(String[])

Gets the enumerator of column expressions of the entity schema query by the specified array of paths to columns.

Declaration

public IEnumerable<EntitySchemaQueryExpression> CreateSchemaColumnExpressions(params string[] columnPaths)

Parameters

Type	Name	Description
System.String[]	columnPaths	Array of paths to columns in relation to the root schema.

Returns

Type	Description
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression>	Enumerator of the EntitySchemaQueryExpression entities for columns in the columnPaths paths relative to the root schema.

CreateSchemaColumnExpressionsWithoutCoalesce(String[])

Gets the enumerator of column expressions of the entity schema query by the specified array of paths to columns. If it is a column of the multilookup type, the COALESCE function is not used for its values.

Declaration

public IEnumerable<EntitySchemaQueryExpression> CreateSchemaColumnExpressionsWithoutCoalesce(params string[] columnPaths)

Parameters

Type	Name	Description
System.String[]	columnPaths	Array of paths to columns in relation to the root schema.

Returns

Type	Description
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression>	Enumerator of the EntitySchemaQueryExpression entities for columns in the columnPaths paths.

CreateSchemaColumnQueryExpression(String, EntitySchema, Boolean)

Gets the expression of the entity schema query by the specified path to schema column and the root schema. You can define which column value type to use in the expression – either stored value or displayed value.

Declaration

public static EntitySchemaQueryExpression CreateSchemaColumnQueryExpression(string columnPath, EntitySchema rootSchema, bool useDisplayValue = false)

Parameters

Type	Name	Description
System.String	columnPath	Path to the schema column in relation to the root schema.
EntitySchema	rootSchema	The root schema.
System.Boolean	useDisplayValue	Indicates whether to use the displayed value for the column. Optional parameter. Is equal to false by default.

Returns

Type	Description
EntitySchemaQueryExpression	Expression of the entity schema query. It is built by the path to the columnPath column, rootSchema root schema and based on the useDisplayValue value.

CreateSchemaColumnQueryExpression(String, EntitySchema, EntitySchemaColumn, Boolean)

Gets the expression of the entity schema query by the specified path to column, root schema and schema column instance. You can define which column value type to use in the expression – either stored value or displayed value.

Declaration

public static EntitySchemaQueryExpression CreateSchemaColumnQueryExpression(string columnPath, EntitySchema rootSchema, EntitySchemaColumn schemaColumn, bool useDisplayValue = false)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.
EntitySchema	rootSchema	The instance of the root schema.
EntitySchemaColumn	schemaColumn	The instance of the column for which the expression is built.
System.Boolean	useDisplayValue	Indicates whether to use the displayed value for the column. Optional parameter. Is equal to false by default.

Returns

Type	Description
EntitySchemaQueryExpression	Expression of the entity schema query. It is built by the path to the columnPath column, rootSchema root schema, schemaColumn schema column and based on the useDisplayValue value.

CreateSubEntitySchemaExpression(String)

Gets the expression of entity schema subquery for the column in the specified path.

Declaration

public EntitySchemaQueryExpression CreateSubEntitySchemaExpression(string leftExprColumnPath)

Parameters

Type	Name	Description
System.String	leftExprColumnPath	Path to the column for which the subquery is built.

Returns

Type	Description
EntitySchemaQueryExpression	An instance of a subquery expression for a column along the leftExprColumnPath path.

CreateTrimFunction(String)

Returns an instance of the EntitySchemaTrimQueryFunction function for the specified column expression by the specified path relative to the root schema.

Declaration

public EntitySchemaTrimQueryFunction CreateTrimFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaTrimQueryFunction	The instance of the created EntitySchemaTrimQueryFunction function.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If an empty string or null is received as the columnPath parameter.

CreateTrimFunction(EntitySchemaQueryExpression[])

Gets the instance of the EntitySchemaTrimQueryFunction function for the specified array of expressions.

Declaration

public EntitySchemaTrimQueryFunction CreateTrimFunction(params EntitySchemaQueryExpression[] expressions)

Parameters

Type	Name	Description
EntitySchemaQueryExpression[]	expressions	Array of expressions.

Returns

Type	Description
EntitySchemaTrimQueryFunction	The instance of the created EntitySchemaTrimQueryFunction function.

Exceptions

Type	Condition
ArgumentNullOrEmptyException	If the null value is passed as the expressions parameter, or if the array of expressions has no items.

CreateUpperFunction(String)

Returns an instance of the EntitySchemaUpperQueryFunction function for the specified column expression by the specified path relative to the root schema.

Declaration

public EntitySchemaUpperQueryFunction CreateUpperFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaUpperQueryFunction	The instance of the created EntitySchemaUpperQueryFunction function.

CreateWeekdayFunction(String)

Gets an instance of the EntitySchemaDatePartQueryFunction function that returns a part of the [Week day] date for a column value that is located along the specified path relative to the root schema.

Declaration

public EntitySchemaDatePartQueryFunction CreateWeekdayFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaDatePartQueryFunction	The instance of the created EntitySchemaDatePartQueryFunction function.

CreateWeekFunction(String)

Gets an instance of the EntitySchemaDatePartQueryFunction function that returns a part of the [Week] date for a column value that is located along the specified path relative to the root schema.

Declaration

public EntitySchemaDatePartQueryFunction CreateWeekFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaDatePartQueryFunction	The instance of the created EntitySchemaDatePartQueryFunction function.

CreateWindowFunction(EntitySchemaQueryFunction, String, String)

Create window function instance for specified function, partition by and order by columns.

Declaration

public EntitySchemaWindowQueryFunction CreateWindowFunction(EntitySchemaQueryFunction innerFunction, string partitionByColumn = null, string orderByColumn = null)

Parameters

Type	Name	Description
EntitySchemaQueryFunction	innerFunction	Function to wrap. Using uncompatible function will result in runtime error.
System.String	partitionByColumn	Partition by column path.
System.String	orderByColumn	Order by column path.

Returns

Type	Description
EntitySchemaWindowQueryFunction	Window function instance.

CreateYearFunction(String)

Gets an instance of the EntitySchemaDatePartQueryFunction function that returns a part of the [Year] date for a column value that is located along the specified path relative to the root schema.

Declaration

public EntitySchemaDatePartQueryFunction CreateYearFunction(string columnPath)

Parameters

Type	Name	Description
System.String	columnPath	Path to column in relation to the root schema.

Returns

Type	Description
EntitySchemaDatePartQueryFunction	The instance of the created EntitySchemaDatePartQueryFunction function.

GetDataTable(UserConnection)

Returns the result of the current query execution to the object schema as a data table in memory using the specified user connection.

Declaration

public DataTable GetDataTable(UserConnection userConnection)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.

Returns

Type	Description
System.Data.DataTable	The System.Data.DataTable instance that results from executing the current entity schema query.

GetDayOfWeekNumber(UserConnection, DayOfWeek)

Gets the sequence number of the day of week for the specified System.DayOfWeek entity taking into account the local settings.

Declaration

public static int GetDayOfWeekNumber(UserConnection userConnection, DayOfWeek dayOfWeek)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.DayOfWeek	dayOfWeek	The System.DayOfWeek instance for which the sequence number is determined.

Returns

Type	Description
System.Int32	Sequence number of the day of week for the dayOfWeek entity.

GetEntity(UserConnection, Object)

Gets the Entity instance by the specified primary key, using the specified user connection.

Declaration

public Entity GetEntity(UserConnection userConnection, object primaryColumnValue)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.Object	primaryColumnValue	The value of the primary key.

Returns

Type	Description
Entity	The Entity instance with the primaryColumnValue primary key.

GetEntityCollection(UserConnection)

Returns a collection of Entity, that represents the result of the given query against the given user connection.

Declaration

public EntityCollection GetEntityCollection(UserConnection userConnection)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.

Returns

Type	Description
EntityCollection	Instance of EntityCollection.

GetEntityCollection(UserConnection, EntitySchemaQueryOptions)

Returns a EntityCollection that are the result of executing the current query of specified schema with the specified settings, using the passed user connection.

Declaration

public EntityCollection GetEntityCollection(UserConnection userConnection, EntitySchemaQueryOptions options)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
EntitySchemaQueryOptions	options	Entity schema query options.

Returns

Type	Description
EntityCollection	Instance of EntityCollection.

GetEntityCollectionIterator(UserConnection)

Returns an enumerator over collection Entity, that represents the result of the given query against the given user connection read by chunks.

Declaration

public IEnumerable<EntityCollection> GetEntityCollectionIterator(UserConnection userConnection)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.

Returns

Type	Description
System.Collections.Generic.IEnumerable<EntityCollection>	Instance of System.Collections.Generic.IEnumerable<T>.

GetSchema()

Gets the entity schema instance of the current EntitySchemaQuery instance.

Declaration

public EntitySchema GetSchema()

Returns

Type	Description
EntitySchema	The EntitySchema instance.

GetSelectQuery(UserConnection)

Returns request to fetch data using specified user connection.

Declaration

public Select GetSelectQuery(UserConnection userConnection)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.

Returns

Type	Description
Select	Instance Select current request to object schema.

Exceptions

Type	Condition
InvalidObjectStateException	If resulting sample query does not contain any columns.

GetSelectQuery(UserConnection, Boolean)

Returns request to fetch data using specified user connection.

Declaration

public Select GetSelectQuery(UserConnection userConnection, bool isPrimaryColumnFilterEnabled)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.Boolean	isPrimaryColumnFilterEnabled	Using primary column filter.

Returns

Type	Description
Select	Instance Select current request to object schema.

Exceptions

Type	Condition
InvalidObjectStateException	If resulting sample query does not contain any columns.

GetSelectQuery(UserConnection, EntitySchemaQueryOptions)

Gets the select query that is built based on the specified settings, using the specified user connection.

Declaration

public Select GetSelectQuery(UserConnection userConnection, EntitySchemaQueryOptions options)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
EntitySchemaQueryOptions	options	Settings of the entity schema query.

Returns

Type	Description
Select	The Select instance for the current entity schema query built according to the options options.

GetSummaryColumns()

Gets the collection of expressions of those query columns for which totals are calculated.

Declaration

public EntitySchemaQueryColumnCollection GetSummaryColumns()

Returns

Type	Description
EntitySchemaQueryColumnCollection	Collection of query column expressions for which totals are calculated.

GetSummaryColumns(IEnumerable<String>)

For the specified list of column names, gets the collection of columns for which totals are calculated.

Declaration

public EntitySchemaQueryColumnCollection GetSummaryColumns(IEnumerable<string> columnNames)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	columnNames	Enumerator of the query column names.

Returns

Type	Description
EntitySchemaQueryColumnCollection	Collection of column expressions for which totals are calculated.

Exceptions

Type	Condition
InvalidObjectStateException	If the aggregate function type is not defined for the column with the name from the columnNames enumerator, or if this column is not used for building the resulting SQL query.

GetSummaryEntity(UserConnection)

Gets the Entity instance for the output returned by the select query for totals for all columns of the current query, using the specified user connection.

Declaration

public Entity GetSummaryEntity(UserConnection userConnection)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.

Returns

Type	Description
Entity	The Entity instance for the output returned by the select query for totals of all columns of the current query.

GetSummaryEntity(UserConnection, IEnumerable<String>)

Gets the Entity instance for the output returned by the select query for totals for columns with specified names, using the specified user connection.

Declaration

public Entity GetSummaryEntity(UserConnection userConnection, IEnumerable<string> columnNames)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.Collections.Generic.IEnumerable<System.String>	columnNames	Enumerator of the column names.

Returns

Type	Description
Entity	The Entity instance for the output returned by the select query for totals of columns with the columnNames names.

GetSummaryEntity(UserConnection, String[])

Gets the Entity instance for the output returned by the select query for totals for columns with specified names, using the specified user connection.

Declaration

public Entity GetSummaryEntity(UserConnection userConnection, params string[] columnNames)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.String[]	columnNames	Array of column names.

Returns

Type	Description
Entity	The Entity instance for the output returned by the select query for totals of columns with the columnNames names.

GetSummaryEntity(UserConnection, EntitySchemaQueryColumnCollection)

Gets the Entity instance for the output returned by the select query for totals for the passed-in collection of columns of the current query, using the specified user connection.

Declaration

public Entity GetSummaryEntity(UserConnection userConnection, EntitySchemaQueryColumnCollection summaryColumns)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
EntitySchemaQueryColumnCollection	summaryColumns	Collection of query columns for which totals are selected.

Returns

Type	Description
Entity	The Entity instance for the output returned by the select query for totals of the summaryColumns collection of columns.

GetSummarySelectQuery(UserConnection)

Gets the select query for the totals (aggregate values) for all columns of the current EntitySchemaQuery instance, using the specified user connection.

Declaration

public Select GetSummarySelectQuery(UserConnection userConnection)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.

Returns

Type	Description
Select	The Select instance of the select query.

GetSummarySelectQuery(UserConnection, IEnumerable<String>)

Gets the select query for the totals (aggregate values) for columns of the current EntitySchemaQuery instance with the specified names, using the specified user connection.

Declaration

public Select GetSummarySelectQuery(UserConnection userConnection, IEnumerable<string> columnNames)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.Collections.Generic.IEnumerable<System.String>	columnNames	Enumerator of names of columns for which the select query for totals is built.

Returns

Type	Description
Select	The Select instance of the select query.

GetSummarySelectQuery(UserConnection, String[])

Gets the select query for the totals (aggregate values) for columns of the current EntitySchemaQuery instance with the specified names, using the specified user connection.

Declaration

public Select GetSummarySelectQuery(UserConnection userConnection, params string[] columnNames)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.String[]	columnNames	Array of names of columns for which the select query for totals is built.

Returns

Type	Description
Select	The Select instance of the select query.

GetSummarySelectQuery(UserConnection, EntitySchemaQueryColumnCollection)

Gets the select query for the totals (aggregate values) for the specified collection of columns of the current EntitySchemaQuery instance, using the specified user connection.

Declaration

public Select GetSummarySelectQuery(UserConnection userConnection, EntitySchemaQueryColumnCollection summaryColumns)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
EntitySchemaQueryColumnCollection	summaryColumns	Collection of columns for which the select query for totals is built.

Returns

Type	Description
Select	The Select instance of the select query.

Exceptions

Type	Condition
SelectFromVirtualSchemaException	When trying to build the select query to the virtual schema.
ArgumentNullOrEmptyException	If the null value is passed as the summaryColumns parameter, or if the collection of columns has no items.

GetTypedColumnValue<T>(Entity, String)

Gets the typed value of the column with the specified name from the passed-in Entity instance.

Declaration

public T GetTypedColumnValue<T>(Entity entity, string columnName)

Parameters

Type	Name	Description
Entity	entity	The Entity instance that contains the column.
System.String	columnName	The name of the column.

Returns

Type	Description
T	The typed value of the column with the columnName name that belongs to entity.

Type Parameters

Name	Description
T	Any type.

Exceptions

Type	Condition
System.ArgumentNullException	If null is passed as the entity parameter. Alternatively, if the empty value or null value is passed as the columnName parameter.

LoadDataTableData(UserConnection, DataTable)

Loads the result of the current query execution to the object schema in the System.Data.DataTable passed object using the specified user connection.

Declaration

public void LoadDataTableData(UserConnection userConnection, DataTable dataTable)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.Data.DataTable	dataTable	The System.Data.DataTable instance in which the output of the query execution is loaded.

LoadDataTableData(UserConnection, DataTable, EntitySchemaQueryOptions)

Loads the result of the current query execution to the object schema in the System.Data.DataTable passed object, taking into account the specified settings, using the specified user connection.

Declaration

public void LoadDataTableData(UserConnection userConnection, DataTable dataTable, EntitySchemaQueryOptions options)

Parameters

Type	Name	Description
UserConnection	userConnection	User connection.
System.Data.DataTable	dataTable	The System.Data.DataTable instance in which the output of the query execution is loaded.
EntitySchemaQueryOptions	options	Settings of the entity schema query.

RemoveColumn(String)

Removes the column with the specified name from the collection of columns of the current query.

Declaration

public void RemoveColumn(string columnName)

Parameters

Type	Name	Description
System.String	columnName	Name of the column being removed.

ResetSchema()

Clears the schema of the current EntitySchemaQuery instance.

Declaration

public void ResetSchema()

ResetSelectQuery()

Clears the select query for the current entity schema query.

Declaration

public void ResetSelectQuery()

SetLocalizationCultureId(Guid)

Sets the localization culture Id.

Declaration

public void SetLocalizationCultureId(Guid cultureId)

Parameters

Type	Name	Description
System.Guid	cultureId	The culture Id.

Events

Loading

Event that occurs when loading data.

Declaration

public event EntitySchemaQueryLoadingEventHandler Loading

Event Type

Type	Description
EntitySchemaQueryLoadingEventHandler

Implements

IManagerItemInstance

System.ICloneable

Extension Methods

ReflectionUtilities.GetPropertyValue(Object, String)

ReflectionUtilities.GetPropertyDefValue(Object, String, Object)

ReflectionUtilities.TryGetPropertyValue(Object, String, out Object)

ReflectionUtilities.HasProperty(Object, String)

ReflectionUtilities.GetPropertyValue(Object, String, BindingFlags)

ReflectionUtilities.GetPropertyValueByPath(Object, String)

ReflectionUtilities.SetPropertyValue(Object, String, Object)

ReflectionUtilities.TrySetPropertyValue(Object, String, Object)

ValidateUtilities.CheckArgumentNull(Object, String)

ValidateUtilities.CheckDependencyNull(Object, String)

ValidateUtilities.EnsureDependencyNotNull<T>(T, String)

QueryExtension.ApplyPagebleOptions(EntitySchemaQuery, SelectQuery)

MetaDataTestUtils.MetaPropertiesShouldNotHaveDefValue<TInstance>(TInstance)

MetaDataTestUtils.MetaPropertiesShouldNotHaveDefValue<TInstance>(TInstance, Boolean)

NSubstituteExtension.Protected(Object, String, Object[])

NSubstituteExtension.Protected(Object, String, Boolean, Object[])

NSubstituteExtension.ProtectedGeneric<T>(Object, String, Object[])

NSubstituteExtension.ProtectedGeneric<T>(Object, String, Boolean, Object[])

NSubstituteExtension.ProtectedProperty(Object, String)

NSubstituteExtension.MatchInstance<T>(T)

SubstituteUtilities.GetIsSubstituteObject(Object)

SubstituteUtilities.Instead<TInstance, TValue>(TInstance, Func<TInstance, TValue>)