Struct DuckDbStatement.Parameter

A formal parameter in a prepared statement from DuckDB.

Implements
Inherited Members
Namespace: Mallard
Assembly: Mallard.dll
Syntax
public readonly struct DuckDbStatement.Parameter : ISettableDuckDbValue
Remarks

The value of the parameter can be set with any of the methods from DuckDbValue.

Properties

| Edit this page View Source

Index

The index/position of this formal parameter within the prepared statement.

Declaration
public int Index { get; }
Property Value
Type Description
int

Index of the parameter, ranging from 1 to the total number of parameters.
| Edit this page View Source

Name

The name of this formal parameter within the prepared statement.

Declaration
public string Name { get; }
Property Value
Type Description
string

The name of the parameter as a string. For positional parameters in the SQL statement, the name is the decimal representation of the ordinal (in ASCII digits, no leading zeros). Note the returned string is not cached.
Exceptions
Type Condition
ObjectDisposedException

The containing prepared statement of this parameter has already been disposed. (Retrieving the name requires querying the native prepared statement object from DuckDB.)
| Edit this page View Source

ValueKind

The DuckDB type of this parameter.

Declaration
public DuckDbValueKind ValueKind { get; }
Property Value
Type Description
DuckDbValueKind

The DuckDB type of value that this parameter accepts.
Exceptions
Type Condition
ObjectDisposedException

The containing prepared statement of this parameter has already been disposed. (This method internally requires querying the native prepared statement object from DuckDB.)

Implements

Extension Methods