stratumctl db
Stratum Database: managed PostgreSQL
stratumctl db [flags]Subcommands
Section titled “Subcommands”stratumctl db blue-green-deployments: Blue/green deployments: a major upgrade, class or parameter change with seconds of downtime and a rollbackstratumctl db engine-versions: List the published engine versions (operators:engine-versions publish)stratumctl db instance-classes: List the database instance classesstratumctl db instances: Database instancesstratumctl db parameter-groups: DB parameter groups: engine configurationstratumctl db snapshots: Database snapshots: consistent points of an instance (manual and automated)stratumctl db subnet-groups: DB subnet groups: the subnets an instance may live in
stratumctl db blue-green-deployments
Section titled “stratumctl db blue-green-deployments”Blue/green deployments: a major upgrade, class or parameter change with seconds of downtime and a rollback
stratumctl db blue-green-deployments [flags]Aliases: blue-green, bg
Subcommands
Section titled “Subcommands”stratumctl db blue-green-deployments create: Build a green copy of an instance at a target version, class or parametersstratumctl db blue-green-deployments delete: Abandon a deployment (before the switchover), or retire the former blue now (after it)stratumctl db blue-green-deployments get: Describe a blue/green deploymentstratumctl db blue-green-deployments list: List an instance’s blue/green deploymentsstratumctl db blue-green-deployments rollback: Return the endpoint to the former blue after a switchover (green’s writes since are lost)stratumctl db blue-green-deployments switchover: Switch the instance over to green (seconds of downtime)
stratumctl db blue-green-deployments create
Section titled “stratumctl db blue-green-deployments create”Build a green copy of an instance at a target version, class or parameters
stratumctl db blue-green-deployments create <db-instance-id> [flags]Records a blue/green deployment (202, “provisioning”). The reconciler renders wal_level = logical for the instance’s engine (a static parameter: the deployment is “pending-reboot” until the engine restarts in its maintenance window, or at once with –apply-immediately), checks the engine’s preconditions and reports them on the deployment (every table needs a primary key or replica identity; no large objects re-checked every pass until clean), creates a publication and one logical slot per database, takes a base snapshot, and builds GREEN as a restore of it at the target: a real instance in the project (“<name>-green”, its own endpoint, the same master credential) that subscribes to the instance and streams every write since. A major upgrade runs pg_upgrade on green before it starts. “replicating” while the lag is above the threshold, “available” under it — then “switchover”.
While the deployment lives the instance’s class, version, storage, parameter group, Multi-AZ, deletion and credential rotation are refused; tags, windows, security groups and retention still apply.
Examples
Section titled “Examples”stratumctl db blue-green-deployments create db-3k8m2x7q9a --engine-version 17 --apply-immediatelystratumctl db blue-green-deployments create db-3k8m2x7q9a --instance-class db.m1.large| Flag | Type | Default | Description |
|---|---|---|---|
--allocated-storage |
int | 0 |
Target storage in GiB (never smaller) |
--apply-immediately |
bool | false |
Restart the instance’s engine now for wal_level = logical instead of waiting for the maintenance window |
--blue-retention-days |
int | 7 |
How long the former blue is kept read-only after the switchover (1..30) |
--engine-version |
string | Target engine version: a published version of the same or a newer major (a bare major resolves to its newest minor) | |
--instance-class |
string | Target instance class | |
--lag-threshold-bytes |
int64 | 16777216 |
Green counts as available at or under this lag; the switchover refuses above it |
--parameter-group |
string | Target parameter group (of the target’s family; a major upgrade defaults to the family’s default group) | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--storage-class |
string | Target storage class | |
--tag |
stringToString | Tags (key=value, repeatable) |
stratumctl db blue-green-deployments delete
Section titled “stratumctl db blue-green-deployments delete”Abandon a deployment (before the switchover), or retire the former blue now (after it)
stratumctl db blue-green-deployments delete <db-instance-id> <deployment-id> [flags]Examples
Section titled “Examples”stratumctl db blue-green-deployments delete db-3k8m2x7q9a bg-5k8m2x7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db blue-green-deployments get
Section titled “stratumctl db blue-green-deployments get”Describe a blue/green deployment
stratumctl db blue-green-deployments get <db-instance-id> <deployment-id> [flags]Examples
Section titled “Examples”stratumctl db blue-green-deployments get db-3k8m2x7q9a bg-5k8m2x7q9astratumctl db blue-green-deployments get db-3k8m2x7q9a bg-5k8m2x7q9a --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db blue-green-deployments list
Section titled “stratumctl db blue-green-deployments list”List an instance’s blue/green deployments
stratumctl db blue-green-deployments list <db-instance-id> [flags]Examples
Section titled “Examples”stratumctl db blue-green-deployments list db-3k8m2x7q9astratumctl db blue-green-deployments list db-3k8m2x7q9a --output json| Flag | Type | Default | Description |
|---|---|---|---|
--limit |
int | 0 |
Page size; setting it (or –page-token) returns one page and prints the next token instead of listing everything |
--page-token |
string | Cursor from a previous page; returns that one page | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db blue-green-deployments rollback
Section titled “stratumctl db blue-green-deployments rollback”Return the endpoint to the former blue after a switchover (green’s writes since are lost)
stratumctl db blue-green-deployments rollback <db-instance-id> <deployment-id> [flags]Within the retention: the endpoint address goes back to the former blue’s engine and the rows swap back — the instance is what it was before the switchover, writable again — WITH THE LOSS OF EVERY WRITE GREEN ACCEPTED SINCE THE SWITCHOVER (there is no reverse replication across a major; those writes are in green’s final snapshot, “<deployment>-green-final”, and nowhere else). The deployment reads “rolled-back”; green is torn down.
Examples
Section titled “Examples”stratumctl db blue-green-deployments rollback db-3k8m2x7q9a bg-5k8m2x7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db blue-green-deployments switchover
Section titled “stratumctl db blue-green-deployments switchover”Switch the instance over to green (seconds of downtime)
stratumctl db blue-green-deployments switchover <db-instance-id> <deployment-id> [flags]The reconciler fences the instance (no client network, read-only, every client session terminated), waits for green to apply everything up to the fence point (bounded by –timeout-seconds; past it the instance is unfenced and the deployment reports “switchover-failed” with nothing moved), copies the sequence values to green, drops its subscriptions, and moves the instance’s endpoint address to green’s engine — the DNS name, the id, the master credential do not change; the engine, class, storage, parameters, snapshots and backups are green’s from here on. The former blue is retained read-only as “<name>-old” for the retention, for “rollback”. Refused unless the deployment is available, the lag under the threshold, and the instance available and idle.
Examples
Section titled “Examples”stratumctl db blue-green-deployments switchover db-3k8m2x7q9a bg-5k8m2x7q9astratumctl db blue-green-deployments switchover db-3k8m2x7q9a bg-5k8m2x7q9a --timeout-seconds 120| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--timeout-seconds |
int | 300 |
How long the fence and the catch-up may take (30..3600) |
stratumctl db engine-versions
Section titled “stratumctl db engine-versions”List the published engine versions (operators: engine-versions publish)
stratumctl db engine-versions [flags]Examples
Section titled “Examples”stratumctl db engine-versionsstratumctl db engine-versions --engine postgres --output json| Flag | Type | Default | Description |
|---|---|---|---|
--engine |
string | Filter by engine |
Subcommands
Section titled “Subcommands”stratumctl db engine-versions publish: Publish an engine image as an engine version (operator,)
stratumctl db engine-versions publish
Section titled “stratumctl db engine-versions publish”Publish an engine image as an engine version (operator,)
stratumctl db engine-versions publish <major.minor> [flags]Records that an image built from the db-postgres-<major> operator recipe is the engine for <major.minor>. The image must be launchable from p-system-db. The db reconciler then makes the launch templates on demand, and instances created with a bare major resolve to the newest published minor.
Examples
Section titled “Examples”stratumctl db engine-versions publish 17.2 --image img-k3m9x2abqtstratumctl db engine-versions publish 16.4 --image img-5k8m2x7q9a --status deprecated| Flag | Type | Default | Description |
|---|---|---|---|
--engine |
string | postgres |
Engine |
--image |
string | Engine image id (required) | |
--status |
string | available (default) | deprecated |
stratumctl db instance-classes
Section titled “stratumctl db instance-classes”List the database instance classes
stratumctl db instance-classes [flags]Examples
Section titled “Examples”stratumctl db instance-classesstratumctl db instance-classes --output jsonstratumctl db instances
Section titled “stratumctl db instances”Database instances
stratumctl db instances [flags]Aliases: instance
Subcommands
Section titled “Subcommands”stratumctl db instances apply-pending-maintenance: Opt in to the instance’s pending maintenancestratumctl db instances create: Create a database instance (returns 202; the reconciler provisions it)stratumctl db instances delete: Delete a database instance (a final snapshot is taken unless skipped)stratumctl db instances describe: Describe a database instancestratumctl db instances failover: Fail a Multi-AZ instance over to its standbystratumctl db instances list: List database instancesstratumctl db instances modify: Modify a database instance (disruptive changes queue as pending values)stratumctl db instances reboot: Restart the enginestratumctl db instances restore-to-point-in-time: Restore an instance to a time in its recovery window, as a NEW instance (returns 202)stratumctl db instances rotate-master-credential: Rotate the master password now (the secret’s db_master schedule is marked due;)
stratumctl db instances apply-pending-maintenance
Section titled “stratumctl db instances apply-pending-maintenance”Opt in to the instance’s pending maintenance
stratumctl db instances apply-pending-maintenance <db-instance-id> [flags]Records a choice on the instance’s pending maintenance actions (a newer minor of its major, a newer engine image behind its version — see “db instances get”). –opt-in immediate applies them on the reconciler’s next pass, the instance “upgrading” meanwhile; next-maintenance applies them in the next maintenance window even with auto minor version upgrade off; undo-opt-in withdraws a choice not yet applied. Single-AZ = one engine VM replacement on the same volume and endpoint; Multi-AZ = the standby first, one planned switchover, then the vacated slot.
Examples
Section titled “Examples”stratumctl db instances apply-pending-maintenance db-3k8m2x7q9astratumctl db instances apply-pending-maintenance db-3k8m2x7q9a --opt-in next-maintenance| Flag | Type | Default | Description |
|---|---|---|---|
--opt-in |
string | immediate |
immediate | next-maintenance | undo-opt-in |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db instances create
Section titled “stratumctl db instances create”Create a database instance (returns 202; the reconciler provisions it)
stratumctl db instances create <name> [flags]Creates a database instance; the reconciler provisions it (202).
The master password lands in the instance’s master secret (db/<name>/master) either way. A password you give (–master-password-file, STRATUM_DB_MASTER_PASSWORD or the prompt) is yours and is never rotated automatically: rotate it with “stratumctl db instances rotate-master-credential”, or on a schedule you set with “stratumctl secrets rotation set <secret-id> –type db_master –target <db-instance-id> –cron…”. With –generate-master-password the service generates the password and rotates it monthly; read it from the secret (“stratumctl secrets get-value <secret-id>”).
Examples
Section titled “Examples”stratumctl db instances create app --engine-version 16 --class db.m1.small --subnet-group app-subnets \ --master-username app_admin --generate-master-passwordstratumctl db instances create app --engine-version 16.4 --class db.m1.large --subnet-group app-subnets \ --master-username app_admin --master-password-file./pw.txt --storage 100 --multi-az --security-group sg-3f8d2k9x| Flag | Type | Default | Description |
|---|---|---|---|
--availability-zone |
string | Pin the primary to an availability zone of the subnet group | |
--backup-retention |
int | 0 |
Backup retention in days (1..35) |
--backup-window |
string | Preferred backup window HH:MM-HH:MM (UTC) | |
--class |
string | Instance class, e.g. db.m1.small (required) | |
--deletion-protection |
bool | false |
Refuse deletes until cleared |
--engine |
string | postgres |
Engine |
--engine-version |
string | Engine version: a major (16) or major.minor (16.4) (required) | |
--extensions |
stringSlice | Curated extensions to create in every database, e.g. pg_stat_statements (comma-separated or repeatable; see stratumctl db engine-versions list) |
|
--generate-master-password |
bool | false |
Let the service generate the master password into the instance’s secret and rotate it monthly (no password is read) |
--maintenance-window |
string | Preferred maintenance window ddd:HH:MM-ddd:HH:MM (UTC) | |
--master-password-file |
string | File holding the master password (or - for stdin); else STRATUM_DB_MASTER_PASSWORD or a prompt. Never rotated automatically | |
--master-username |
string | Master username (required) | |
--max-storage |
int | 0 |
Storage autoscaling ceiling in GiB |
--multi-az |
bool | false |
Standby in a second availability zone |
--no-auto-minor-upgrade |
bool | false |
Do not apply minor versions in the maintenance window |
--parameter-group |
string | DB parameter group name (default: the family default) | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--security-group |
stringArray | Security group id (repeatable) | |
--storage |
int | 20 |
Allocated storage in GiB |
--storage-class |
string | Storage class (default: the cluster default) | |
--subnet-group |
string | DB subnet group name (required) | |
--tag |
stringArray | Tag key=value (repeatable) |
stratumctl db instances delete
Section titled “stratumctl db instances delete”Delete a database instance (a final snapshot is taken unless skipped)
stratumctl db instances delete <db-instance-id> [flags]Examples
Section titled “Examples”stratumctl db instances delete db-3k8m2x7q9a --final-snapshot-name app-finalstratumctl db instances delete db-3k8m2x7q9a --skip-final-snapshot| Flag | Type | Default | Description |
|---|---|---|---|
--final-snapshot-name |
string | Name for the final snapshot (default: <name>-final-<timestamp>) | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--skip-final-snapshot |
bool | false |
Delete without a final snapshot |
stratumctl db instances describe
Section titled “stratumctl db instances describe”Describe a database instance
stratumctl db instances describe <db-instance-id> [flags]Aliases: get
Examples
Section titled “Examples”stratumctl db instances describe db-3k8m2x7q9astratumctl db instances describe db-3k8m2x7q9a --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db instances failover
Section titled “stratumctl db instances failover”Fail a Multi-AZ instance over to its standby
stratumctl db instances failover <db-instance-id> [flags]A planned switchover: the instance goes “failing-over”, the reconciler stops the primary cleanly (the fence), promotes the standby, moves the endpoint address to it and swaps the members — seconds, one client reconnect — then rebuilds the old primary’s side as the new standby (“Multi-AZ: degraded” until it streams again, then “synced”). Refused (409) unless the instance is available and its pair synced: a standby that is not synced may lack commits and is never promoted on request.
Examples
Section titled “Examples”stratumctl db instances failover db-3k8m2x7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db instances list
Section titled “stratumctl db instances list”List database instances
stratumctl db instances list [flags]Examples
Section titled “Examples”stratumctl db instances liststratumctl db instances list --output json| Flag | Type | Default | Description |
|---|---|---|---|
--limit |
int | 0 |
Page size; setting it (or –page-token) returns one page and prints the next token instead of listing everything |
--page-token |
string | Cursor from a previous page; returns that one page | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db instances modify
Section titled “stratumctl db instances modify”Modify a database instance (disruptive changes queue as pending values)
stratumctl db instances modify <db-instance-id> [flags]Examples
Section titled “Examples”stratumctl db instances modify db-3k8m2x7q9a --storage 200stratumctl db instances modify db-3k8m2x7q9a --class db.m1.large --apply-immediatelystratumctl db instances modify db-3k8m2x7q9a --extensions pg_stat_statements,pgstattuple| Flag | Type | Default | Description |
|---|---|---|---|
--apply-immediately |
bool | false |
Apply every pending disruptive change now (this request’s, the ones already pending, a static parameter waiting for a restart) instead of in the maintenance window |
--auto-minor-upgrade |
bool | true |
Keep the instance current: minor versions AND rebuilt engine images apply in the maintenance window (off = listed under Maintenance, wait for apply-pending-maintenance) |
--backup-retention |
int | 0 |
Backup retention in days (1..35) |
--backup-window |
string | Preferred backup window HH:MM-HH:MM (UTC) | |
--class |
string | Instance class (pending until applied) | |
--clear-max-storage |
bool | false |
Turn storage autoscaling off |
--deletion-protection |
bool | false |
Refuse deletes until cleared |
--engine-version |
string | Minor version within the same major (a major change is a blue/green deployment) | |
--extensions |
stringSlice | Replace the curated extension set (comma-separated; empty string removes them all — a drop something depends on is refused) | |
--maintenance-window |
string | Preferred maintenance window ddd:HH:MM-ddd:HH:MM (UTC) | |
--max-storage |
int | 0 |
Storage autoscaling ceiling in GiB |
--multi-az |
bool | false |
Add or remove the standby (pending until applied) |
--parameter-group |
string | DB parameter group name | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--security-group |
stringArray | Security group id (repeatable; replaces the set) | |
--storage |
int | 0 |
Allocated storage in GiB (grow only) |
--tag |
stringArray | Tag key=value (repeatable; replaces the set) |
stratumctl db instances reboot
Section titled “stratumctl db instances reboot”Restart the engine
stratumctl db instances reboot <db-instance-id> [flags]Restarts the engine in place: the instance goes “rebooting”, the agent restarts postgres — seconds of downtime, the VM and the data volume untouched — and the instance is “available” again once it accepts connections. A static parameter waiting for a restart (parameterApplyStatus pending-reboot) applies with it. –failover reboots a Multi-AZ instance through a planned failover instead (the same operation as “db instances failover”: the standby takes over, the old primary is rebuilt).
Examples
Section titled “Examples”stratumctl db instances reboot db-3k8m2x7q9astratumctl db instances reboot db-3k8m2x7q9a --failover| Flag | Type | Default | Description |
|---|---|---|---|
--failover |
bool | false |
Reboot through a planned failover (Multi-AZ only) |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db instances restore-to-point-in-time
Section titled “stratumctl db instances restore-to-point-in-time”Restore an instance to a time in its recovery window, as a NEW instance (returns 202)
stratumctl db instances restore-to-point-in-time <db-instance-id> [flags]Examples
Section titled “Examples”stratumctl db instances restore-to-point-in-time db-3k8m2x7q9a --name app-at-noon --target-time 2026-09-22T12:00:00Zstratumctl db instances restore-to-point-in-time db-3k8m2x7q9a --name app-latest| Flag | Type | Default | Description |
|---|---|---|---|
--availability-zone |
string | Availability zone | |
--class |
string | Instance class for the new instance (default: the snapshot’s) | |
--name |
string | Name of the new instance (required) | |
--parameter-group |
string | DB parameter group (default: the snapshot’s) | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--security-group |
stringArray | VPC security group id for the endpoint (repeatable) | |
--storage |
int | 0 |
Allocated storage in GiB (default: the snapshot’s; never smaller) |
--subnet-group |
string | DB subnet group (default: the snapshot’s) | |
--tag |
stringArray | Tag key=value (repeatable) | |
--target-time |
string | RFC 3339 time to replay to (default: latestRestorableTime) |
stratumctl db instances rotate-master-credential
Section titled “stratumctl db instances rotate-master-credential”Rotate the master password now (the secret’s db_master schedule is marked due;)
stratumctl db instances rotate-master-credential <db-instance-id> [flags]Marks the instance’s master secret due for rotation. The next secrets pass stages a new password as the secret’s PENDING version, the engine applies it through its agent and the version is promoted to CURRENT once the engine confirms; masterUserSecret.status reads “rotating” until then. The old password stops working the moment the engine applies the new one — read the secret at connect time.
A password the service generated rotates monthly on its own; the schedule’s cron is yours to change with “stratumctl secrets rotation set”. A password you supplied at create is never rotated automatically: this command rotates it once (the service makes a schedule for this rotation and withdraws it afterwards), and “stratumctl secrets rotation set <secret-id> –type db_master –target <db-instance-id> –cron…” puts it on a schedule.
Examples
Section titled “Examples”stratumctl db instances rotate-master-credential db-3k8m2x7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db parameter-groups
Section titled “stratumctl db parameter-groups”DB parameter groups: engine configuration
stratumctl db parameter-groups [flags]Aliases: parameter-group, pg
Subcommands
Section titled “Subcommands”stratumctl db parameter-groups create: Create a DB parameter group at the family defaultsstratumctl db parameter-groups delete: Delete a DB parameter group (refused for defaults and while in use)stratumctl db parameter-groups describe: Describe a DB parameter groupstratumctl db parameter-groups list: List DB parameter groups (the family defaults appear on first use)stratumctl db parameter-groups parameters: List a parameter group’s parametersstratumctl db parameter-groups reset: Reset every parameter of a group to the family defaultstratumctl db parameter-groups set-parameters: Set parameters on a parameter group (–param name=value, repeatable)stratumctl db parameter-groups update: Update a DB parameter group’s description or tags
stratumctl db parameter-groups create
Section titled “stratumctl db parameter-groups create”Create a DB parameter group at the family defaults
stratumctl db parameter-groups create <name> [flags]Examples
Section titled “Examples”stratumctl db parameter-groups create app-pg16 --family postgres16stratumctl db parameter-groups create app-pg16 --family postgres16 --description "app tuning" --tag env=prod| Flag | Type | Default | Description |
|---|---|---|---|
--description |
string | Description | |
--family |
string | Parameter family, e.g. postgres16 (required) | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--tag |
stringArray | Tag key=value (repeatable) |
stratumctl db parameter-groups delete
Section titled “stratumctl db parameter-groups delete”Delete a DB parameter group (refused for defaults and while in use)
stratumctl db parameter-groups delete <name> [flags]Examples
Section titled “Examples”stratumctl db parameter-groups delete app-pg16| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db parameter-groups describe
Section titled “stratumctl db parameter-groups describe”Describe a DB parameter group
stratumctl db parameter-groups describe <name> [flags]Aliases: get
Examples
Section titled “Examples”stratumctl db parameter-groups describe app-pg16stratumctl db parameter-groups describe app-pg16 --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db parameter-groups list
Section titled “stratumctl db parameter-groups list”List DB parameter groups (the family defaults appear on first use)
stratumctl db parameter-groups list [flags]Examples
Section titled “Examples”stratumctl db parameter-groups liststratumctl db parameter-groups list --output json| Flag | Type | Default | Description |
|---|---|---|---|
--limit |
int | 0 |
Page size; setting it (or –page-token) returns one page and prints the next token instead of listing everything |
--page-token |
string | Cursor from a previous page; returns that one page | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db parameter-groups parameters
Section titled “stratumctl db parameter-groups parameters”List a parameter group’s parameters
stratumctl db parameter-groups parameters <name> [flags]Examples
Section titled “Examples”stratumctl db parameter-groups parameters app-pg16stratumctl db parameter-groups parameters app-pg16 --changed| Flag | Type | Default | Description |
|---|---|---|---|
--changed |
bool | false |
Only parameters set by a user |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db parameter-groups reset
Section titled “stratumctl db parameter-groups reset”Reset every parameter of a group to the family default
stratumctl db parameter-groups reset <name> [flags]Examples
Section titled “Examples”stratumctl db parameter-groups reset app-pg16| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db parameter-groups set-parameters
Section titled “stratumctl db parameter-groups set-parameters”Set parameters on a parameter group (–param name=value, repeatable)
stratumctl db parameter-groups set-parameters <name> [flags]Examples
Section titled “Examples”stratumctl db parameter-groups set-parameters app-pg16 --param log_min_duration_statement=250stratumctl db parameter-groups set-parameters app-pg16 --param max_connections=300 --pending-reboot| Flag | Type | Default | Description |
|---|---|---|---|
--param |
stringArray | Parameter name=value (repeatable, required) | |
--pending-reboot |
bool | false |
Apply at the next reboot (required for static parameters) |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db parameter-groups update
Section titled “stratumctl db parameter-groups update”Update a DB parameter group’s description or tags
stratumctl db parameter-groups update <name> [flags]Examples
Section titled “Examples”stratumctl db parameter-groups update app-pg16 --description "app tuning, v2"stratumctl db parameter-groups update app-pg16 --tag env=prod --tag team=a| Flag | Type | Default | Description |
|---|---|---|---|
--description |
string | Description | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--tag |
stringArray | Tag key=value (repeatable; replaces the set) |
stratumctl db snapshots
Section titled “stratumctl db snapshots”Database snapshots: consistent points of an instance (manual and automated)
stratumctl db snapshots [flags]Aliases: snapshot
Subcommands
Section titled “Subcommands”stratumctl db snapshots create: Take a manual snapshot of an instance (returns 202; the reconciler takes it on the live engine)stratumctl db snapshots delete: Delete a manual snapshot (automated ones expire with the retention)stratumctl db snapshots describe: Describe a database snapshotstratumctl db snapshots list: List database snapshotsstratumctl db snapshots restore: Restore a snapshot into a NEW instance (returns 202; the engine replays to the snapshot’s point before it serves)
stratumctl db snapshots create
Section titled “stratumctl db snapshots create”Take a manual snapshot of an instance (returns 202; the reconciler takes it on the live engine)
stratumctl db snapshots create <name> [flags]Examples
Section titled “Examples”stratumctl db snapshots create before-migration --instance db-3k8m2x7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--instance |
string | The instance to snapshot (db-…, required) | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--tag |
stringArray | Tag key=value (repeatable) |
stratumctl db snapshots delete
Section titled “stratumctl db snapshots delete”Delete a manual snapshot (automated ones expire with the retention)
stratumctl db snapshots delete <snapshot-id> [flags]Examples
Section titled “Examples”stratumctl db snapshots delete dbsnap-5k8m2x7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db snapshots describe
Section titled “stratumctl db snapshots describe”Describe a database snapshot
stratumctl db snapshots describe <snapshot-id> [flags]Aliases: get
Examples
Section titled “Examples”stratumctl db snapshots describe dbsnap-5k8m2x7q9astratumctl db snapshots describe dbsnap-5k8m2x7q9a --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db snapshots list
Section titled “stratumctl db snapshots list”List database snapshots
stratumctl db snapshots list [flags]Examples
Section titled “Examples”stratumctl db snapshots liststratumctl db snapshots list --instance db-3k8m2x7q9a --type manual| Flag | Type | Default | Description |
|---|---|---|---|
--instance |
string | Only one instance’s snapshots (db-…) | |
--limit |
int | 0 |
Page size; setting it (or –page-token) returns one page and prints the next token instead of listing everything |
--page-token |
string | Cursor from a previous page; returns that one page | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--type |
string | Only manual or automated |
stratumctl db snapshots restore
Section titled “stratumctl db snapshots restore”Restore a snapshot into a NEW instance (returns 202; the engine replays to the snapshot’s point before it serves)
stratumctl db snapshots restore <snapshot-id> [flags]Examples
Section titled “Examples”stratumctl db snapshots restore dbsnap-5k8m2x7q9a --name app-copystratumctl db snapshots restore dbsnap-5k8m2x7q9a --name app-copy --class db.m1.large --storage 100| Flag | Type | Default | Description |
|---|---|---|---|
--availability-zone |
string | Availability zone | |
--class |
string | Instance class for the new instance (default: the snapshot’s) | |
--name |
string | Name of the new instance (required) | |
--parameter-group |
string | DB parameter group (default: the snapshot’s) | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--security-group |
stringArray | VPC security group id for the endpoint (repeatable) | |
--storage |
int | 0 |
Allocated storage in GiB (default: the snapshot’s; never smaller) |
--subnet-group |
string | DB subnet group (default: the snapshot’s) | |
--tag |
stringArray | Tag key=value (repeatable) |
stratumctl db subnet-groups
Section titled “stratumctl db subnet-groups”DB subnet groups: the subnets an instance may live in
stratumctl db subnet-groups [flags]Aliases: subnet-group
Subcommands
Section titled “Subcommands”stratumctl db subnet-groups create: Create a DB subnet group (all subnets in one VPC)stratumctl db subnet-groups delete: Delete a DB subnet group (refused while an instance uses it)stratumctl db subnet-groups describe: Describe a DB subnet groupstratumctl db subnet-groups list: List DB subnet groupsstratumctl db subnet-groups update: Update a DB subnet group’s subnets, description or tags
stratumctl db subnet-groups create
Section titled “stratumctl db subnet-groups create”Create a DB subnet group (all subnets in one VPC)
stratumctl db subnet-groups create <name> [flags]Examples
Section titled “Examples”stratumctl db subnet-groups create app-subnets --subnet subnet-3k8m2x7q --subnet subnet-6k2m8x4q| Flag | Type | Default | Description |
|---|---|---|---|
--description |
string | Description | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--subnet |
stringArray | Subnet id (repeatable, required) | |
--tag |
stringArray | Tag key=value (repeatable) |
stratumctl db subnet-groups delete
Section titled “stratumctl db subnet-groups delete”Delete a DB subnet group (refused while an instance uses it)
stratumctl db subnet-groups delete <name> [flags]Examples
Section titled “Examples”stratumctl db subnet-groups delete app-subnets| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db subnet-groups describe
Section titled “stratumctl db subnet-groups describe”Describe a DB subnet group
stratumctl db subnet-groups describe <name> [flags]Aliases: get
Examples
Section titled “Examples”stratumctl db subnet-groups describe app-subnetsstratumctl db subnet-groups describe app-subnets --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db subnet-groups list
Section titled “stratumctl db subnet-groups list”List DB subnet groups
stratumctl db subnet-groups list [flags]Examples
Section titled “Examples”stratumctl db subnet-groups liststratumctl db subnet-groups list --output json| Flag | Type | Default | Description |
|---|---|---|---|
--limit |
int | 0 |
Page size; setting it (or –page-token) returns one page and prints the next token instead of listing everything |
--page-token |
string | Cursor from a previous page; returns that one page | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) |
stratumctl db subnet-groups update
Section titled “stratumctl db subnet-groups update”Update a DB subnet group’s subnets, description or tags
stratumctl db subnet-groups update <name> [flags]Examples
Section titled “Examples”stratumctl db subnet-groups update app-subnets --subnet subnet-3k8m2x7q --subnet subnet-6k2m8x4q --subnet subnet-8k2m4x7qstratumctl db subnet-groups update app-subnets --description "app tier subnets"| Flag | Type | Default | Description |
|---|---|---|---|
--description |
string | Description | |
--project |
string | Project ID (defaults to STRATUM_PROJECT or profile project_id) | |
--subnet |
stringArray | Subnet id (repeatable; replaces the set) | |
--tag |
stringArray | Tag key=value (repeatable; replaces the set) |
