Skip to main content

S3Config

Struct S3Config 

Source
pub struct S3Config {
    pub region: Option<String>,
    pub endpoint: Option<String>,
    pub addressing_style: AddressingStyle,
    pub allow_http: bool,
    pub access_key_id: Option<String>,
    pub secret_access_key: Option<String>,
    pub session_token: Option<String>,
    pub partitioning: Partitioning,
    pub endpoint_bucket_in_host: BucketInHost,
}
Expand description

Non-secret S3 connection settings. Credentials are pulled from env / the AWS credential chain — see DatasetConfig::resolved_creds.

Fields§

§region: Option<String>§endpoint: Option<String>

Custom endpoint (MinIO, R2, Wasabi, LocalStack, …). Omit for AWS.

§addressing_style: AddressingStyle

virtual (default — bucket.host) or path (host/bucket/). MinIO and most non-AWS providers require path.

§allow_http: bool

Allow plain-HTTP endpoints. Required for local MinIO over http://….

§access_key_id: Option<String>

Inline credentials. Strongly discouraged in production — prefer env vars (see module docs).

§secret_access_key: Option<String>§session_token: Option<String>§partitioning: Partitioning

Hive partition-column handling for parquet sources. Defaults to auto (detect from the path). See Partitioning.

§endpoint_bucket_in_host: BucketInHost

Whether the bucket is folded into a custom endpoint host for virtual-hosted-style requests. Defaults to auto. See BucketInHost.

Implementations§

Source§

impl S3Config

Source

pub fn effective_endpoint(&self, bucket: &str) -> Option<String>

Resolve the endpoint URL to hand to the object store, optionally folding bucket into the host for virtual-hosted-style requests so a plain endpoint works the same way it does on DuckDB.

Returns None when no custom endpoint is configured (AWS default). The bucket is only prepended when it isn’t already the leading host label, so re-running this (or a config that already embeds the bucket) never produces bucket.bucket.host.

Trait Implementations§

Source§

impl Clone for S3Config

Source§

fn clone(&self) -> S3Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for S3Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for S3Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for S3Config

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,