Class HierarchicalSelectOptions
Parameters for building hierarchical queries.
Inheritance
Inherited Members
Namespace: Terrasoft.Core.DB
Assembly: Terrasoft.Core.dll
Syntax
public class HierarchicalSelectOptions
Constructors
HierarchicalSelectOptions()
Initializes a new HierarchicalSelectOptions instance.
Declaration
public HierarchicalSelectOptions()
HierarchicalSelectOptions(HierarchicalSelectOptions)
Initializes a new HierarchicalSelectOptions instance that is a clone of the passed-in instance.
Declaration
public HierarchicalSelectOptions(HierarchicalSelectOptions source)
Parameters
Type | Name | Description |
---|---|---|
HierarchicalSelectOptions | source | The HierarchicalSelectOptions instance whose clone is being created. |
Properties
CommonTableExpressionName
Name of a common table expression hierarchical query.
Declaration
public string CommonTableExpressionName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
By default <HierarchicalSelect>
CreateCommonTableExpression
Determines whether a common table expression will be created for this hierarchical query.
Declaration
public bool CreateCommonTableExpression { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
HasStartingPrimaryColumnCondition
Determines whether the query has a condition for specifying the start record in hierarchy.
Declaration
public bool HasStartingPrimaryColumnCondition { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IncludeLevelColumn
Determines whether the query will return a column with the number of record's hierarchical level.
Declaration
public bool IncludeLevelColumn { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsDistinct
Determines whether the query returns only unique records.
Declaration
public bool IsDistinct { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
LevelColumnAlias
Column alias with record level number in hierarchy.
Declaration
public string LevelColumnAlias { get; set; }
Property Value
Type | Description |
---|---|
System.String |
MaxDepthParameter
Maximum level of the nested hierarchy
Declaration
public QueryParameter MaxDepthParameter { get; set; }
Property Value
Type | Description |
---|---|
QueryParameter |
ParentColumnName
Parent column name.
Declaration
public string ParentColumnName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PrimaryColumnName
Primary key column name.
Declaration
public string PrimaryColumnName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RootSourceAlias
Root table alias. Should be used for avoiding column name ambiguity.
Declaration
public string RootSourceAlias { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SelectType
Hierarchical select type.
Declaration
public HierarchicalSelectType SelectType { get; set; }
Property Value
Type | Description |
---|---|
HierarchicalSelectType |
StartingPrimaryColumnCondition
Condition by the primary column that determines the start record in hierarchy.
Declaration
public QueryCondition StartingPrimaryColumnCondition { get; }
Property Value
Type | Description |
---|---|
QueryCondition |
UseOptimizedHierarchicalQueryBuilder
Gets or sets a value indicating whether hierarchical query uses optimized query builder.
Declaration
public bool UseOptimizedHierarchicalQueryBuilder { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |