CloudStorage

Used to set configuration options for a Google Cloud Storage Object Store, which can be used as implementation of an object store.

Requires at least projectId and a bucket to be provided - these will need to be accessible to whichever authentication credentials you use. Authentication is handled via Google’s "Application Default Credentials" - see the relevant documentation to get set up. You will need to set up authentication using any of the methods listed within the documentation to be able to make use of the operations inside the modules.

For more info on setting up the necessary infrastructure on Google Cloud to be able to use Google Cloud Storage as an XTDB object store, see the section on setting up the Google Cloud Deployment Manager Configuration within our Google Cloud docs.

Example usage, as part of a node config:

Xtdb.openNode {
   remoteStorage(
      objectStore = googleCloudStorage(projectId = "xtdb-project", bucket ="xtdb-bucket") {
         prefix = Path.of("my/custom/prefix")
      },
   ),
   ...
}