Struct RemoteConfig 

pub struct RemoteConfig {
    pub name: String,
    pub remote_type: RemoteType,
    pub uri: String,
    pub mode: RemoteMode,
    pub credential_provider: Option<String>,
    pub auto_attach: bool,
}

Configuration for a remote storage location.

Fields

name: String

Remote name (used as schema name: remote_{name})

remote_type: RemoteType

Type of remote storage

uri: String

URI for the remote (e.g., s3://bucket/path/bird.duckdb, md:database_name)

mode: RemoteMode

Access mode (read_write or read_only)

credential_provider: Option<String>

Credential provider for S3 (e.g., “credential_chain”, “config”)

auto_attach: bool

Whether to auto-attach on connection open

Implementations

impl RemoteConfig

pub fn new( name: impl Into<String>, remote_type: RemoteType, uri: impl Into<String>, ) -> Self

Create a new remote config.

pub fn read_only(self) -> Self

Set read-only mode.

pub fn schema_name(&self) -> String

Get the DuckDB schema name for this remote.

pub fn quoted_schema_name(&self) -> String

Get the quoted DuckDB schema name for this remote (for use in SQL).

pub fn attach_sql(&self) -> String

Generate the ATTACH SQL statement for this remote.

pub fn blob_base_url(&self) -> Option<String>

Get the base URL for blob storage (for S3/GCS remotes).

pub fn data_dir(&self) -> Option<PathBuf>

Get the data directory for file remotes.

For a remote URI like file:///path/to/db/bird.duckdb, returns /path/to/db/data. This is needed so parquet-mode remotes can resolve their relative file paths.

Trait Implementations

impl Clone for RemoteConfig

fn clone(&self) -> RemoteConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoteConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RemoteConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RemoteConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.