project database

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship project database

Manage project databases, replicas, backups and application connections

openship project database [options] [command]

Subcommand	Purpose
`list <project>`	List project databases and their operation sequences
`imports <project>`	List backup artifacts available to import into a database
`get [options] <project> <database>`	Read database health, backups and progress
`create [options] <id> [file]`	Provision a database, optionally from an import, copy or backup
`update [options] <id> [file]`	Apply database configuration at the reviewed sequence
`retry [options] <project> <database>`	Resume a failed database operation at its current sequence
`backup [options] <project> <database>`	Start a database backup at the reviewed sequence
`connect [options] <id> [file]`	Bind a database to an environment key; null disconnects, replacement needs its sequence
`remove [options] <id> [file]`	Remove a named database with an explicit retain-or-delete-data decision
`events [options] <project>`	Stream health and operation progress

Start a database backup at the reviewed sequence

openship project database backup [options] <project> <database>

Argument	Meaning
`project`	Project ID
`database`	Database ID

Option	Meaning
`--sequence <number>`	Current database sequence

Bind a database to an environment key; null disconnects, replacement needs its sequence

openship project database connect [options] <id> [file]

Argument	Meaning
`id`	Resource ID
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

Provision a database, optionally from an import, copy or backup

openship project database create [options] <id> [file]

Argument	Meaning
`id`	Resource ID
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

Stream health and operation progress

openship project database events [options] <project>

Argument	Meaning
`project`	Project ID

Option	Meaning
`--timeout <ms>`	Stop after this deadline

Read database health, backups and progress

openship project database get [options] <project> <database>

Argument	Meaning
`project`	Project ID
`database`	Database ID

Option	Meaning
`--observe`	Refresh observed database health

List backup artifacts available to import into a database

openship project database imports [options] <project>

Argument	Meaning
`project`	Project ID

List project databases and their operation sequences

openship project database list [options] <project>

Argument	Meaning
`project`	Project ID

Remove a named database with an explicit retain-or-delete-data decision

openship project database remove [options] <id> [file]

Argument	Meaning
`id`	Resource ID
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation

Resume a failed database operation at its current sequence

openship project database retry [options] <project> <database>

Argument	Meaning
`project`	Project ID
`database`	Database ID

Option	Meaning
`--sequence <number>`	Current database sequence

Apply database configuration at the reviewed sequence

openship project database update [options] <id> [file]

Argument	Meaning
`id`	Resource ID
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation