Manage Buckets

SynxDB Cloud uses object storage (buckets) to persist data. By default, the platform automatically creates and manages these buckets for you, simplifying operations. However, your organization might have specific requirements—such as compliance mandates, security policies, or the need to utilize pre-provisioned resources—that necessitate using buckets created and managed outside of the platform.

The Buckets page in the DBaaS Admin Console is designed specifically to register and manage these Undelegated Buckets. It allows you to integrate your existing cloud storage resources into the SynxDB Cloud ecosystem.

Delegated vs. undelegated buckets

  • Delegated bucket: The lifecycle of these buckets is fully managed by the DBaaS Admin Console. The platform handles their creation, deletion, and overall management.

  • Undelegated bucket: These buckets are created and managed by you, outside of the DBaaS Admin Console (for example, via AWS Console, Azure Portal, or Google Cloud Console). You register them in the DBaaS Admin Console to make them available for use within SynxDB Cloud (for example, when creating Accounts or UnionStores). The DBaaS Admin Console does not manage their lifecycle; deleting them from the console only removes the registration, not the actual bucket or its data.

Access the buckets page

  1. Log into the DBaaS Admin Console.

  2. In the left navigation pane, click Buckets.

View and search for buckets

The Buckets page displays a list of all registered undelegated buckets. For each bucket, the list provides details such as:

  • Name: The name of the bucket.

  • OSS Region: The logical object storage region definition that includes endpoint, region, and path style information.

  • Access Key ID: The access key associated with the bucket.

  • Access Key Secret: The secret key associated with the bucket.

  • Status: The current status of the bucket.

  • Created: The timestamp when the bucket was registered in the platform.

To find a specific bucket, use the filter fields at the top of the page:

  • Name: Enter the bucket name (supports fuzzy search).

  • OSS Region: Select the region from the dropdown list.

  • Status: Enter the status to filter by.

Click Query to apply the filters, or Reset to clear them.

Register an undelegated bucket

If you want to use a bucket that you have already created in your cloud provider, you need to register the bucket in the DBaaS Admin Console as an undelegated bucket.

Prerequisites:

  • The bucket must already exist in your object storage provider.

  • You have the access key ID and access key secret with sufficient permissions to access the bucket.

Usage rules:

  • Exclusive use: A bucket cannot be reused. Once a bucket is assigned to an account or UnionStore, it cannot be used by other resources.

  • Data safety: To prevent data overwriting, ensure that the target prefix in the bucket contains no data. Accounts use the default prefix by default, and UnionStores use the unionstore prefix.

Steps:

  1. On the Buckets page, click + Create Bucket in the upper-right corner.

  2. In the Create Bucket dialog, fill in the following fields:

    • Bucket Name: Enter the exact name of the existing bucket. By entering the name of an existing bucket, you are registering it with the platform.

    • OSS Region: Select the OSS Region definition that matches your bucket’s location and configuration. The OSS Region is a logical definition that stores the endpoint, region, and path style information required to access the bucket.

    • Access Key ID: Enter the Access Key ID for the bucket.

    • Access Key Secret: Enter the Access Key Secret for the bucket.

  3. Click OK to register the bucket.

Note

When creating an account or UnionStore, if you select this bucket, the system will recognize it as an undelegated bucket and will use it directly without attempting to create a new one.

Edit, delete, or test a bucket

In the bucket list, locate the bucket you want to manage and perform one of the following actions in the Operation column:

  • Edit: Click Edit to open a dialog where you can modify the bucket’s configuration details. Click OK to save the changes.

  • Test: Click Test to verify the connectivity to the bucket. This checks whether the platform can successfully access the bucket using the provided credentials.

  • Delete: Click Delete to remove the bucket registration.

Warning

Deleting a bucket configuration from the DBaaS Admin Console removes the registration of the undelegated bucket from the platform. This does not delete the actual bucket or data in your cloud provider, but it will make the bucket unavailable for use within SynxDB Cloud.