Struct ClientBuilder

pub struct ClientBuilder { /* private fields */ }

A ClientBuilder can be used to create a Client with custom configuration.

For more information on creating a duckdb connection, see the duckdb docs.

Examples

let client = ClientBuilder::new().path("path/to/db.duckdb").open().await?;

// ...

client.close().await?;

Implementations

impl ClientBuilder

pub fn new() -> Self

Returns a new ClientBuilder with the default settings.

pub fn path<P: AsRef<Path>>(self, path: P) -> Self

Specify the path of the duckdb database to open.

By default, an in-memory database is used.

pub fn flagsfn(self, flags: fn() -> Result<Config>) -> Self

Specify the [OpenFlags] to use when opening a new connection.

By default, [OpenFlags::default()] is used.

pub async fn open(self) -> Result<Client, Error>

Returns a new Client that uses the ClientBuilder configuration.

Examples

let client = ClientBuilder::new().open().await?;

pub fn open_blocking(self) -> Result<Client, Error>

Returns a new Client that uses the ClientBuilder configuration, blocking the current thread.

Examples

let client = ClientBuilder::new().open_blocking()?;

Trait Implementations

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.