Managed databases

Inspect managed databases, work with rows, and manage connections and migrations.

list

List managed databases for the active deployment, with their tables and migration status

GET

Usage:

const result = await swirls.client.managedDatabases.list({
  projectId: '...',
})

Input:

schema

Full table + column schema of one managed database, for SQL editor autocomplete

GET

Usage:

const result = await swirls.client.managedDatabases.schema({
  projectId: '...',
  database: '...',
})

Input:

Output:

listRows

Read a page of rows from one table of a managed database (read-only), with optional server-side sort, filter, and search

GET

Usage:

const result = await swirls.client.managedDatabases.listRows({
  projectId: '...',
  database: '...',
  table: '...',
})

Input:

Output:

insertRow

Insert one row into a managed-database table (schema-allowlisted columns)

POST

Usage:

const result = await swirls.client.managedDatabases.insertRow({
  projectId: '...',
  database: '...',
  table: '...',
  fields: {},
})

Input:

updateRow

Patch one row in a managed-database table. Primary-key mutation is refused.

POST

Usage:

const result = await swirls.client.managedDatabases.updateRow({
  projectId: '...',
  database: '...',
  table: '...',
  id: '...',
  fields: {},
})

Input:

deleteRow

Delete one row from a managed-database table by primary key

POST

Usage:

const result = await swirls.client.managedDatabases.deleteRow({
  projectId: '...',
  database: '...',
  table: '...',
  id: '...',
})

Input:

Output:

runQuery

Run a SQL query against a managed database (SQL console). Read-only owner connection.

POST

Usage:

const result = await swirls.client.managedDatabases.runQuery({
  projectId: '...',
  database: '...',
  sql: '...',
})

Input:

Output:

listConnections

List named connections provisioned for a managed database block

GET

Usage:

const result = await swirls.client.managedDatabases.listConnections({
  projectId: '...',
  database: '...',
})

Input:

revealConnection

Reveal the connection string for a managed database connection (requires deployments:write)

POST

Usage:

const result = await swirls.client.managedDatabases.revealConnection({
  projectId: '...',
  database: '...',
  connection: '...',
})

Input:

Output:

rotateConnection

Rotate a managed database connection and return the new connection string

POST

Usage:

const result = await swirls.client.managedDatabases.rotateConnection({
  projectId: '...',
  database: '...',
  connection: '...',
})

Input:

Output:

migrationStatus

Per-database migration detail for the active deployment (status, gate reason, applied and pending data migrations)

GET

Usage:

const result = await swirls.client.managedDatabases.migrationStatus({
  projectId: '...',
})

Input:

approveMigration

Approve a gated managed-database migration, kicking an approved re-run of the migration workflow

POST

Usage:

const result = await swirls.client.managedDatabases.approveMigration({
  projectId: '...',
  database: '...',
})

Input:

Output:

recycle

Replace a managed database with a new empty instance and remove the old instance. Existing data is not copied. Deploy-time migrations recreate the schema on the next deploy.

POST

Usage:

const result = await swirls.client.managedDatabases.recycle({
  projectId: '...',
  database: '...',
})

Input:

Output: