@swamp/gcs-datastore - Swamp Club Extension

Store data in a Google Cloud Storage bucket with local cache synchronization. Provides distributed locking via GCS generation-based preconditions and bidirectional sync between a local cache directory and GCS.

Authentication

Uses Google Cloud Application Default Credentials (ADC) — no credentials in config. Provide credentials via one of:

Environment variable: GOOGLE_APPLICATION_CREDENTIALS pointing to a service account key JSON file
User credentials: gcloud auth application-default login
Attached service account on GCE, Cloud Run, or GKE

Required IAM Permissions

storage.buckets.get
storage.objects.create
storage.objects.get
storage.objects.delete
storage.objects.list

The predefined role roles/storage.objectAdmin covers all of these.

Usage

swamp datastore setup @swamp/gcs-datastore \
  --config '{"bucket": "my-bucket", "prefix": "swamp"}' --json

Field	Type	Required	Description
bucket	string	yes	GCS bucket name
prefix?	string	no	Object name prefix within the bucket
projectId?	string	no	GCP project ID (defaults to ADC project)
apiEndpoint?	string	no	Custom API endpoint URL (for emulators like fake-gcs-server)

Field

Type

Description

bucket

string

GCS bucket name

prefix?

string

Object name prefix within the bucket

projectId?

string

GCP project ID (defaults to ADC project)

apiEndpoint?

string

Custom API endpoint URL (for emulators like fake-gcs-server)

Gcs Datastore

Authentication

Required IAM Permissions

Usage

Config Fields