Version: 2.0.0

GCSLocation

class

class GCSLocation(
    bucket: GCSBucketSpec,
    credentials: GCPJson,
    hmac_credentials: GCPHmac,
    base_path: CloudRelativePathSpec = '/',
    cfg: CfgSpec | None = None,
)

Bases: CloudLocation

Categories: destination

GCS staging area for ClickHouseDest.

Carries two credentials, one per code path: credentials (GCP service-account JSON) uploads parquet via the native GCS API, while hmac_credentials (GCS HMAC keys) let ClickHouse's s3() table function fetch the staged file back through the S3-compatible endpoint (the only protocol ClickHouse speaks to GCS). Both are required.

Parameters

parameter

bucketGCSBucketSpec (str | Secret)

A valid GCS bucket name.

parameter

credentialsGCPJson

GCP service-account JSON credentials (upload).

parameter

hmac_credentialsGCPHmac

GCS HMAC access-key / secret-key credentials (ClickHouse's S3-compatible read-back).

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 GCS client.

#

Parameters​

#

#

#

#

#

Parameters