Platform Core .NET Assemblies API
EntitySchemaQuery Class Members
See Also  Properties  Methods  Events Send Feedback
Terrasoft.Core.Entities Namespace : EntitySchemaQuery Class

Glossary Item Box

The following tables list the members exposed by EntitySchemaQuery.

Public Constructors

 NameDescription
Public ConstructorEntitySchemaQuery ConstructorOverloaded.   
Top

Public Properties

 NameDescription
Public PropertyCacheThe query cache.  
Public PropertyCacheItemNameName of the cache item.  
Public PropertyCanReadUncommitedDataDetermines whether the query results will include the data for which the transaction is not completed.  
Public PropertyCaptionHeader.  
Public PropertyChunkSizeRows to read from DB in single chunk.  
Public PropertyColumnsCollection of columns of the current entity schema query.  
Public PropertyDataValueTypeManagerManager of the data type values.  
Public PropertyEntitySchemaManagerEntity schema manager.  
Public PropertyFiltersCollection of filters of the current entity schema query.  
Public PropertyHideSecurityValueThe parameter that defines whether the values of the encrypted columns will be hidden.  
Public PropertyIgnoreDisplayValuesIndicates whether displayed values of columns are used in the query.  
Public PropertyIsDistinctIndicates whether to remove duplicates in the resulting data set.  
Public PropertyIsInheritedIndicates whether the query is inherited.  
Public PropertyJoinRightStateThe parameter that defines conditions for applying permissions when using related tables if the schema is managed by records.  
Public PropertyManagerSchema manager.  
Public PropertyManagerItemManager item.  
Public PropertyNameName.  
Public PropertyParentCollectionA collection of queries to which the current request to the object schema belongs.  
Public PropertyParentEntitySchemaParent schema of the query.  
Public PropertyPrimaryQueryColumnThe column created from the primary column of the root schema. Initialized during the first access.  
Public PropertyQueryOptimizeAllows using query optimization.  
Public PropertyRootSchemaThe root schema.  
Public PropertyRowCountNumber of rows that are returned by the query.  
Public PropertySchemaAliasPrefixGets or sets the prefix, that is used in schemas aliases generation.  
Public PropertySkipRowCountNumber of rows to skip in the resulting data set.  
Public PropertyUseAdminRightsThe parameter that defines whether permissions will be taken into account when constructing a data acquisition request.  
Public PropertyUseLocalizationThe parameter that defines whether localized data will be used.  
Public PropertyUseOffsetFetchPaging  
Public PropertyUseRecordDeactivationRepresent parameter which determines disabling data in filtering.  
Top

Public Methods

 NameDescription
