Class EntitySchemaQuery
Представляет запрос к схеме объекта. Это высокоуровневый класс, позволяющий собирать сложные запросы, используя только понятия путей к колонкам объекта таблицы (схемы) относительно корневой таблицы.
Inheritance
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
[MetaType("{DBE36562-96FA-4d4f-B171-8C18EAAEA20D}")]
public class EntitySchemaQuery : IManagerItemInstance, ICloneable
Constructors
EntitySchemaQuery()
Инициализирует экземпляр EntitySchemaQuery.
Declaration
public EntitySchemaQuery()
Remarks
Используется исключительно для внутренних целей и не применим в конфигурации.
EntitySchemaQuery(EntitySchema)
Инициализирует экземпляр EntitySchemaQuery с заданной корневой схемой.
Declaration
public EntitySchemaQuery(EntitySchema rootSchema)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | rootSchema | Корневая схема. |
Remarks
В качестве корневой схемы устанавливается переданный экземпляр rootSchema
. В
качестве менеджера схем устанавливается менеджер переданного экземпляра корневой схемы.
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)
Инициализирует экземпляр EntitySchemaQuery с заданными менеджером схем и именем корневой схемы.
Declaration
public EntitySchemaQuery(EntitySchemaManager entitySchemaManager, string sourceSchemaName)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaManager | entitySchemaManager | Экземпляр менеджера схем. |
System.String | sourceSchemaName | Имя корневой схемы. |
Remarks
В менеджере схем entitySchemaManager
осуществляется поиск схемы с именем
sourceSchemaName
и в качестве корневой схемы принимается экземпляр найденной схемы.
EntitySchemaQuery(EntitySchemaQuery)
Инициализирует экземпляр EntitySchemaQuery, являющийся клоном переданного запроса к схеме объекта.
Declaration
public EntitySchemaQuery(EntitySchemaQuery source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQuery | source | Экземпляр EntitySchemaQuery, клон которого создается. |
Properties
AdminUnitRoleSources
Bit mask that indicates which role sources will be considered when checking record rights.
Declaration
public AdminUnitRoleSources AdminUnitRoleSources { get; set; }
Property Value
Type | Description |
---|---|
AdminUnitRoleSources |
Cache
Кэш запроса.
Declaration
public ICacheStore Cache { get; set; }
Property Value
Type | Description |
---|---|
ICacheStore |
CacheItemName
Имя элемента кэша.
Declaration
public string CacheItemName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CanReadUncommitedData
Признак, определяющий, будут ли попадать в результаты запроса данные, для которых не завершена транзакция.
Declaration
public bool CanReadUncommitedData { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Если свойство равно true
, то в результаты запроса попадают данные, для которых не завершена
транзакция; если false
- в запрос попадают только данные, для которых завершена транзакция.
Значение по умолчанию: true
.
Caption
Заголовок.
Declaration
public LocalizableString Caption { get; set; }
Property Value
Type | Description |
---|---|
LocalizableString |
Remarks
По умолчанию инициализируется заголовком схемы запроса.
ChunkSize
Rows to read from DB in single chunk.
Declaration
public int ChunkSize { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Columns
Коллекция колонок текущего запроса к схеме объекта.
Declaration
public EntitySchemaQueryColumnCollection Columns { get; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryColumnCollection |
Remarks
Значение по умолчанию: содержит колонку из свойства PrimaryQueryColumn.
DataValueTypeManager
Менеджер значений типов данных.
Declaration
public DataValueTypeManager DataValueTypeManager { get; }
Property Value
Type | Description |
---|---|
DataValueTypeManager |
EntitySchemaManager
Менеджер схем объектов.
Declaration
public EntitySchemaManager EntitySchemaManager { get; }
Property Value
Type | Description |
---|---|
EntitySchemaManager |
Filters
Коллекция фильтров текущего запроса к схеме объекта.
Declaration
public EntitySchemaQueryFilterCollection Filters { get; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryFilterCollection |
HideSecurityValue
Параметр, определяющий, будут ли скрываться значения зашифрованных колонок.
Declaration
public bool HideSecurityValue { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Значение по умолчанию: false
.
Если установить параметр в true
, то значение зашифрованных колонок будет равно null
.
IgnoreDisplayValues
Признак, определяющий, что в запросе не будут использоваться отображаемые значения колонок.
Declaration
public bool IgnoreDisplayValues { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Если свойство равно true
, то в запросе возвращаются отображаемые значения колонок; если
свойство равно false
, то запрос возвращает хранимые значения колонок.
IsDistinct
Признак, определяющий, убирать ли дубли в результирующем наборе данных.
Declaration
public bool IsDistinct { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Значение по умолчанию: false
.
IsInherited
Признак, является ли запрос унаследованным.
Declaration
public bool IsInherited { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
JoinRightState
Параметр, определяющий условие наложения прав при использовании связанных таблиц, если схема администрируется по записям.
Declaration
public QueryJoinRightLevel JoinRightState { get; set; }
Property Value
Type | Description |
---|---|
QueryJoinRightLevel |
Remarks
Значение по умолчанию: вычитывается из системной настройки QueryJoinRightLevel. Если настройка не задана, то значение равно EnabledForAdditionalColumns.
Manager
Менеджер схем.
Declaration
public IManager Manager { get; }
Property Value
Type | Description |
---|---|
IManager |
ManagerItem
Элемент менеджера.
Declaration
public IManagerItem ManagerItem { get; set; }
Property Value
Type | Description |
---|---|
IManagerItem |
Name
Имя.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | При попытке изменения имени базового представления. |
System.ArgumentException | Если свойству присваивается значение, не являющееся действительным идентификатором, или пустая строка. |
ParentCollection
Коллекция запросов, которой принадлежит текущий запрос к схеме объекта.
Declaration
public EntitySchemaQueryCollection ParentCollection { get; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryCollection |
ParentEntitySchema
Родительская схема запроса.
Declaration
public EntitySchema ParentEntitySchema { get; }
Property Value
Type | Description |
---|---|
EntitySchema |
PrimaryQueryColumn
Колонка, созданная по первичной колонке корневой схемы. Заполняется при первом обращении.
Declaration
public EntitySchemaQueryColumn PrimaryQueryColumn { get; }
Property Value
Type | Description |
---|---|
EntitySchemaQueryColumn |
Remarks
Значение по умолчанию: экземпляр, созданный по первичной колонке корневой схемы.
QueryOptimize
Allows using query optimization.
Declaration
public bool QueryOptimize { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
RootSchema
Корневая схема.
Declaration
public EntitySchema RootSchema { get; }
Property Value
Type | Description |
---|---|
EntitySchema |
Remarks
Все пути к колонкам схем задаются относительно этой корневой схемы.
Свойство инициализируется в конструкторе. Значение по умолчанию: null
.
RootSchemaAlias
Gets or sets alias for the root schema.
Declaration
public string RootSchemaAlias { get; }
Property Value
Type | Description |
---|---|
System.String |
RowCount
Количество строк, возвращаемых запросом.
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
Количество строк, которые необходимо пропустить в результирующем наборе данных.
Declaration
public int SkipRowCount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
UseAdminRights
Параметр, определяющий, будут ли учитываться права при построении запроса получения данных.
Declaration
public bool UseAdminRights { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Значение по умолчанию: true
UseLocalization
Параметр, определяющий, будут ли использоваться локализуемые данные.
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)
В коллекцию колонок текущего запроса к схеме объекта добавляет все колонки корневой схемы.
Declaration
public void AddAllSchemaColumns(bool skipSystemColumns = false)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | skipSystemColumns |
AddColumn(Object, DataValueType)
Создает и добавляет в текущий запрос к схеме объекта колонку типа параметр с заданным значением определенного типа.
Declaration
public EntitySchemaQueryColumn AddColumn(object parameterValue, DataValueType parameterDataValueType)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parameterValue | Значение параметра. |
DataValueType | parameterDataValueType | Тип значения параметра. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | Экземпляр созданной колонки EntitySchemaQueryColumn. |
AddColumn(String)
Создает и добавляет колонку в текущий запрос к схеме объекта по заданному пути к колонке относительно корневой схемы.
Declaration
public EntitySchemaQueryColumn AddColumn(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке схемы относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | Экземпляр созданной колонки. |
AddColumn(String, AggregationTypeStrict, out EntitySchemaQuery)
Создает и добавляет колонку в текущий запрос к схеме объекта в виде подзапроса, возвращающего результат указанной агрегирующей функции, по пути к колонке схемы относительно корневой схемы.
Declaration
public EntitySchemaQueryColumn AddColumn(string columnPath, AggregationTypeStrict aggregationType, out EntitySchemaQuery subQuery)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке схемы относительно корневой схемы. |
AggregationTypeStrict | aggregationType | Тип агрегирующей функции. В качестве параметра передаются значения
перечисления типов агрегирующей функции |
EntitySchemaQuery | subQuery | Ссылка на созданный подзапрос, помещенный в колонку. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | Экземпляр созданной колонки EntitySchemaQueryColumn. |
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)
Добавляет переданную колонку в коллекцию колонок текущего запроса к схеме объекта.
Declaration
public void AddColumn(EntitySchemaQueryColumn queryColumn)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryColumn | queryColumn | Экземпляр EntitySchemaQueryColumn, добавляемый в коллекцию колонок текущего запроса. |
AddColumn(EntitySchemaQueryFunction)
Создает и добавляет колонку в текущий запрос к схеме объекта по переданной функции.
Declaration
public EntitySchemaQueryColumn AddColumn(EntitySchemaQueryFunction function)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryFunction | function | Экземпляр функции EntitySchemaQueryFunction. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumn | Экземпляр созданной колонки EntitySchemaQueryColumn. |
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()
Создает клон текущего экземпляра EntitySchemaQuery.
Declaration
public object Clone()
Returns
Type | Description |
---|---|
System.Object | Экземпляр System.Object, являющийся клоном текущего запроса к схеме объекта. |
CreateAggregationEntitySchemaExpression(String, AggregationTypeStrict)
Возвращает выражение агрегирующей функции указанного типа для выражения колонки, расположенной по заданному пути.
Declaration
public EntitySchemaQueryExpression CreateAggregationEntitySchemaExpression(string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType)
Parameters
Type | Name | Description |
---|---|---|
System.String | leftExprColumnPath | Путь к колонке, для выражения которой строится агрегирующая функция. |
AggregationTypeStrict | leftExprAggregationType | Тип агрегирующей функции. |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Экземпляр выражения созданной агрегирующей функции. |
CreateAggregationFunction(AggregationTypeStrict, String)
Возвращает экземпляр агрегирующей функции EntitySchemaAggregationQueryFunction с заданным типом для колонки по укзанному пути относительно корневой схемы.
Declaration
public EntitySchemaAggregationQueryFunction CreateAggregationFunction(AggregationTypeStrict aggregationType, string columnPath)
Parameters
Type | Name | Description |
---|---|---|
AggregationTypeStrict | aggregationType | Тип агрегирующей функции. |
System.String | columnPath | Путь к колонке схемы относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaAggregationQueryFunction | Экземпляр созданной агрегирующей функции EntitySchemaAggregationQueryFunction. |
CreateCaseNotNullFunction(EntitySchemaCaseNotNullQueryFunctionWhenItem[])
Возвращает экземпляр функции EntitySchemaCaseNotNullQueryFunction для заданного массива выражений условий.
Declaration
public EntitySchemaCaseNotNullQueryFunction CreateCaseNotNullFunction(params EntitySchemaCaseNotNullQueryFunctionWhenItem[] whenItems)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaCaseNotNullQueryFunctionWhenItem[] | whenItems | Массив выражений условий создаваемой функции. |
Returns
Type | Description |
---|---|
EntitySchemaCaseNotNullQueryFunction | Экземпляр созданной функции EntitySchemaCaseNotNullQueryFunction. |
CreateCaseNotNullQueryFunctionWhenItem(String, Object)
Возвращает экземпляр выражения для sql-конструкции
вида WHEN <Выражение_1> IS NOT NULL THEN <Выражение_2>
.
Declaration
public EntitySchemaCaseNotNullQueryFunctionWhenItem CreateCaseNotNullQueryFunctionWhenItem(string whenColumnPath, object thenParameterValue)
Parameters
Type | Name | Description |
---|---|---|
System.String | whenColumnPath | Путь к колонке, содержащей выражение предложения |
System.Object | thenParameterValue | Путь к колонке, содержащей выражение предложения |
Returns
Type | Description |
---|---|
EntitySchemaCaseNotNullQueryFunctionWhenItem | Экземпляр созданного выражения условия EntitySchemaCaseNotNullQueryFunctionWhenItem. |
CreateCastFunction(String, DBDataValueType)
Возвращает экземпляр функции EntitySchemaCastQueryFunction для выражения колонки, расположенной по заданному пути относительно корневой схемы, и указанным целевым типом данных.
Declaration
public EntitySchemaCastQueryFunction CreateCastFunction(string columnPath, DBDataValueType castType)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
DBDataValueType | castType | Целевой тип данных. |
Returns
Type | Description |
---|---|
EntitySchemaCastQueryFunction | Экземпляр созданной функции EntitySchemaCastQueryFunction. |
CreateCoalesceFunction(String[])
Возвращает экземпляр функции EntitySchemaCoalesceQueryFunction для заданного массива путей к колонкам относительно корневой схемы.
Declaration
public EntitySchemaCoalesceQueryFunction CreateCoalesceFunction(params string[] columnPaths)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | columnPaths | Массив путей к колонкам относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaCoalesceQueryFunction | Экземпляр созданной функции EntitySchemaCoalesceQueryFunction. |
CreateCoalesceFunction(EntitySchema, String[])
Возвращает экземпляр функции EntitySchemaCoalesceQueryFunction для заданных корневой схемы и массива путей к колонкам.
Declaration
public static EntitySchemaCoalesceQueryFunction CreateCoalesceFunction(EntitySchema rootSchema, params string[] columnPaths)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | rootSchema | Корневая схема. |
System.String[] | columnPaths | Массив путей к колонкам относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaCoalesceQueryFunction | Созданный экземпляр EntitySchemaCoalesceQueryFunction. |
CreateCoalesceFunction(EntitySchemaQuery, EntitySchema, String[])
Возвращает экземпляр функции EntitySchemaCoalesceQueryFunction для заданных родительского запроса, корневой схемы и массива путей к колонкам.
Declaration
public static EntitySchemaCoalesceQueryFunction CreateCoalesceFunction(EntitySchemaQuery parentQuery, EntitySchema rootSchema, params string[] columnPaths)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQuery | parentQuery | Запрос к схеме объекта, для которого создается экземпляр функции. |
EntitySchema | rootSchema | Корневая схема. |
System.String[] | columnPaths | Массив путей к колонкам относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaCoalesceQueryFunction | Созданный экземпляр EntitySchemaCoalesceQueryFunction. |
CreateConcatFunction(EntitySchemaQueryExpression[])
Возвращает экземпляр функции EntitySchemaConcatQueryFunction для заданного массива выражений.
Declaration
public EntitySchemaConcatQueryFunction CreateConcatFunction(params EntitySchemaQueryExpression[] expressions)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpression[] | expressions | Массив выражений. |
Returns
Type | Description |
---|---|
EntitySchemaConcatQueryFunction | Экземпляр созданной функции EntitySchemaConcatQueryFunction. |
CreateCurrentDateFunction()
Возвращает экземпляр функции EntitySchemaCurrentDateQueryFunction возвращающей текущую дату.
Declaration
public EntitySchemaCurrentDateQueryFunction CreateCurrentDateFunction()
Returns
Type | Description |
---|---|
EntitySchemaCurrentDateQueryFunction | Экземпляр созданной функции EntitySchemaCurrentDateQueryFunction. |
CreateCurrentDateTimeFunction()
Возвращает экземпляр функции EntitySchemaCurrentDateTimeQueryFunction, возвращающей текущие дату и время.
Declaration
public EntitySchemaCurrentDateTimeQueryFunction CreateCurrentDateTimeFunction()
Returns
Type | Description |
---|---|
EntitySchemaCurrentDateTimeQueryFunction | Экземпляр созданной функции EntitySchemaCurrentDateTimeQueryFunction. |
CreateCurrentTimeFunction()
Возвращает экземпляр функции EntitySchemaCurrentTimeQueryFunction, определяющей текущее время.
Declaration
public EntitySchemaCurrentTimeQueryFunction CreateCurrentTimeFunction()
Returns
Type | Description |
---|---|
EntitySchemaCurrentTimeQueryFunction | Экземпляр созданной функции EntitySchemaCurrentTimeQueryFunction. |
CreateCurrentUserAccountFunction()
Возвращает экземпляр функции EntitySchemaCurrentUserAccountQueryFunction, определяющей идентификатор контрагента текущего пользователя.
Declaration
public EntitySchemaCurrentUserAccountQueryFunction CreateCurrentUserAccountFunction()
Returns
Type | Description |
---|---|
EntitySchemaCurrentUserAccountQueryFunction | Экземпляр созданной функции EntitySchemaCurrentUserAccountQueryFunction. |
CreateCurrentUserContactFunction()
Возвращает экземпляр функции EntitySchemaCurrentUserContactQueryFunction, определяющей идентификатор контакта текущего пользователя.
Declaration
public EntitySchemaCurrentUserContactQueryFunction CreateCurrentUserContactFunction()
Returns
Type | Description |
---|---|
EntitySchemaCurrentUserContactQueryFunction | Экземпляр созданной функции EntitySchemaCurrentUserContactQueryFunction. |
CreateCurrentUserFunction()
Возвращает экземпляр функции EntitySchemaCurrentUserQueryFunction, определяющей текущего пользователя.
Declaration
public EntitySchemaCurrentUserQueryFunction CreateCurrentUserFunction()
Returns
Type | Description |
---|---|
EntitySchemaCurrentUserQueryFunction | Экземпляр созданной функции EntitySchemaCurrentUserQueryFunction. |
CreateDatePartFunction(EntitySchemaDatePartQueryFunctionInterval, String)
Возвращает экземпляр функции EntitySchemaDatePartQueryFunction, возвращающей заданный интервал даты для значения колонки, расположенной по указанному пути относительно корневой схемы.
Declaration
public EntitySchemaDatePartQueryFunction CreateDatePartFunction(EntitySchemaDatePartQueryFunctionInterval interval, string columnPath)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaDatePartQueryFunctionInterval | interval | Часть даты, возвращаемая функцией. |
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaDatePartQueryFunction | Экземпляр созданной функции EntitySchemaDatePartQueryFunction. |
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)
Возвращает экземпляр функции EntitySchemaDatePartQueryFunction, возвращающей интервал даты [День] для значения колонки, расположенной по указанному пути относительно корневой схемы.
Declaration
public EntitySchemaDatePartQueryFunction CreateDayFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaDatePartQueryFunction | Экземпляр созданной функции EntitySchemaDatePartQueryFunction. |
CreateExistsFilter(String)
Для текущего запроса к схеме объекта возвращает фильтр сравнения типа [Существует по заданному условию] и устанавливает в качестве проверяемого значения выражение колонки, расположенной по заданному пути.
Declaration
public EntitySchemaQueryFilter CreateExistsFilter(string rightExpressionColumnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | rightExpressionColumnPath | Путь к колонке, для выражения которой строится фильтр. |
Returns
Type | Description |
---|---|
EntitySchemaQueryFilter | Экземпляр созданного фильтра EntitySchemaQueryFilter. |
CreateFilter(FilterComparisonType, String, AggregationTypeStrict, DateTime)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, заданного типа аргегирующей функции и переданного значения параметра типа System.DateTime, к которому применяется агрегирующая функция в правой части фильтра.
Declaration
public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, DateTime rightExprParameterValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExprColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
AggregationTypeStrict | leftExprAggregationType | Тип агрегирующей функции. |
System.DateTime | rightExprParameterValue | Значение параметра, к которому применяется агрегирующая функция в правой части фильтра. |
Returns
Type | Description |
---|---|
EntitySchemaQueryFilter | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, AggregationTypeStrict, Double)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, заданного типа агрегирующей функции и переданного значения параметра типа System.Double, к которому применяется агрегирующая функция в правой части фильтра.
Declaration
public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, double rightExprParameterValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExprColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
AggregationTypeStrict | leftExprAggregationType | Тип агрегирующей функции. |
System.Double | rightExprParameterValue | Значение параметра, к которому применяется агрегирующая функция в правой части фильтра. |
Returns
Type | Description |
---|---|
EntitySchemaQueryFilter | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, AggregationTypeStrict, Int32)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, заданного типа агрегирующей функции и переданного значения параметра типа System.Int32, к которому применяется агрегируюшая функция в правой части фильтра.
Declaration
public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, int rightExprParameterValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExprColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
AggregationTypeStrict | leftExprAggregationType | Тип агрегирующей функции. |
System.Int32 | rightExprParameterValue | Значение параметра, к которому применяется агрегирующая функция в правой части фильтра. |
Returns
Type | Description |
---|---|
EntitySchemaQueryFilter | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, AggregationTypeStrict, Object, out EntitySchemaQuery)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути,
заданного типа агрегирующей функции и переданного значения параметра, к которому применяется агрегирующая
функция в правой части фильтра. При этом в исходящем параметре возвращается подзапрос для выражения из
левой части фильтра либо подзапрос для первого выражения из правой части фильтра, если левое выражение
фильтра равно null
.
Declaration
public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, object rightExprParameterValue, out EntitySchemaQuery leftExprSubQuery)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExprColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
AggregationTypeStrict | leftExprAggregationType | Тип агрегирующей функции. |
System.Object | rightExprParameterValue | Значение параметра, к которому применяется агрегирующая функция в правой части фильтра. |
EntitySchemaQuery | leftExprSubQuery | Параметр, в котором возвращается подзапрос для выражения в левой части
фильтра (если он не равен |
Returns
Type | Description |
---|---|
EntitySchemaQueryFilter | Экземпляр созданого фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, AggregationTypeStrict, String)
Возвращает фильтр с заданным типом сравнения для колонки, расположенной по указанному пути, заданного типа агрегирующей функции и переданного значения параметра типа System.String, к которому применяется агрегирующая функция в правой части фильтра.
Declaration
public EntitySchemaQueryFilter CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, string rightExprParameterValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExprColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
AggregationTypeStrict | leftExprAggregationType | Тип агрегирующей функции. |
System.String | rightExprParameterValue | Значение параметра, к которому применяется агрегирующая функция в правой части фильтра. |
Returns
Type | Description |
---|---|
EntitySchemaQueryFilter | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, AggregationTypeStrict, EntitySchemaQueryMacrosType, Int32)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, заданного типа агрегирующей функции, заданного типа макроса и значения, к которому применяется макрос в правой части фильтра.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, EntitySchemaQueryMacrosType macrosType, int daysCount = 0)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExprColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
AggregationTypeStrict | leftExprAggregationType | Тип агрегирующей функции. |
EntitySchemaQueryMacrosType | macrosType | Тип макроса. |
System.Int32 | daysCount | Значение, к которому применяется макрос в правой части фильтра. Необязательный
параметр, по умолчанию равен |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, AggregationTypeStrict, EntitySchemaQueryMacrosType, out EntitySchemaQuery, Int32)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, заданного типа агрегирующей функции, заданного типа макроса и значения, к которому применяется макрос в правой части фильтра. При этом в исходящем параметре возвращается подзапрос для выражения из левой части фильтра.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExprColumnPath, AggregationTypeStrict leftExprAggregationType, EntitySchemaQueryMacrosType macrosType, out EntitySchemaQuery leftExprSubQuery, int daysCount = 0)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExprColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
AggregationTypeStrict | leftExprAggregationType | Тип агрегирующей функции. |
EntitySchemaQueryMacrosType | macrosType | Тип макроса. |
EntitySchemaQuery | leftExprSubQuery | Параметр, в котором возвращается подзапрос для выражения в левой части фильтра. |
System.Int32 | daysCount | Значение, которое обрабатывается макросом в правой части фильтра. Необязательный
параметр, по умолчанию равен |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, String[])
Возвращает фильтр с заданным типом сравнения для выражений двух колонок, расположенных по указанным путям относительно корневой схемы.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, params string[] rightExpressionColumnPaths)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
System.String[] | rightExpressionColumnPaths | Массив путей к колонкам, содержащих выражения правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, EntitySchemaQuery)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по заданному пути, и переданного подзапроса.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQuery rightExpressionValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
EntitySchemaQuery | rightExpressionValue | Выражение подзапроса в правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, EntitySchemaQueryExpression)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути относительно корневой схемы, и переданного выражения.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryExpression rightExpression)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
EntitySchemaQueryExpression | rightExpression | Выражение в правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, EntitySchemaQueryFunction)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути относительно корневой схемы, и переданного экземпляра функции.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryFunction rightExpressionValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
EntitySchemaQueryFunction | rightExpressionValue | Экземпляр функции выражения в правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, EntitySchemaQueryMacrosType, DateTime)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по заданному пути, типа макроса и значения типа System.DateTime, которое обрабатывается макросом в правой части фильтра.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryMacrosType macrosType, DateTime rightValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
EntitySchemaQueryMacrosType | macrosType | Тип макроса. |
System.DateTime | rightValue | Значение типа System.DateTime, которое обрабатывается макросом в правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, EntitySchemaQueryMacrosType, DayOfWeek)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, типа макроса и значения типа System.DayOfWeek, которое обрабатывается макросом в правой части фильтра.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryMacrosType macrosType, DayOfWeek rightValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
EntitySchemaQueryMacrosType | macrosType | Тип макроса. |
System.DayOfWeek | rightValue | Значение типа System.DayOfWeek, которое обрабатывается макросом в правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, String, EntitySchemaQueryMacrosType, Int32)
Возвращает фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, заданных типа макроса и числового значения, которое обрабатывается макросом в правой части фильтра.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, string leftExpressionColumnPath, EntitySchemaQueryMacrosType macrosType, int rightValue = 0)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
EntitySchemaQueryMacrosType | macrosType | Тип макроса. |
System.Int32 | rightValue | Значение, которое обрабатывается макросом в правой части фильтра. Используется для
типов макроса |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
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. |
CreateFilter(FilterComparisonType, EntitySchemaQueryExpression, EntitySchemaQueryMacrosType, DayOfWeek)
Возвращает фильтр с заданным типом сравнения для заданных выражения левой части фильтра, типа макроса и значения типа System.DayOfWeek, которое обрабатывается макросом в правой части фильтра.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, EntitySchemaQueryExpression leftExpression, EntitySchemaQueryMacrosType macrosType, DayOfWeek rightValue)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
EntitySchemaQueryExpression | leftExpression | Выражение в левой части фильтра. |
EntitySchemaQueryMacrosType | macrosType | Тип макроса. |
System.DayOfWeek | rightValue | Значение типа System.DayOfWeek, которое обрабатывается макросом в правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilter(FilterComparisonType, EntitySchemaQueryExpression, EntitySchemaQueryMacrosType, Int32)
Возвращает фильтр с заданным типом сравнения для заданных выражения левой части фильтра, типа макроса и значения, которое обрабатывается макросом в правой части фильтра.
Declaration
public IEntitySchemaQueryFilterItem CreateFilter(FilterComparisonType comparisonType, EntitySchemaQueryExpression leftExpression, EntitySchemaQueryMacrosType macrosType, int rightValue = 0)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
EntitySchemaQueryExpression | leftExpression | Выражение в левой части фильтра. |
EntitySchemaQueryMacrosType | macrosType | Тип макроса. |
System.Int32 | rightValue | Значение, которое обрабатывается макросом в правой части фильтра. Необязательный
параметр, по умолчанию равен |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilterWithParameters(EntitySchema, FilterComparisonType, Boolean, String, Object[])
Возвращает фильтр с заданными параметрами для выражения запроса к схеме объекта.
Declaration
public static IEntitySchemaQueryFilterItem CreateFilterWithParameters(EntitySchema rootSchema, FilterComparisonType comparisonType, bool useDisplayValue, string leftExpressionColumnPath, params object[] rightExpressionParameterValues)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | rootSchema | Корневая схема. |
FilterComparisonType | comparisonType | Тип операции сравнения в фильтре. |
System.Boolean | useDisplayValue | Признак типа значения колонки, которое используется в фильтре: |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
System.Object[] | rightExpressionParameterValues | Массив значений выражений параметров в правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр фильтра IEntitySchemaQueryFilterItem. |
CreateFilterWithParameters(EntitySchemaQuery, EntitySchema, FilterComparisonType, Boolean, String, Object[])
Возвращает фильтр с заданными параметрами для выражения запроса к схеме объекта.
Declaration
public static IEntitySchemaQueryFilterItem CreateFilterWithParameters(EntitySchemaQuery parentQuery, EntitySchema rootSchema, FilterComparisonType comparisonType, bool useDisplayValue, string leftExpressionColumnPath, params object[] rightExpressionParameterValues)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQuery | parentQuery | Родительский запрос, для которого создается фильтр. |
EntitySchema | rootSchema | Корневая схема. |
FilterComparisonType | comparisonType | Тип операции сравнения в фильтре. |
System.Boolean | useDisplayValue | Признак типа значения колонки, которое используется в фильтре:
|
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
System.Object[] | rightExpressionParameterValues | Массив значений выражений параметров в правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр фильтра IEntitySchemaQueryFilterItem. |
CreateFilterWithParameters(FilterComparisonType, Boolean, String, Object[])
Возвращает параметризированный фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, и переданного списка значений параметров из правой части фильтра. При этом для колонки типа справочник можно определить тип ее значения, используемого в фильтре.
Declaration
public IEntitySchemaQueryFilterItem CreateFilterWithParameters(FilterComparisonType comparisonType, bool useDisplayValue, string leftExpressionColumnPath, params object[] rightExpressionParameterValues)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.Boolean | useDisplayValue | Признак типа значения колонки-справочника, которое используется в фильтре:
|
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
System.Object[] | rightExpressionParameterValues | Список значений параметров из правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilterWithParameters(FilterComparisonType, String, IEnumerable<Object>, Boolean)
Возвращает параметризированный фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, и списка значений параметров из переданного перечислителя. При этом для колонки типа справочник можно определить тип ее значения, используемого в фильтре.
Declaration
public IEntitySchemaQueryFilterItem CreateFilterWithParameters(FilterComparisonType comparisonType, string leftExpressionColumnPath, IEnumerable<object> rightExpressionParameterValues, bool useDisplayValue = false)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
System.Collections.Generic.IEnumerable<System.Object> | rightExpressionParameterValues | Перечислитель значений параметров из правой части фильтра. |
System.Boolean | useDisplayValue | Признак типа значения колонки-справочника, которое используется в фильтре:
|
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateFilterWithParameters(FilterComparisonType, String, Object[])
Возвращает параметризированный фильтр с заданным типом сравнения для выражения колонки, расположенной по указанному пути, и переданного списка значений параметров из правой части фильтра.
Declaration
public IEntitySchemaQueryFilterItem CreateFilterWithParameters(FilterComparisonType comparisonType, string leftExpressionColumnPath, params object[] rightExpressionParameterValues)
Parameters
Type | Name | Description |
---|---|---|
FilterComparisonType | comparisonType | Тип сравнения. |
System.String | leftExpressionColumnPath | Путь к колонке, содержащей выражение левой части фильтра. |
System.Object[] | rightExpressionParameterValues | Список значений параметров из правой части фильтра. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateHourFunction(String)
Возвращает экземпляр функции EntitySchemaDatePartQueryFunction, возвращающей часть даты [Час] для значения колонки, расположенной по указанному пути относительно корневой схемы.
Declaration
public EntitySchemaDatePartQueryFunction CreateHourFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaDatePartQueryFunction | Экземпляр созданной функции EntitySchemaDatePartQueryFunction. |
CreateHourMinuteFunction(String)
Возвращает экземпляр функции EntitySchemaDatePartQueryFunction, возвращающей часть даты [Минута] для значения колонки, расположенной по указанному пути относительно корневой схемы.
Declaration
public EntitySchemaDatePartQueryFunction CreateHourMinuteFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaDatePartQueryFunction | Экземпляр созданной функции EntitySchemaDatePartQueryFunction. |
CreateIsNotNullFilter(String)
Для текщуего запроса к схеме объекта возвращает фильтр сравнения типа [Не является null
в базе
данных], устанавливая в качестве проверяемого значения выражение колонки, расположенной по указанному пути.
Declaration
public IEntitySchemaQueryFilterItem CreateIsNotNullFilter(string leftExpressionColumnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | leftExpressionColumnPath | Путь к колонке, для которой строится фильтр. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateIsNullFilter(String)
Для текущего запроса к схеме объекта возвращает фильтр сравнения типа [Является null
в базе
данных], устанавливая в качестве условия проверки выражение колонки, расположенной по указанному пути.
Declaration
public IEntitySchemaQueryFilterItem CreateIsNullFilter(string leftExpressionColumnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | leftExpressionColumnPath | Путь к колонке, для выражения которой строится фильтр. |
Returns
Type | Description |
---|---|
IEntitySchemaQueryFilterItem | Экземпляр созданного фильтра IEntitySchemaQueryFilterItem. |
CreateIsNullFunction(String, String)
Возвращает экземпляр функции EntitySchemaIsNullQueryFunction для колонок с проверяемым и замещающим значениями, которые расположены по заданным путям относительно корневой схемы.
Declaration
public EntitySchemaIsNullQueryFunction CreateIsNullFunction(string checkColumnPath, string replacementColumnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | checkColumnPath | Путь к колонке, содержащей проверяемое значение. |
System.String | replacementColumnPath | Путь к колонке, содержащей значение, которое возвращается функцией в
случае, если проверяемое значение равно |
Returns
Type | Description |
---|---|
EntitySchemaIsNullQueryFunction | Экземпляр созданной функции EntitySchemaIsNullQueryFunction. |
CreateLengthFunction(String)
Возвращает экземпляр функции EntitySchemaLengthQueryFunction для выражения колонки по заданному пути относительно корневой схемы.
Declaration
public EntitySchemaLengthQueryFunction CreateLengthFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaLengthQueryFunction | Экземпляр созданной функции EntitySchemaLengthQueryFunction. |
CreateLengthFunction(EntitySchemaQueryExpression[])
Возвращает экземпляр функции EntitySchemaLengthQueryFunction для заданного массива выражений.
Declaration
public EntitySchemaLengthQueryFunction CreateLengthFunction(params EntitySchemaQueryExpression[] expressions)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpression[] | expressions | Массив выражений. |
Returns
Type | Description |
---|---|
EntitySchemaLengthQueryFunction | Экземпляр созданной функции EntitySchemaLengthQueryFunction. |
CreateMonthFunction(String)
Возвращает экземпляр функции EntitySchemaDatePartQueryFunction, возвращающей часть даты [Месяц] для значения колонки, расположенной по указанному пути относительно корневой схемы.
Declaration
public EntitySchemaDatePartQueryFunction CreateMonthFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaDatePartQueryFunction | Экземпляр созданной функции EntitySchemaDatePartQueryFunction. |
CreateNotExistsFilter(String)
Для текущего запроса к схеме объекта возвращает фильтр сравнения типа [Не существует по заданному условию] и устанавливает в качестве проверяемого значения выражение колонки, расположенной по заданному пути.
Declaration
public EntitySchemaQueryFilter CreateNotExistsFilter(string rightExpressionColumnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | rightExpressionColumnPath | Путь к колонке, для выражения которой строится фильтр. |
Returns
Type | Description |
---|---|
EntitySchemaQueryFilter | Экземпляр созданного фильтра EntitySchemaQueryFilter. |
CreateParameterExpression(Object)
Возвращает выражение запроса к схеме объекта для параметра с заданным значением.
Declaration
public static EntitySchemaQueryExpression CreateParameterExpression(object parameterValue)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parameterValue | Значение параметра. |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Выражение запроса к схеме объекта для параметра со значением |
CreateParameterExpression(Object, String, DataValueType)
Возвращает выражение запроса к схеме объекта для параметра с заданными значением, определенным типом данных значения и указанным значением для отображения.
Declaration
public static EntitySchemaQueryExpression CreateParameterExpression(object parameterValue, string displayValue, DataValueType valueType)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parameterValue | Значение параметра. |
System.String | displayValue | Значение для отображения параметра. |
DataValueType | valueType | Тип значения параметра. |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Выражение запроса к схеме объекта для параметра со значением |
CreateParameterExpression(Object, DataValueType)
Возвращает выражение запроса к схеме объекта для параметра с заданным значением определенного типа.
Declaration
public static EntitySchemaQueryExpression CreateParameterExpression(object parameterValue, DataValueType valueType)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parameterValue | Значение параметра. |
DataValueType | valueType | Тип значения параметра. |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Выражение запроса к схеме объекта для параметра со значением |
CreateParameterExpressions(DataValueType, IEnumerable<Object>)
Возвращает перечислитель выражений запросов для параметров с переданными значениями определенного типа данных.
Declaration
public static IEnumerable<EntitySchemaQueryExpression> CreateParameterExpressions(DataValueType valueType, IEnumerable<object> parameterValues)
Parameters
Type | Name | Description |
---|---|---|
DataValueType | valueType | Тип данных значений параметров. |
System.Collections.Generic.IEnumerable<System.Object> | parameterValues | Перечислитель значений параметров. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression> | Перечислитель выражений запросов для параметров со значениями |
CreateParameterExpressions(DataValueType, Object[])
Возвращает перечислитель выражений запросов для параметров с переданными значениями определенного типа данных.
Declaration
public static IEnumerable<EntitySchemaQueryExpression> CreateParameterExpressions(DataValueType valueType, params object[] parameterValues)
Parameters
Type | Name | Description |
---|---|---|
DataValueType | valueType | Тип данных значений параметров. |
System.Object[] | parameterValues | Массив значений параметров. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression> | Перечислитель выражений запросов для параметров со значениями |
CreateSchemaColumnExpression(String, Boolean)
Возвращает выражение колонки схемы объекта по заданному пути к колонке относительно корневой схемы.
Declaration
public EntitySchemaQueryExpression CreateSchemaColumnExpression(string columnPath, bool useCoalesceFunctionForMultiLookup = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
System.Boolean | useCoalesceFunctionForMultiLookup | Признак, использовать ли для колонки типа множественный
справочник функцию |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Созданный экземпляр EntitySchemaQueryExpression. |
CreateSchemaColumnExpression(EntitySchema, String, Boolean)
Возвращает выражение запроса к схеме объекта для заданных корневой схемы и пути к колонке относительно корневой схемы.
Declaration
public static EntitySchemaQueryExpression CreateSchemaColumnExpression(EntitySchema rootSchema, string columnPath, bool useCoalesceFunctionForMultiLookup = true)
Parameters
Type | Name | Description |
---|---|---|
EntitySchema | rootSchema | Корневая схема. |
System.String | columnPath | Путь к колонке относительно корневой схемы. |
System.Boolean | useCoalesceFunctionForMultiLookup | Признак, использовать ли для колонки типа справочник
функцию |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Созданный экземпляр EntitySchemaQueryExpression. |
CreateSchemaColumnExpression(EntitySchemaQuery, EntitySchema, String, Boolean, Boolean)
Возвращает выражение колонки схемы объекта для заданных запроса к схеме объекта, корневой схемы, пути к колонке относительно корневой схемы.
Declaration
public static EntitySchemaQueryExpression CreateSchemaColumnExpression(EntitySchemaQuery parentQuery, EntitySchema rootSchema, string columnPath, bool useCoalesceFunctionForMultiLookup = true, bool useDisplayValue = false)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQuery | parentQuery | Запрос к схеме объекта, для которого создается выражение колонки. |
EntitySchema | rootSchema | Корневая схема. |
System.String | columnPath | Путь к колонке относительно корневой схемы. |
System.Boolean | useCoalesceFunctionForMultiLookup | Признак, использовать ли для колонки типа справочник
функцию |
System.Boolean | useDisplayValue | Признак, использовать ли для колонки значение для отображения.
Необязательный параметр, по умолчанию равен |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Созданный экземпляр EntitySchemaQueryExpression. |
CreateSchemaColumnExpressions(IEnumerable<String>, Boolean)
Возвращает перечислитель выражений колонок запроса к схеме объекта по заданному набору путей к колонкам.
Declaration
public IEnumerable<EntitySchemaQueryExpression> CreateSchemaColumnExpressions(IEnumerable<string> columnPaths, bool useCoalesceFunctionForMultiLookup = true)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.String> | columnPaths | Перечислитель путей к колонкам относительно корневой схемы. |
System.Boolean | useCoalesceFunctionForMultiLookup | Признак, определяющий использовать ли для колонки типа
множественный справочник функцию |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression> | Перечислитель выражений EntitySchemaQueryExpression для колонок, расположенных по
путям |
CreateSchemaColumnExpressions(String[])
Возвращает перечислитель выражений колонок запроса к схеме объекта по заданному массиву путей к колонкам.
Declaration
public IEnumerable<EntitySchemaQueryExpression> CreateSchemaColumnExpressions(params string[] columnPaths)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | columnPaths | Массив путей к колонкам относительно корневой схемы. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression> | Перечислитель объектов EntitySchemaQueryExpression для колонок, расположенных по
путям |
CreateSchemaColumnExpressionsWithoutCoalesce(String[])
Возвращает перечислитель выражений колонок запроса к схеме объекта по заданному массиву путей к колонкам.
При этом, если колонка имеет тип множественный справочник, к ее значениям не применяется функция
COALESCE
.
Declaration
public IEnumerable<EntitySchemaQueryExpression> CreateSchemaColumnExpressionsWithoutCoalesce(params string[] columnPaths)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | columnPaths | Массив путей к колонкам относительно корневой схемы. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntitySchemaQueryExpression> | Перечислитель объектов EntitySchemaQueryExpression для колонок, расположенных по
путям |
CreateSchemaColumnQueryExpression(String, EntitySchema, Boolean)
Возвращает выражение запроса к схеме объекта по заданным пути к колонке схемы и корневой схеме. При этом для колонки можно определить, какой тип ее значения использовать в выражении - хранимое значение или значение для отображения.
Declaration
public static EntitySchemaQueryExpression CreateSchemaColumnQueryExpression(string columnPath, EntitySchema rootSchema, bool useDisplayValue = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке схемы относительно корневой схемы. |
EntitySchema | rootSchema | Корневая схема. |
System.Boolean | useDisplayValue | Признак, использовать ли для колонки значение для отображения.
Необязательный параметр, по умолчанию равен |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Выражение запроса к схеме объекта, построенное по пути к колонке |
CreateSchemaColumnQueryExpression(String, EntitySchema, EntitySchemaColumn, Boolean)
Возвращает выражение запроса к схеме объекта по заданным пути к колонке, корневой схеме и экземпляру колонки схемы. При этом для колонки можно определить, какой тип ее значения использовать в выражении - хранимое значение или значение для отображения.
Declaration
public static EntitySchemaQueryExpression CreateSchemaColumnQueryExpression(string columnPath, EntitySchema rootSchema, EntitySchemaColumn schemaColumn, bool useDisplayValue = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
EntitySchema | rootSchema | Экземпляр корневой схемы. |
EntitySchemaColumn | schemaColumn | Экземпляр колонки, для которой строится выражение. |
System.Boolean | useDisplayValue | Признак, использовать ли для колонки значение для отображения.
Необязательный параметр, по умолчанию равен |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Выражение запроса к схеме объекта, построенное по пути к колонке |
CreateSubEntitySchemaExpression(String)
Возвращает выражение подзапроса к схеме объекта для колонки, расположенной по заданному пути.
Declaration
public EntitySchemaQueryExpression CreateSubEntitySchemaExpression(string leftExprColumnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | leftExprColumnPath | Путь к колонке, для которой создается позапрос. |
Returns
Type | Description |
---|---|
EntitySchemaQueryExpression | Экземпляр выражения подзапроса для колонки, расположенной по пути
|
CreateTrimFunction(String)
Возвращает экземпляр функции EntitySchemaTrimQueryFunction для выражения колонки по заданному пути относительно корневой схемы.
Declaration
public EntitySchemaTrimQueryFunction CreateTrimFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaTrimQueryFunction | Экземпляр созданной функции EntitySchemaTrimQueryFunction. |
CreateTrimFunction(EntitySchemaQueryExpression[])
Возвращает экземпляр функции EntitySchemaTrimQueryFunction для заданного массива выражений.
Declaration
public EntitySchemaTrimQueryFunction CreateTrimFunction(params EntitySchemaQueryExpression[] expressions)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpression[] | expressions | Массив выражений. |
Returns
Type | Description |
---|---|
EntitySchemaTrimQueryFunction | Экземпляр созданной функции EntitySchemaTrimQueryFunction. |
CreateUpperFunction(String)
Возвращает экземпляр функции EntitySchemaUpperQueryFunction для выражения колонки по заданному пути относительно корневой схемы.
Declaration
public EntitySchemaUpperQueryFunction CreateUpperFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaUpperQueryFunction | Экземпляр созданной функции EntitySchemaUpperQueryFunction. |
CreateWeekdayFunction(String)
Возвращает экземпляр функции EntitySchemaDatePartQueryFunction, возвращающей часть даты [День недели] для значения колонки, расположенной по указанному пути относительно корневой схемы.
Declaration
public EntitySchemaDatePartQueryFunction CreateWeekdayFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaDatePartQueryFunction | Экземпляр созданной функции EntitySchemaDatePartQueryFunction. |
CreateWeekFunction(String)
Возвращает экземпляр функции EntitySchemaDatePartQueryFunction, возвращающей часть даты [Неделя] для значения колонки, расположенной по указанному пути относительно корневой схемы.
Declaration
public EntitySchemaDatePartQueryFunction CreateWeekFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaDatePartQueryFunction | Экземпляр созданной функции EntitySchemaDatePartQueryFunction. |
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)
Возвращает экземпляр функции EntitySchemaDatePartQueryFunction, возвращающей часть даты [Год] для значения колонки, расположенной по указанному пути относительно корневой схемы.
Declaration
public EntitySchemaDatePartQueryFunction CreateYearFunction(string columnPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnPath | Путь к колонке относительно корневой схемы. |
Returns
Type | Description |
---|---|
EntitySchemaDatePartQueryFunction | Экземпляр созданной функции EntitySchemaDatePartQueryFunction. |
GetDataTable(UserConnection)
Возвращает результат выполнения текущего запроса к схеме объекта в виде таблицы данных в памяти, используя заданное пользовательское подключение.
Declaration
public DataTable GetDataTable(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
Returns
Type | Description |
---|---|
System.Data.DataTable | Экземпляр System.Data.DataTable, представляющий результат выполнения текущего запроса к схеме объекта. |
GetDayOfWeekNumber(UserConnection, DayOfWeek)
Возвращает порядковый номер дня недели для заданного объекта System.DayOfWeek с учетом региональных настроек.
Declaration
public static int GetDayOfWeekNumber(UserConnection userConnection, DayOfWeek dayOfWeek)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.DayOfWeek | dayOfWeek | Экземпляр System.DayOfWeek, для которого определяется порядковый номер. |
Returns
Type | Description |
---|---|
System.Int32 | Порядковый номер дня недели для объекта |
GetEntity(UserConnection, Object)
Возвращает экземпляр Entity по заданному первичному ключу, используя заданное пользовательское подключение.
Declaration
public Entity GetEntity(UserConnection userConnection, object primaryColumnValue)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Object | primaryColumnValue | Значение первичного ключа. |
Returns
Type | Description |
---|---|
Entity | Экземпляр Entity с первичным ключом |
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()
Возвращает экземпляр схемы объекта текущего экземпляра EntitySchemaQuery.
Declaration
public EntitySchema GetSchema()
Returns
Type | Description |
---|---|
EntitySchema | Экземпляр EntitySchema. |
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. |
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. |
GetSelectQuery(UserConnection, EntitySchemaQueryOptions)
Возвращает запрос на выборку данных, построенный с учетом заданных настроек, используя заданное пользовательское подключение.
Declaration
public Select GetSelectQuery(UserConnection userConnection, EntitySchemaQueryOptions options)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
EntitySchemaQueryOptions | options | Настройки запроса к схеме объекта. |
Returns
Type | Description |
---|---|
Select | Экземпляр Select для текущего запроса к схеме объекта, построенный с учетом
настроек |
GetSummaryColumns()
Возвращает коллекцию выражений тех колонок запроса, для которых вычисляются итоговые значения.
Declaration
public EntitySchemaQueryColumnCollection GetSummaryColumns()
Returns
Type | Description |
---|---|
EntitySchemaQueryColumnCollection | Коллекция выражений колонок запроса, для которых вычисляются итоговые значения. |
GetSummaryColumns(IEnumerable<String>)
Для заданного перечня имен колонок возвращает коллекцию выражений колонок, для которых вычисляются итоговые значения.
Declaration
public EntitySchemaQueryColumnCollection GetSummaryColumns(IEnumerable<string> columnNames)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.String> | columnNames | Перечислитель имен колонок запроса. |
Returns
Type | Description |
---|---|
EntitySchemaQueryColumnCollection | Коллекция выражений колонок, для которых вычисляются итоговые значения. |
GetSummaryEntity(UserConnection)
Возвращает экземпляр Entity для результата, возвращаемого запросом на выборку итоговых значений для всех колонок текущего запроса с использованием заданного пользовательского подключения.
Declaration
public Entity GetSummaryEntity(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
Returns
Type | Description |
---|---|
Entity | Экземпляр Entity для результата, возвращаемого запросом на выборку итоговых значений всех колонок текущего запроса. |
GetSummaryEntity(UserConnection, IEnumerable<String>)
Возвращает экземпляр Entity для результата, возвращаемого запросом на выборку итоговых значений для колонок с заданными именами, используя заданное пользовательское подключение.
Declaration
public Entity GetSummaryEntity(UserConnection userConnection, IEnumerable<string> columnNames)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Collections.Generic.IEnumerable<System.String> | columnNames | Перечислитель имен колонок. |
Returns
Type | Description |
---|---|
Entity | Экземпляр Entity для результата, возвращаемого запросом на выборку итоговых значений
для колонок с именами |
GetSummaryEntity(UserConnection, String[])
Возвращает экземпляр Entity для результата, возвращаемого запросом на выборку итоговых значений для колонок с заданными именами, используя заданное пользовательское подключение.
Declaration
public Entity GetSummaryEntity(UserConnection userConnection, params string[] columnNames)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.String[] | columnNames | Массив имен колонок. |
Returns
Type | Description |
---|---|
Entity | Экземпляр Entity для результата, возвращаемого запросом на выборку итоговых значений
для колонок с именами |
GetSummaryEntity(UserConnection, EntitySchemaQueryColumnCollection)
Возвращает экземпляр Entity для результата, возвращаемого запросом на выборку итоговых значений для переданной коллекции колонок текущего запроса с использованием заданного пользовательского подключения.
Declaration
public Entity GetSummaryEntity(UserConnection userConnection, EntitySchemaQueryColumnCollection summaryColumns)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
EntitySchemaQueryColumnCollection | summaryColumns | Коллекция колонок запроса, для которых выбираются итоговые значения. |
Returns
Type | Description |
---|---|
Entity | Экземпляр Entity для результата, возвращаемого запросом на выборку итоговых значений
коллекции колонок |
GetSummarySelectQuery(UserConnection)
Возвращает запрос на выборку итоговых (агрегирующих) значений для всех колонок текущего экземпляра EntitySchemaQuery, используя заданное пользовательское подключение.
Declaration
public Select GetSummarySelectQuery(UserConnection userConnection)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
Returns
Type | Description |
---|---|
Select | Экземпляр Select построенного запроса на выборку. |
GetSummarySelectQuery(UserConnection, IEnumerable<String>)
Возвращает запрос на выборку итоговых (агрегирующих) значений для колонок текущего экземпляра EntitySchemaQuery с указанными именами, используя заданное пользовательское подключение.
Declaration
public Select GetSummarySelectQuery(UserConnection userConnection, IEnumerable<string> columnNames)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Collections.Generic.IEnumerable<System.String> | columnNames | Перечислитель имен колонок, для которых строится запрос на выборку итоговых значений. |
Returns
Type | Description |
---|---|
Select | Экземпляр Select построенного запроса на выборку. |
GetSummarySelectQuery(UserConnection, String[])
Возвращает запрос на выборку итоговых (агрегирующих) значений для колонок текущего экземпляра EntitySchemaQuery с указанными именами, используя заданное пользовательское подключение.
Declaration
public Select GetSummarySelectQuery(UserConnection userConnection, params string[] columnNames)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.String[] | columnNames | Массив имен колонок, для которых строится запрос на выборку итоговых значений. |
Returns
Type | Description |
---|---|
Select | Экземпляр Select построенного запроса на выборку. |
GetSummarySelectQuery(UserConnection, EntitySchemaQueryColumnCollection)
Возвращает запрос на выборку итоговых (агрегирующих) значений для заданной коллекции колонок текущего экземпляра EntitySchemaQuery, используя заданное пользовательское подключение.
Declaration
public Select GetSummarySelectQuery(UserConnection userConnection, EntitySchemaQueryColumnCollection summaryColumns)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
EntitySchemaQueryColumnCollection | summaryColumns | Коллекция колонок, для которых строится запрос на выборку итоговых значений. |
Returns
Type | Description |
---|---|
Select | Экземпляр Select построенного запроса на выборку. |
Exceptions
Type | Condition |
---|---|
SelectFromVirtualSchemaException | При попытке построения запроса на выборку из виртуальной схемы. |
GetTypedColumnValue<T>(Entity, String)
Возвращает типизированное значение колонки с заданным именем из переданного экземпляра Entity.
Declaration
public T GetTypedColumnValue<T>(Entity entity, string columnName)
Parameters
Type | Name | Description |
---|---|---|
Entity | entity | Экземпляр Entity, которому принадлежит колонка. |
System.String | columnName | Имя колонки. |
Returns
Type | Description |
---|---|
T | Типизированное значение колонки с именем |
Type Parameters
Name | Description |
---|---|
T | Любой тип. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Если в качестве параметра |
LoadDataTableData(UserConnection, DataTable)
Загружает результат выполнения текущего запроса к схеме объекта в переданный объект System.Data.DataTable, используя заданное пользовательское подключение.
Declaration
public void LoadDataTableData(UserConnection userConnection, DataTable dataTable)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Data.DataTable | dataTable | Экземпляр System.Data.DataTable, в который загружается результат выполнения запроса. |
LoadDataTableData(UserConnection, DataTable, EntitySchemaQueryOptions)
Загружает результат выполнения текущего запроса к схеме объекта в переданный объект System.Data.DataTable с учетом заданных настроек, используя заданное пользовательское подключение.
Declaration
public void LoadDataTableData(UserConnection userConnection, DataTable dataTable, EntitySchemaQueryOptions options)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | Пользовательское подключение. |
System.Data.DataTable | dataTable | Экземпляр System.Data.DataTable, в который загружается результат выполнения запроса. |
EntitySchemaQueryOptions | options | Настройки запроса к схеме объекта. |
RemoveColumn(String)
Удаляет колонку с заданным именем из коллекции колонок текущего запроса.
Declaration
public void RemoveColumn(string columnName)
Parameters
Type | Name | Description |
---|---|---|
System.String | columnName | Имя удаляемой колонки. |
ResetSchema()
Очищает схему текущего экземпляра EntitySchemaQuery.
Declaration
public void ResetSchema()
ResetSelectQuery()
Очищает запрос на выборку для текущего запроса к схеме объекта.
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
Событие, возникающее при загрузке данных.
Declaration
public event EntitySchemaQueryLoadingEventHandler Loading
Event Type
Type | Description |
---|---|
EntitySchemaQueryLoadingEventHandler |