Skip to content

PgFunctionArgument

Namespace: Ankus

Assembly: Ankus.Runtime.dll

Supplies a typed function argument, SQL NULL, or a request for its declared default.

public readonly struct PgFunctionArgument

Supplies an existing typed parameter, including explicit composite descriptors and raw datums.

public static PgFunctionArgument Create(SpiParameter parameter)

Parameters:

parameter — SpiParameter

The parameter to bind.

Returns: PgFunctionArgument

The typed argument.

Supplies a value using its declared managed type. Nullable values preserve SQL NULL.

public static PgFunctionArgument Create<T>(T value)

Type parameters:

T

The managed argument type.

Parameters:

value — T

The argument value.

Returns: PgFunctionArgument

The typed argument.

Requests a declared default using an exact PostgreSQL type identity.

public static PgFunctionArgument Default(uint typeOid)

Parameters:

typeOid — uint

The nonzero catalog type OID.

Returns: PgFunctionArgument

The typed default request.

Requests a declared default, using the managed type to resolve overloaded functions.

public static PgFunctionArgument Default<T>()

Type parameters:

T

The default argument’s expected managed type.

Returns: PgFunctionArgument

The typed default request.

Gets whether this argument requests the function’s declared default expression.

public bool IsDefault { get; }

Value: bool

Gets the PostgreSQL type used to resolve the function, including for NULL and default arguments.

public uint TypeOid { get; }

Value: uint