Public MethodAddAllSchemaColumnsThe object schema adds all the columns of the root schema in the column collection of the current query.  
Public MethodAddColumnOverloaded.   
Public MethodClearCacheClears the cache of the current query.  
Public Methodstatic (Shared in Visual Basic)ClearDefCacheRemoves the item with the specified name from the query's cache.  
Public MethodCloneCreates the clone of the current EntitySchemaQuery instance.  
Public MethodCreateAggregationEntitySchemaExpressionGets an expression of the aggregating function of the specified type to express a column that is located along a specified path.  
Public MethodCreateAggregationFunctionGets the instance of the EntitySchemaAggregationQueryFunction aggregate function with the specified type of column in a specified path in relation to the root schema.  
Public MethodCreateCaseNotNullFunctionGets the instance of the EntitySchemaCaseNotNullQueryFunction function for the specified array of condition expressions.  
Public MethodCreateCaseNotNullQueryFunctionWhenItemReturns an instance of an expression for the sql construct of the WHEN <Expression_1> IS NOT NULL THEN <Expression_2> form.  
Public MethodCreateCastFunctionReturns 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.  
Public Methodstatic (Shared in Visual Basic)CreateCoalesceFunctionOverloaded.   
Public MethodCreateConcatFunctionGets the instance of the EntitySchemaConcatQueryFunction function for the specified array of expressions.  
Public MethodCreateCurrentDateFunctionGets the instance of the EntitySchemaCurrentDateQueryFunction function that returns the current date.  
Public MethodCreateCurrentDateTimeFunctionGets the instance of the EntitySchemaCurrentDateTimeQueryFunction function that returns the current date and time.  
Public MethodCreateCurrentTimeFunctionGets the instance of the EntitySchemaCurrentTimeQueryFunction function that defines the current date and time.  
Public MethodCreateCurrentUserAccountFunctionGets the instance of the EntitySchemaCurrentUserAccountQueryFunction function that defines the account Id of the current user.  
Public MethodCreateCurrentUserContactFunctionGets the instance of the EntitySchemaCurrentUserContactQueryFunction function that defines the contact Id of the current user.  
Public MethodCreateCurrentUserFunctionGets the instance of the EntitySchemaCurrentUserQueryFunction function that defines the current user.  
Public MethodCreateDatePartFunctionGets 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.  
Public MethodCreateDatePartFunctionExpressionReturns 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.  
Public MethodCreateDayFunctionGets 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.  
Public MethodCreateExistsFilterFor 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.  
Public MethodCreateFilterOverloaded.   
Public MethodCreateFilterWithParametersOverloaded.   
Public MethodCreateHourFunctionGets 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.  
Public MethodCreateHourMinuteFunctionGets 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.  
Public MethodCreateIsNotNullFilterFor 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.  
Public MethodCreateIsNullFilterFor 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.  
Public MethodCreateIsNullFunctionGets the instance of the EntitySchemaIsNullQueryFunction function for columns with values to check and substitute in paths specified in relation to the root schema.  
Public MethodCreateLengthFunctionOverloaded.   
Public MethodCreateMonthFunctionGets 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.  
Public MethodCreateNotExistsFilterFor 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.  
Public Methodstatic (Shared in Visual Basic)CreateParameterExpressionOverloaded.   
Public Methodstatic (Shared in Visual Basic)CreateParameterExpressionsOverloaded.   
Public Methodstatic (Shared in Visual Basic)CreateSchemaColumnExpressionOverloaded.   
Public MethodCreateSchemaColumnExpressionsOverloaded.   
Public MethodCreateSchemaColumnExpressionsWithoutCoalesceGets 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.  
Public Methodstatic (Shared in Visual Basic)CreateSchemaColumnQueryExpressionOverloaded.   
Public MethodCreateSubEntitySchemaExpressionGets the expression of entity schema subquery for the column in the specified path.  
Public MethodCreateTrimFunctionOverloaded.   
Public MethodCreateUpperFunctionReturns an instance of the EntitySchemaUpperQueryFunction function for the specified column expression by the specified path relative to the root schema.  
Public MethodCreateWeekdayFunctionGets 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.  
Public MethodCreateWeekFunctionGets 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.  
Public MethodCreateWindowFunctionCreate window function instance for specified function, partition by and order by columns.  
Public MethodCreateYearFunctionGets 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.  
Public MethodGetDataTableReturns the result of the current query execution to the object schema as a data table in memory using the specified user connection.  
Public Methodstatic (Shared in Visual Basic)GetDayOfWeekNumberGets the sequence number of the day of week for the specified System.DayOfWeek entity taking into account the local settings.  
Public MethodGetEntityGets the Entity instance by the specified primary key, using the specified user connection.  
Public MethodGetEntityCollectionOverloaded.   
Public MethodGetSchemaGets the entity schema instance of the current EntitySchemaQuery instance.  
Public MethodGetSelectQueryOverloaded.   
Public MethodGetSummaryColumnsOverloaded.   
Public MethodGetSummaryEntityOverloaded.   
Public MethodGetSummarySelectQueryOverloaded.   
Public MethodGetTypedColumnValue<T>Gets the typed value of the column with the specified name from the passed-in Entity instance.  
Public MethodLoadDataTableDataOverloaded.   
Public MethodRemoveColumnRemoves the column with the specified name from the collection of columns of the current query.  
Public MethodResetSchemaClears the schema of the current EntitySchemaQuery instance.  
Public MethodResetSelectQueryClears the select query for the current entity schema query.  
Public MethodSetLocalizationCultureIdSets the localization culture Id.  
Top

Public Events

 NameDescription
Public EventLoadingEvent that occurs when loading data.  
Top

See Also

© Terrasoft 2002-2018.