Out Plane
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 list

Output

FieldTypeDescription
idstring
namestring
statusstringOnly active accepts connections. provisioning means the provider has not finished. One of provisioning, active, failed, deleting.
versionstringPostgreSQL major version.
regionstringFixed at creation.
sizestring | nullThe provider's compute unit, such as 0.25-1. Not a platform instance code.
createdAtstring | nullRFC 3339, UTC.

Examples

What databases exist

outplane db list

See where each one runs

outplane db list -o text

Wait 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:

ExitKindMeaning
2usageInvalid arguments, unknown flag, or client-side validation failure.
3authNot authenticated, token revoked or expired, or forbidden for this team.
8upstreamThe 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.

On this page