Manage Architectural Resource Units

This document introduces how to create and manage the following logical architectural unit using the DBaaS Admin Console console:

  • Organizations

  • Organization users

  • Accounts

  • Warehouses

  • Users

Manage organizations

Organizations are the top-level units for resource isolation and administrative control in SynxDB Cloud. Using the DBaaS Admin Console, administrators can create, view, and delete organizations. Each organization can contain multiple accounts.

Access the organizations page

  1. Log into the DBaaS Admin Console.

  2. Click Organizations in the left navigation menu to access the organization page.

This page shows a collapsible tree list of all existing organizations and their corresponding accounts. You can expand any organization node to view its associated accounts, and selecting an organization or account will load its details in the right panel.

Create an organization

  1. Click Create Organization above the organization tree list.

  2. In the Create Organization dialog box, fill in a unique name for the organization.

  3. Click OK to create the organization. The new entry will appear in the organization list.

Delete an organization

Warning

This action is irreversible. Make sure that the organization and its data are no longer needed before proceeding.

  1. Hover over the target organization in the list.

  2. A trash bin icon will appear to the right of the organization name.

  3. Click the icon and confirm the deletion in the pop-up dialog.

Manage account

Accounts are logical resource units within an organization. Each account manages its own compute and storage resources. This section describes how to create, delete, suspend, and resume accounts using the DBaaS Admin Console.

Create an account

  1. Access the Organizations page of the DBaaS Admin Console console.

  2. Under the target organization, click Create Account.

  3. In the Create Account dialog, fill in the required fields, including but not limited to:

    • Name: Enter a unique name for the account.

    • Bucket: Select a bucket for the account’s storage.

      • To use a Delegated Bucket (created by the DBaaS Admin Console), ensure the Undelegated Bucket toggle is turned off.

      • To use an Undelegated Bucket (pre-registered by you), turn on the Undelegated Bucket toggle and select the bucket from the dropdown list.

    • User Name: Create an initial administrator user for the account.

    • FileCleaner (required when Metadata is set to FoundationDB): Select a FileCleaner Profile and enter a FileCleaner Count (1–99). Before you create the account, make sure that a FileCleaner resource specification exists on the Profile page.

    • Catalog Count (required when Metadata is set to FoundationDB): Enter the number of catalog nodes for the account. Deploying multiple catalog nodes improves metadata availability and performance under the FDB backend.

Note

  • To use SynxDB AI Bot - Doc, select UnionStore as the backend service when you create the account. Because of underlying architectural dependencies, AI Bot - Doc does not support accounts running on FoundationDB.

  1. Click OK. The new account appears under the selected organization in the tree view.

Delete an account

Warning

Deleting an account is irreversible. Make sure that the account is no longer in use before proceeding.

  1. Access the Organizations page of the DBaaS Admin Console console.

  2. In the organization tree, locate the target account.

  3. Hover over the account name.

  4. Click the trash bin icon to delete the account.

  5. Confirm the deletion in the pop-up dialog.

Suspend and resume an account

You can suspend a running account to stop its resource consumption, and resume it when needed.

Warning

Suspending an account will make all warehouses within it inaccessible. The web console for this account will also become unavailable.

  1. Access the account detail page. For details, see Access the account detail page.

  2. In the top-right corner of the Account Detail page, click the icon to suspend a running account or resume a suspended account.

Manage warehouses

Warehouses are compute engines within an account that execute queries and process data. Each warehouse can scale horizontally and is associated with a vertical specification. This section describes how to view, create, edit, start/stop, and delete warehouses using the DBaaS Admin Console.

Access the account detail page

  1. Log in to the DBaaS Admin Console.

  2. In the left navigation pane, click Organizations.

  3. In the organization tree, expand the desired organization and click on the target account.

  4. The right-hand side displays Account Detail, including metadata such as:

    • Account Name

    • Cloud

    • Region

    • Metadata

    • Status

  5. At the bottom of this page, use the Warehouses tab to manage compute resources.

View existing warehouses

Click the Warehouses tab in the account detail view. The tab page lists all warehouses under the account with details including:

  • Name

  • Segment Count

  • Status

  • Start/Stop toggle

  • Operation buttons (Edit Warehouses/Delete)

Create a warehouse

  1. On the Warehouses tab, click + Create Warehouse in the top-right corner.

  2. Fill in the fields in the Create Warehouse dialog.

  3. Click OK to create the warehouse.

  4. Return to the Warehouses tab page and wait for a few moments.

  5. Refresh the page until the warehouse status changes to Running.

Start or stop a warehouse

  1. In the Warehouses list, locate the desired warehouse.

  2. Click the toggle in the Start/Stop column to change the warehouse status.

    • Click Stop to stop an active warehouse.

    • Click Start to activate an idle warehouse.

Edit a warehouse

Warehouses can be elastically scaled to meet changing workloads.

  1. Locate the target warehouse and click Edit in the Operation column.

  2. In the Edit Warehouse dialog, update the fields as needed.

  3. Click OK to apply changes. Wait until the update completes.

Manage warehouse privileges

You can authorize specific users to access a warehouse.

  1. In the Warehouses list, click Privilege for the target warehouse.

  2. In the management dialog:

    • Grant User Access: Select a user from the dropdown and click Grant.

    • Authorized User: View the list of users who have access. Click the trash bin icon next to a user to revoke their access.

    • Select All: You can select all users to perform batch operations.

  3. Close the dialog when finished.

Delete a warehouse

Warning

This operation is irreversible. Make sure that the warehouse is not actively used before deleting.

  1. In the Warehouses list, locate the target warehouse.

  2. Click Delete in the Operation column.

  3. Confirm the deletion in the dialog box.

