Class SqlRecordSetNode

Namespace

LfrlAnvil.Sql.Expressions.Objects

Assembly

LfrlAnvil.Sql.Core.dll

Represents an SQL syntax tree node that defines a single record set.

public abstract class SqlRecordSetNode : SqlNodeBase

Inheritance

object

SqlNodeBase

SqlRecordSetNode

Derived

SqlCommonTableExpressionRecordSetNode

SqlInternalRecordSetNode

SqlNamedFunctionRecordSetNode

SqlNewTableNode

SqlNewViewNode

SqlQueryRecordSetNode

SqlRawRecordSetNode

SqlTableBuilderNode

SqlTableNode

SqlViewBuilderNode

SqlViewNode

Inherited Members

SqlNodeBase.NodeType

SqlNodeBase.ToString()

SqlNodeBase.ToString(SqlNodeDebugInterpreter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

SqlNodeExtensions.Cross(SqlRecordSetNode)

SqlNodeExtensions.Exists(SqlRecordSetNode)

SqlNodeExtensions.FullOn(SqlRecordSetNode, SqlConditionNode)

SqlNodeExtensions.GetAll(SqlRecordSetNode)

SqlNodeExtensions.GetRawField(SqlRecordSetNode, string, TypeNullability?)

SqlNodeExtensions.InnerOn(SqlRecordSetNode, SqlConditionNode)

SqlNodeExtensions.Join(SqlRecordSetNode, params SqlDataSourceJoinOnNode[])

SqlNodeExtensions.Join(SqlRecordSetNode, params SqlJoinDefinition[])

SqlNodeExtensions.Join(SqlRecordSetNode, IEnumerable<SqlDataSourceJoinOnNode>)

SqlNodeExtensions.Join(SqlRecordSetNode, IEnumerable<SqlJoinDefinition>)

SqlNodeExtensions.LeftOn(SqlRecordSetNode, SqlConditionNode)

SqlNodeExtensions.NotExists(SqlRecordSetNode)

SqlNodeExtensions.RightOn(SqlRecordSetNode, SqlConditionNode)

SqlNodeExtensions.ToDataSource<TRecordSetNode>(TRecordSetNode)

SqlNodeExtensions.ToTruncate(SqlRecordSetNode)

Constructors

SqlRecordSetNode(string?, bool)

Creates a new SqlRecordSetNode with Unknown type.

protected SqlRecordSetNode(string? alias, bool isOptional)

Parameters

alias string

isOptional bool

Properties

Alias

Optional alias of this record set.

public string? Alias { get; }

Property Value

string

Identifier

Gets the internal identifier of this record set. This can be used to get a record set from a SqlMultiDataSourceNode.

public string Identifier { get; }

Property Value

string

Info

SqlRecordSetInfo associated with this record set.

public abstract SqlRecordSetInfo Info { get; }

Property Value

SqlRecordSetInfo

IsAliased

Specifies whether or not this record set is aliased.

public bool IsAliased { get; }

Property Value

bool

IsOptional

Specifies whether or not this record set is marked as optional.

public bool IsOptional { get; }

Property Value

bool

Remarks

Optional record sets will only contain nullable data fields.

this[string]

Gets a data field associated with this record set by its name.

public SqlDataFieldNode this[string fieldName] { get; }

Parameters

fieldName string

Name of the data field to get.

Property Value

SqlDataFieldNode

Exceptions

KeyNotFoundException

When data field does not exist.

Methods

As(string)

Creates a new SQL record set node with changed Alias.

[Pure]
public abstract SqlRecordSetNode As(string alias)

Parameters

alias string

Alias to set.

Returns

SqlRecordSetNode

New SQL record set node.

AsSelf()

Creates a new SQL record set node without an alias.

[Pure]
public abstract SqlRecordSetNode AsSelf()

Returns

SqlRecordSetNode

New SQL record set node.

GetField(string)

Returns a data field associated with this record set by its name.

[Pure]
public abstract SqlDataFieldNode GetField(string name)

Parameters

name string

Data field's name.

Returns

SqlDataFieldNode

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 abstract IReadOnlyCollection<SqlDataFieldNode> GetKnownFields()

Returns

IReadOnlyCollection<SqlDataFieldNode>

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 abstract SqlDataFieldNode GetUnsafeField(string name)

Parameters

name string

Data 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 abstract SqlRecordSetNode MarkAsOptional(bool optional = true)

Parameters

optional bool

IsOptional value to set. Equal to true by default.

Returns

SqlRecordSetNode

New SQL record set node.