db
db list
List the team's managed databases.
read onlyrepeatable
The team's managed databases, with the region and version of each.
status is the platform's view of provisioning rather than a health check. A
database is connectable once it reports active.
Usage
outplane db listOutput
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
status | string | Only active accepts connections. provisioning means the provider has not finished. One of provisioning, active, failed, deleting. |
version | string | PostgreSQL major version. |
region | string | Fixed at creation. |
size | string | null | The provider's compute unit, such as 0.25-1. Not a platform instance code. |
createdAt | string | null | RFC 3339, UTC. |
Examples
What databases exist
outplane db listSee where each one runs
outplane db list -o textWait for one to finish provisioning
outplane db list --json --fields name,status{
"items": [
{
"name": "orders",
"status": "active"
}
],
"total": 1,
"truncated": false
}What to Know
- Only PostgreSQL is managed. Anything else is run as an application with a volume and is not listed here.
- status is the platform's view of provisioning, not a health check. active means the provider reported it ready.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
3 | auth | Not authenticated, token revoked or expired, or forbidden for this team. |
8 | upstream | The Out Plane API returned a server error. |
The code on the error object is one of context.no_team. Branch on that, or on the exit status. The message is prose and changes.