Manage Databases

Databases are the core storage units for organized data. You can view, create, and delete databases within an account using the DBaaS Admin Console.

View existing databases

Click the Databases tab in the account detail view. The tab page lists all databases under the account with details including:

  • OID: Object Identifier.

  • Name: Database name.

  • Owner: The user who owns the database.

  • Operation: Delete option.

Create a database

  1. On the Databases tab, click + Create Database.

  2. In the dialog, enter a Database Name and select an Owner.

  3. Click OK.

Delete a database

Warning

Deleting a database is irreversible and will remove all data contained within it.

  1. Locate the database in the list.

  2. Click Delete.

  3. Confirm the action in the dialog.

Manage tablespaces

Tablespaces allow administrators to define locations in the file system where the files representing database objects can be stored. You can create and manage tablespaces to optimize storage distribution.

View existing tablespaces

Click the Tablespaces tab in the account detail view. The tab page lists all tablespaces under the account with details including OID, Name, Owner, and available operations.

Create a tablespace

  1. Click + Create Tablespaces.

  2. In the dialog, configure the following:

    • Tablespace Name: Enter a unique name.

    • Owner: Select the owner.

    • Bucket: Select the storage bucket.

  3. Click Create.

Note

Creating a tablespace also automatically creates the corresponding Storage Server and Storage User Mapping.

Manage tablespace privileges

You can authorize specific users to access a tablespace.

  1. In the Tablespaces list, click Privilege for the target tablespace.

  2. In the management dialog:

    • Grant User Access: Select a user from the dropdown and click Grant.

    • Authorized User: View and manage the list of users who have been granted access.

  3. Close the dialog when finished.

Delete a tablespace

  1. Locate the tablespace in the list.

  2. Click Delete.

  3. Confirm the deletion.

Manage users

User roles are divided into three types: Organization Administrators, Account Administrators, and Public. Organization Administrators can manage organizations and all their resources. Account Administrators are responsible for managing a specific account. The Public role is assigned to general users with no management permissions. This section explains how to view, create, modify, assign, and delete users under a specific account.

To manage users, first you need to access the account detail page. See Access the account detail page.

View existing users

  1. Click the Users tab at the bottom of the Account Detail view. The user list shows each user’s:

    • User Name

    • Roles (for example, Organization Administrator, Account Administrator, Public)

    • Enabled

    • Locked

    • Operation links: Edit Database User, Reset Password, Delete

  2. Click a user’s name to view more detailed information about that user.

Create a user

  1. On the Users tab plane, click + Create User in the upper-right corner.

  2. In the Create User dialog, fill in the fields:

    • User Name and Password: Set the login credentials.

    • Roles: Toggle switches for Enabled and roles (for example, Organization Administrator) as needed.

  3. Click OK to create the user.

Modify user roles and authorization

  1. Locate the user in the user list and click Edit Database User.

  2. In the dialog, update roles using the dropdown menu.

  3. Click OK to apply changes.

Set default warehouse for a user

You can assign a default warehouse to a user, which will be used for their queries unless a specific warehouse is specified.

  1. Locate the target user in the user list.

  2. Click the More Options icon (three vertical dots) in the Operation column.

  3. Select Set Default Warehouse or Revoke Default Warehouse.

    • Set Default Warehouse: In the dialog, select a warehouse from the dropdown list and click OK.

    • Revoke Default Warehouse: In the confirmation dialog, click OK to remove the default warehouse assignment.

Activate/deactivate or lock/unlock a user

  1. Locate the user in the user list and click Edit Database User.

  2. In the dialog, toggle the Enabled and Locked switches as needed.

  3. Click OK to apply changes.

Delete a user

Warning

Deleting a user will permanently remove their access and all associations.

  1. Locate the target user in the list.

  2. Click Delete in the Operation column.

  3. Confirm the deletion in the popup dialog.

Manage TP Servers

TP Server is a compute resource used for processing transactional workloads. Platform administrators can view, create, and manage TP Server instances under an account through the DBaaS Admin Console.

Access the TP Server list

  1. Log in to the DBaaS Admin Console.

  2. In the left navigation bar, click Organizations.

  3. In the organization tree, expand the target organization and click the target Account.

  4. In the account detail page on the right, select the Resource tab.

  5. Click the TP Servers tab below.

The list displays all TP Server names, status (such as “Running”), and operation options under the account.

Create a TP Server

Note

In the current version, TP server is an experimental feature. Deleting existing TP Servers is not supported. Please exercise caution.

  1. On the TP Servers tab, click + Create TP Server on the right.

  2. In the Create TP Server dialog box, configure the following parameters:

    • Name: Enter a unique identifier name for the TP Server.

    • Owner: Select the owner user of this TP Server from the dropdown list. This is equivalent to the user specified in the SQL syntax CREATE TPSERVER ... OWNER ....

    • *Profile: Select the compute resource specification. Note: Before creating, ensure that resource specification templates for the TpServer component have been configured on the Specification Management page.

  3. Click OK.

The system will begin configuring and starting the TP Server. Once the status changes to Running, the node can be accessed through the Coordinator or used via direct connection. Selecting the owner user for the TP Server is equivalent to executing the SQL syntax CREATE TPSERVER ... OWNER ... to specify the user.

Manage existing TP Servers

In the list, you can manage existing TP Servers:

  • Edit: Click Edit in the operation column to modify the instance’s specification.

Note: The current version does not support deleting existing TP Servers.

To view performance and resource metrics for a TP Server, see Check TP Server metrics.