Class SqlNode.Functions

Namespace

LfrlAnvil.Sql.Expressions

Assembly

LfrlAnvil.Sql.Core.dll

Creates instances of SqlFunctionExpressionNode type.

public static class SqlNode.Functions

Inheritance

object

SqlNode.Functions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Abs(SqlExpressionNode)

Creates a new SqlAbsFunctionExpressionNode instance.

[Pure]
public static SqlAbsFunctionExpressionNode Abs(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to calculate the absolute value from.

Returns

SqlAbsFunctionExpressionNode

New SqlAbsFunctionExpressionNode instance.

ByteLength(SqlExpressionNode)

Creates a new SqlByteLengthFunctionExpressionNode instance.

[Pure]
public static SqlByteLengthFunctionExpressionNode ByteLength(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to calculate byte length from.

Returns

SqlByteLengthFunctionExpressionNode

New SqlByteLengthFunctionExpressionNode instance.

Ceiling(SqlExpressionNode)

Creates a new SqlCeilingFunctionExpressionNode instance.

[Pure]
public static SqlCeilingFunctionExpressionNode Ceiling(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to calculate the ceiling value from.

Returns

SqlCeilingFunctionExpressionNode

New SqlCeilingFunctionExpressionNode instance.

Coalesce(params SqlExpressionNode[])

Creates a new SqlCoalesceFunctionExpressionNode instance.

[Pure]
public static SqlCoalesceFunctionExpressionNode Coalesce(params SqlExpressionNode[] arguments)

Parameters

arguments SqlExpressionNode[]

Collection of function's arguments.

Returns

SqlCoalesceFunctionExpressionNode

New SqlCoalesceFunctionExpressionNode instance.

Exceptions

ArgumentException

When collection of arguments is empty.

CurrentDate()

Creates a new SqlCurrentDateFunctionExpressionNode instance.

[Pure]
public static SqlCurrentDateFunctionExpressionNode CurrentDate()

Returns

SqlCurrentDateFunctionExpressionNode

New SqlCurrentDateFunctionExpressionNode instance.

CurrentDateTime()

Creates a new SqlCurrentDateTimeFunctionExpressionNode instance.

[Pure]
public static SqlCurrentDateTimeFunctionExpressionNode CurrentDateTime()

Returns

SqlCurrentDateTimeFunctionExpressionNode

New SqlCurrentDateTimeFunctionExpressionNode instance.

CurrentTime()

Creates a new SqlCurrentTimeFunctionExpressionNode instance.

[Pure]
public static SqlCurrentTimeFunctionExpressionNode CurrentTime()

Returns

SqlCurrentTimeFunctionExpressionNode

New SqlCurrentTimeFunctionExpressionNode instance.

CurrentTimestamp()

Creates a new SqlCurrentTimestampFunctionExpressionNode instance.

[Pure]
public static SqlCurrentTimestampFunctionExpressionNode CurrentTimestamp()

Returns

SqlCurrentTimestampFunctionExpressionNode

New SqlCurrentTimestampFunctionExpressionNode instance.

CurrentUtcDateTime()

Creates a new SqlCurrentUtcDateTimeFunctionExpressionNode instance.

[Pure]
public static SqlCurrentUtcDateTimeFunctionExpressionNode CurrentUtcDateTime()

Returns

SqlCurrentUtcDateTimeFunctionExpressionNode

New SqlCurrentUtcDateTimeFunctionExpressionNode instance.

ExtractDate(SqlExpressionNode)

Creates a new SqlExtractDateFunctionExpressionNode instance.

[Pure]
public static SqlExtractDateFunctionExpressionNode ExtractDate(SqlExpressionNode expression)

Parameters

expression SqlExpressionNode

Expression to extract date part from.

Returns

SqlExtractDateFunctionExpressionNode

New SqlExtractDateFunctionExpressionNode instance.

ExtractDayOfMonth(SqlExpressionNode)

Creates a new SqlExtractDayFunctionExpressionNode instance.

[Pure]
public static SqlExtractDayFunctionExpressionNode ExtractDayOfMonth(SqlExpressionNode expression)

Parameters

expression SqlExpressionNode

Expression to extract day of month component from.

Returns

SqlExtractDayFunctionExpressionNode

New SqlExtractDayFunctionExpressionNode instance.

ExtractDayOfWeek(SqlExpressionNode)

Creates a new SqlExtractDayFunctionExpressionNode instance.

[Pure]
public static SqlExtractDayFunctionExpressionNode ExtractDayOfWeek(SqlExpressionNode expression)

Parameters

expression SqlExpressionNode

Expression to extract day of week component from.

Returns

SqlExtractDayFunctionExpressionNode

New SqlExtractDayFunctionExpressionNode instance.

ExtractDayOfYear(SqlExpressionNode)

Creates a new SqlExtractDayFunctionExpressionNode instance.

[Pure]
public static SqlExtractDayFunctionExpressionNode ExtractDayOfYear(SqlExpressionNode expression)

Parameters

expression SqlExpressionNode

Expression to extract day of year component from.

Returns

SqlExtractDayFunctionExpressionNode

New SqlExtractDayFunctionExpressionNode instance.

ExtractTemporalUnit(SqlExpressionNode, SqlTemporalUnit)

Creates a new SqlExtractTemporalUnitFunctionExpressionNode instance.

[Pure]
public static SqlExtractTemporalUnitFunctionExpressionNode ExtractTemporalUnit(SqlExpressionNode expression, SqlTemporalUnit unit)

Parameters

expression SqlExpressionNode

Expression to extract the desired date or time component from.

unit SqlTemporalUnit

SqlTemporalUnit that specifies the date or time component to extract.

Returns

SqlExtractTemporalUnitFunctionExpressionNode

New SqlExtractTemporalUnitFunctionExpressionNode instance.

ExtractTimeOfDay(SqlExpressionNode)

Creates a new SqlExtractTimeOfDayFunctionExpressionNode instance.

[Pure]
public static SqlExtractTimeOfDayFunctionExpressionNode ExtractTimeOfDay(SqlExpressionNode expression)

Parameters

expression SqlExpressionNode

Expression to extract time of day part from.

Returns

SqlExtractTimeOfDayFunctionExpressionNode

New SqlExtractTimeOfDayFunctionExpressionNode instance.

Floor(SqlExpressionNode)

Creates a new SqlFloorFunctionExpressionNode instance.

[Pure]
public static SqlFloorFunctionExpressionNode Floor(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to calculate the floor value from.

Returns

SqlFloorFunctionExpressionNode

New SqlFloorFunctionExpressionNode instance.

IndexOf(SqlExpressionNode, SqlExpressionNode)

Creates a new SqlIndexOfFunctionExpressionNode instance.

[Pure]
public static SqlIndexOfFunctionExpressionNode IndexOf(SqlExpressionNode argument, SqlExpressionNode value)

Parameters

argument SqlExpressionNode

Expression to find the first occurrence in.

value SqlExpressionNode

Value to search for.

Returns

SqlIndexOfFunctionExpressionNode

New SqlIndexOfFunctionExpressionNode instance.

LastIndexOf(SqlExpressionNode, SqlExpressionNode)

Creates a new SqlLastIndexOfFunctionExpressionNode instance.

[Pure]
public static SqlLastIndexOfFunctionExpressionNode LastIndexOf(SqlExpressionNode argument, SqlExpressionNode value)

Parameters

argument SqlExpressionNode

Expression to find the last occurrence in.

value SqlExpressionNode

Value to search for.

Returns

SqlLastIndexOfFunctionExpressionNode

New SqlLastIndexOfFunctionExpressionNode instance.

Length(SqlExpressionNode)

Creates a new SqlLengthFunctionExpressionNode instance.

[Pure]
public static SqlLengthFunctionExpressionNode Length(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to calculate length from.

Returns

SqlLengthFunctionExpressionNode

New SqlLengthFunctionExpressionNode instance.

Max(params SqlExpressionNode[])

Creates a new SqlMaxFunctionExpressionNode instance.

[Pure]
public static SqlMaxFunctionExpressionNode Max(params SqlExpressionNode[] arguments)

Parameters

arguments SqlExpressionNode[]

Collection of expressions to calculate the maximum value from.

Returns

SqlMaxFunctionExpressionNode

New SqlMaxFunctionExpressionNode instance.

Exceptions

ArgumentException

When collection of arguments is empty.

Min(params SqlExpressionNode[])

Creates a new SqlMinFunctionExpressionNode instance.

[Pure]
public static SqlMinFunctionExpressionNode Min(params SqlExpressionNode[] arguments)

Parameters

arguments SqlExpressionNode[]

Collection of expressions to calculate the minimum value from.

Returns

SqlMinFunctionExpressionNode

New SqlMinFunctionExpressionNode instance.

Exceptions

ArgumentException

When collection of arguments is empty.

Named(SqlSchemaObjectName, params SqlExpressionNode[])

Creates a new SqlNamedFunctionExpressionNode instance.

[Pure]
public static SqlNamedFunctionExpressionNode Named(SqlSchemaObjectName name, params SqlExpressionNode[] arguments)

Parameters

name SqlSchemaObjectName

Function's name.

arguments SqlExpressionNode[]

Collection of function's arguments.

Returns

SqlNamedFunctionExpressionNode

New SqlNamedFunctionExpressionNode instance.

NewGuid()

Creates a new SqlNewGuidFunctionExpressionNode instance.

[Pure]
public static SqlNewGuidFunctionExpressionNode NewGuid()

Returns

SqlNewGuidFunctionExpressionNode

New SqlNewGuidFunctionExpressionNode instance.

Power(SqlExpressionNode, SqlExpressionNode)

Creates a new SqlPowerFunctionExpressionNode instance.

[Pure]
public static SqlPowerFunctionExpressionNode Power(SqlExpressionNode argument, SqlExpressionNode power)

Parameters

argument SqlExpressionNode

Expression to raise to the desired power.

power SqlExpressionNode

Expression that defines the desired power to raise to.

Returns

SqlPowerFunctionExpressionNode

New SqlPowerFunctionExpressionNode instance.

Replace(SqlExpressionNode, SqlExpressionNode, SqlExpressionNode)

Creates a new SqlReplaceFunctionExpressionNode instance.

[Pure]
public static SqlReplaceFunctionExpressionNode Replace(SqlExpressionNode argument, SqlExpressionNode oldValue, SqlExpressionNode newValue)

Parameters

argument SqlExpressionNode

Expression to replace occurrences in.

oldValue SqlExpressionNode

Value to replace.

newValue SqlExpressionNode

Replacement value.

Returns

SqlReplaceFunctionExpressionNode

New SqlReplaceFunctionExpressionNode instance.

Reverse(SqlExpressionNode)

Creates a new SqlReverseFunctionExpressionNode instance.

[Pure]
public static SqlReverseFunctionExpressionNode Reverse(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to reverse.

Returns

SqlReverseFunctionExpressionNode

New SqlReverseFunctionExpressionNode instance.

Round(SqlExpressionNode, SqlExpressionNode)

Creates a new SqlRoundFunctionExpressionNode instance.

[Pure]
public static SqlRoundFunctionExpressionNode Round(SqlExpressionNode argument, SqlExpressionNode precision)

Parameters

argument SqlExpressionNode

Expression to calculate the rounded value from.

precision SqlExpressionNode

Decimal rounding precision.

Returns

SqlRoundFunctionExpressionNode

New SqlRoundFunctionExpressionNode instance.

Sign(SqlExpressionNode)

Creates a new SqlSignFunctionExpressionNode instance.

[Pure]
public static SqlSignFunctionExpressionNode Sign(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to calculate the sign from.

Returns

SqlSignFunctionExpressionNode

New SqlSignFunctionExpressionNode instance.

SquareRoot(SqlExpressionNode)

Creates a new SqlSquareRootFunctionExpressionNode instance.

[Pure]
public static SqlSquareRootFunctionExpressionNode SquareRoot(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to calculate the square root from.

Returns

SqlSquareRootFunctionExpressionNode

New SqlSquareRootFunctionExpressionNode instance.

Substring(SqlExpressionNode, SqlExpressionNode, SqlExpressionNode?)

Creates a new SqlSubstringFunctionExpressionNode instance.

[Pure]
public static SqlSubstringFunctionExpressionNode Substring(SqlExpressionNode argument, SqlExpressionNode startIndex, SqlExpressionNode? length = null)

Parameters

argument SqlExpressionNode

Expression to extract a substring from.

startIndex SqlExpressionNode

Position of the first character of the substring.

length SqlExpressionNode

Optional length of the substring. Equal to null by default.

Returns

SqlSubstringFunctionExpressionNode

New SqlSubstringFunctionExpressionNode instance.

TemporalAdd(SqlExpressionNode, SqlExpressionNode, SqlTemporalUnit)

Creates a new SqlTemporalAddFunctionExpressionNode instance.

[Pure]
public static SqlTemporalAddFunctionExpressionNode TemporalAdd(SqlExpressionNode expression, SqlExpressionNode value, SqlTemporalUnit unit)

Parameters

expression SqlExpressionNode

Expression to add value to.

value SqlExpressionNode

Value to add.

unit SqlTemporalUnit

SqlTemporalUnit that specifies the unit of the added value.

Returns

SqlTemporalAddFunctionExpressionNode

New SqlTemporalAddFunctionExpressionNode instance.

TemporalDiff(SqlExpressionNode, SqlExpressionNode, SqlTemporalUnit)

Creates a new SqlTemporalDiffFunctionExpressionNode instance.

[Pure]
public static SqlTemporalDiffFunctionExpressionNode TemporalDiff(SqlExpressionNode start, SqlExpressionNode end, SqlTemporalUnit unit)

Parameters

start SqlExpressionNode

Expression that defines the start value.

end SqlExpressionNode

Expression that defines the end value.

unit SqlTemporalUnit

SqlTemporalUnit that specifies the unit of the returned result.

Returns

SqlTemporalDiffFunctionExpressionNode

New SqlTemporalDiffFunctionExpressionNode instance.

ToLower(SqlExpressionNode)

Creates a new SqlToLowerFunctionExpressionNode instance.

[Pure]
public static SqlToLowerFunctionExpressionNode ToLower(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to convert to lowercase.

Returns

SqlToLowerFunctionExpressionNode

New SqlToLowerFunctionExpressionNode instance.

ToUpper(SqlExpressionNode)

Creates a new SqlToUpperFunctionExpressionNode instance.

[Pure]
public static SqlToUpperFunctionExpressionNode ToUpper(SqlExpressionNode argument)

Parameters

argument SqlExpressionNode

Expression to convert to uppercase.

Returns

SqlToUpperFunctionExpressionNode

New SqlToUpperFunctionExpressionNode instance.

Trim(SqlExpressionNode, SqlExpressionNode?)

Creates a new SqlTrimFunctionExpressionNode instance.

[Pure]
public static SqlTrimFunctionExpressionNode Trim(SqlExpressionNode argument, SqlExpressionNode? characters = null)

Parameters

argument SqlExpressionNode

Expression to trim at both ends.

characters SqlExpressionNode

Optional characters to trim away. Equal to null by default.

Returns

SqlTrimFunctionExpressionNode

New SqlTrimFunctionExpressionNode instance.

TrimEnd(SqlExpressionNode, SqlExpressionNode?)

Creates a new SqlTrimEndFunctionExpressionNode instance.

[Pure]
public static SqlTrimEndFunctionExpressionNode TrimEnd(SqlExpressionNode argument, SqlExpressionNode? characters = null)

Parameters

argument SqlExpressionNode

Expression to trim at the end.

characters SqlExpressionNode

Optional characters to trim away. Equal to null by default.

Returns

SqlTrimEndFunctionExpressionNode

New SqlTrimEndFunctionExpressionNode instance.

TrimStart(SqlExpressionNode, SqlExpressionNode?)

Creates a new SqlTrimStartFunctionExpressionNode instance.

[Pure]
public static SqlTrimStartFunctionExpressionNode TrimStart(SqlExpressionNode argument, SqlExpressionNode? characters = null)

Parameters

argument SqlExpressionNode

Expression to trim at the start.

characters SqlExpressionNode

Optional characters to trim away. Equal to null by default.

Returns

SqlTrimStartFunctionExpressionNode

New SqlTrimStartFunctionExpressionNode instance.

Truncate(SqlExpressionNode, SqlExpressionNode?)

Creates a new SqlTruncateFunctionExpressionNode instance.

[Pure]
public static SqlTruncateFunctionExpressionNode Truncate(SqlExpressionNode argument, SqlExpressionNode? precision = null)

Parameters

argument SqlExpressionNode

Expression to calculate the truncated value from.

precision SqlExpressionNode

Optional decimal precision of the truncation. Equal to null by default.

Returns

SqlTruncateFunctionExpressionNode

New SqlTruncateFunctionExpressionNode instance.