Class DuckDbStructColumns

Provides type information on a structure type in DuckDB.

Inheritance

object

DuckDbStructColumns

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Mallard

Assembly: Mallard.dll

Syntax

public sealed class DuckDbStructColumns : IDisposable

Remarks

Some information may be retrieved on-demand from DuckDB. Thus this class holds a native resource (handle to a DuckDB logical type) and is disposable.

Properties

ColumnCount

The number of top-level columns present in the results.

Declaration

public int ColumnCount { get; }

Property Value

Type	Description
int

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

~DuckDbStructColumns()

Declaration

protected ~DuckDbStructColumns()

GetColumnInfo(int)

Get information about a column in the results.

Declaration

public DuckDbColumnInfo GetColumnInfo(int columnIndex)

Parameters

Type	Name	Description
int	columnIndex	The index of the column, between 0 (inclusive) to Mallard.IResultColumns.ColumnCount (exclusive).

Returns

Type	Description
DuckDbColumnInfo

GetColumnName(int)

Get the name of a column given its index.

Declaration

public string GetColumnName(int columnIndex)

Parameters

Type	Name	Description
int	columnIndex	The index of the column, from 0 (inclusive) to Mallard.IResultColumns.ColumnCount (exclusive).

Returns

Type	Description
string	The name of the column, or the empty string if the column has no name.

GetDataTypeName()

Get the name of the structure type in the DuckDB database.

Declaration

public string GetDataTypeName()

Returns

Type	Description
string	The name of the STRUCT type, if it has been defined in DuckDB, or the empty string if it is anonymous.

Implements

IDisposable