Struct ClientContext 

pub struct ClientContext { /* private fields */ }

RAII wrapper for a duckdb_client_context.

Provides access to the connection’s catalog, configuration, and file system. Automatically destroyed when dropped.

Implementations

impl ClientContext

pub unsafe fn from_connection( con: duckdb_connection, ) -> Result<Self, ExtensionError>

Obtain a client context from a duckdb_connection.

Errors

Returns ExtensionError if the context cannot be obtained.

Safety

con must be a valid, open duckdb_connection.

pub const unsafe fn from_raw(ctx: duckdb_client_context) -> Self

Wrap a raw duckdb_client_context handle.

Safety

ctx must be a valid, non-null duckdb_client_context.

pub const fn as_raw(&self) -> duckdb_client_context

Returns the raw handle.

pub unsafe fn catalog(&self, name: &CStr) -> Option<Catalog>

Retrieves a database catalog by name.

Pass an empty string to get the default catalog. This function can only be called from within an active transaction (e.g. during a registered function callback).

Safety

Must be called from within an active transaction context.

pub fn config_option(&self, name: &CStr) -> Option<String>

Retrieves a configuration option value by name.

Returns the value as a string, or None if the option does not exist.

pub fn connection_id(&self) -> u64

Returns the connection ID associated with this client context.

Trait Implementations

impl Drop for ClientContext

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.