Skip to main content

Manage Databases

A Database is a logical container pinned to exactly one Capacity Pool. Multiple Databases can share the capacity of one Pool. This page covers creating, listing, and deleting Databases. Each activity can be performed in the console or via the control-plane API.

A Database is a metadata object: creating one allocates a slot on its Pool, and deleting one reclaims that slot. A Database has no mutable fields, so there is no update operation. To change the capacity a Database runs on, scale its Pool instead.

Create a Database​

Create a Database on an existing Pool. The Pool must already exist; the Database is pinned to it for its lifetime and cannot move to another Pool.

  1. Choose the target Capacity Pool and a Database name that is unique within your account.
  2. Create the Database (console, or POST /database/{name} with { "pool_name": "<pool>" }).
  3. Connect a client to the Database through the pool's gateway endpoint. See Connect a client.

The Database name is how clients select it at connection time: the name is the AUTH username, and one connection serves exactly one Database. See Security for the connection credential model.

List and inspect Databases​

List every Database in your account across all Pools (console, or GET /database). Each entry reports the Database name and the name of the Pool it is pinned to. Describe a single Database (GET /database/{name}) to read the same details for one container.

Delete a Database​

Delete removes the Database and frees its slot on the Pool. Deletion is synchronous in the control plane; the underlying resources are reclaimed afterward.

  1. Confirm no client depends on the Database.
  2. Delete the Database (console, or DELETE /database/{name}).
note

A Pool cannot be deleted while any Database is still pinned to it. Delete every Database on a Pool before you delete the Pool.

Isolation between Databases​

Isolation is guaranteed at the Pool boundary, not between Databases that share a Pool. Databases on the same Pool draw from the same capacity and are subject to noisy-neighbor effects from one another. When a workload needs a hard performance boundary, give it its own Pool. See Isolation for the full model.