Struct ConnectionOptions 

pub struct ConnectionOptions {
    pub attach_remotes: bool,
    pub attach_project: bool,
    pub create_ephemeral_views: bool,
    pub run_migration: bool,
}

Options for creating a database connection.

Controls what gets loaded and attached when opening a connection. Use this for explicit control over connection behavior.

Connection Stages

1. Extensions (always): parquet, icu, scalarfs, duck_hunt
2. Blob resolution (always): S3 credentials, blob_roots macro
3. Migration (optional): Upgrade existing installations to new schema
4. Remotes (optional): Attach remote databases, rebuild remotes.* views
5. Project (optional): Attach project-local database if in a project
6. CWD views (optional): Rebuild cwd.* views for current directory

Fields

attach_remotes: bool

Attach configured remotes (default: true). When true, remote databases are attached and remotes.* views are rebuilt to include the attached data.

attach_project: bool

Attach project database if in a project directory (default: true).

create_ephemeral_views: bool

Rebuild cwd.* views for current working directory (default: true). These views filter main.* data to entries matching the current directory.

run_migration: bool

Run migration for existing installations (default: false). Only enable this for explicit upgrade operations.

Implementations

impl ConnectionOptions

pub fn full() -> Self

Create options for a full connection (default behavior).

pub fn minimal() -> Self

Create options for a minimal connection (no attachments). Useful for write operations that don’t need remote data.

pub fn for_migration() -> Self

Create options for a migration/upgrade connection.

Trait Implementations

impl Clone for ConnectionOptions

fn clone(&self) -> ConnectionOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConnectionOptions

fn default() -> ConnectionOptions

Returns the “default value” for a type.