Version: 2.0.0

S3Location

class

class S3Location(
    bucket: S3BucketSpec,
    region: AwsRegionSpec,
    credentials: AwsAccessSecretKey,
    base_path: CloudRelativePathSpec = '/',
    cfg: CfgSpec | None = None,
)

Bases: CloudLocation

Categories: destination

S3 staging area for ClickHouseDest.

The plugin lands parquet in this bucket, then references the object via ClickHouse's s3() table function to ingest it.

Parameters

parameter

bucketS3BucketSpec (str | Secret)

A valid S3 bucket name.

parameter

regionAwsRegionSpec (str | Secret)

A valid AWS region, e.g. us-east-1.

parameter

credentialsAwsAccessSecretKey

AWS access-key / secret-key credentials.

parameter

base_pathCloudRelativePathSpec (str | Secret)

Object-key prefix from the bucket root; starts with /, has no trailing / and no empty segments (//) (the leading / is trimmed when forming the key). Defaults to /.

parameter

cfgCfgSpec | None (dict | None)

Optional connector-config dict for the S3 client.

#

Parameters​

#

#

#

#

#

Parameters