Class SqlQueryRecordSetNode
- Namespace
- LfrlAnvil.Sql.Expressions.Objects
- Assembly
- LfrlAnvil.Sql.Core.dll
Represents an SQL syntax tree node that defines a single record set based on an SqlQueryExpressionNode instance.
public sealed class SqlQueryRecordSetNode : SqlRecordSetNode
- Inheritance
-
SqlQueryRecordSetNode
- Inherited Members
- Extension Methods
Properties
Alias
Alias of this record set.
public string Alias { get; }
Property Value
Info
SqlRecordSetInfo associated with this record set.
public override SqlRecordSetInfo Info { get; }
Property Value
this[string]
Gets a data field associated with this record set by its name.
public SqlQueryDataFieldNode this[string fieldName] { get; }
Parameters
fieldName
stringName of the data field to get.
Property Value
Exceptions
- KeyNotFoundException
When data field does not exist.
Query
Underlying SqlQueryExpressionNode instance.
public SqlQueryExpressionNode Query { get; }
Property Value
Methods
As(string)
Creates a new SQL record set node with changed Alias.
[Pure]
public override SqlQueryRecordSetNode As(string alias)
Parameters
alias
stringAlias to set.
Returns
- SqlQueryRecordSetNode
New SQL record set node.
AsSelf()
Creates a new SQL record set node without an alias.
[Pure]
public override SqlQueryRecordSetNode AsSelf()
Returns
- SqlQueryRecordSetNode
New SQL record set node.
GetField(string)
Returns a data field associated with this record set by its name
.
[Pure]
public override SqlQueryDataFieldNode GetField(string name)
Parameters
name
stringData field's name.
Returns
- SqlQueryDataFieldNode
SqlDataFieldNode instance associated with the provided
name
.
Exceptions
- KeyNotFoundException
When data field does not exist.
GetKnownFields()
Returns a collection of all known data fields that belong to this record set.
[Pure]
public override IReadOnlyCollection<SqlQueryDataFieldNode> GetKnownFields()
Returns
- IReadOnlyCollection<SqlQueryDataFieldNode>
Collection of all known data fields that belong to this record set.
GetUnsafeField(string)
Returns an unsafe data field associated with this record set by its name
.
If a known data field by the provided name
does not exist, then a new SqlRawDataFieldNode instance
will be returned instead.
[Pure]
public override SqlDataFieldNode GetUnsafeField(string name)
Parameters
name
stringData field's name.
Returns
- SqlDataFieldNode
SqlDataFieldNode instance associated with the provided
name
.
MarkAsOptional(bool)
Creates a new SQL record set node with changed IsOptional.
[Pure]
public override SqlQueryRecordSetNode MarkAsOptional(bool optional = true)
Parameters
optional
boolIsOptional value to set. Equal to true by default.
Returns
- SqlQueryRecordSetNode
New SQL record set node.