database
Command reference for parix database.
parix database manages Parix databases in the active organization.
parix database --helpDatabase commands use the stored CLI session and the active organization resolved by Parix auth.
Commands
| Command | Purpose |
|---|---|
parix database catalog | Show database creation catalog options. |
parix database create <database> | Create a new database. |
parix database list | List databases in the active organization. |
parix database info <database-id> | Show database details. |
parix database remove <database-id> | Queue database deletion. |
catalog
parix database catalog [options]Options:
| Option | Description |
|---|---|
-b, --base-url <url> | Parix base URL. |
--json | Print raw JSON. |
-h, --help | Display command help. |
Examples:
parix database catalog
parix database catalog --json
parix database catalog --base-url http://localhost:5173The catalog includes providers, regions, cluster configurations, storage tiers, and cluster sizes that can be used with create.
create
parix database create [options] <database>Arguments:
| Argument | Description |
|---|---|
<database> | Database name. |
Options:
| Option | Description |
|---|---|
-b, --base-url <url> | Parix base URL. |
--provider <slug> | Provider slug, such as gcp or aws. |
--region <code> | Region code. |
--cluster-config-id <id> | Cluster configuration ID. |
--storage-tier-id <id> | Storage tier ID. |
--cluster-size-id <id> | Cluster size ID. |
--storage-gb <n> | Storage size in GB. Must be a positive integer. |
--json | Print raw JSON. |
-h, --help | Display command help. |
Examples:
parix database create payments-ledger --provider gcp --region asia-southeast1
parix database create payments-ledger \
--provider aws \
--region ap-southeast-1 \
--cluster-config-id config-single \
--cluster-size-id size-hx-5The command calls the database creation API. If billing setup blocks provisioning, the CLI prints the billing message and checkout URL. Otherwise it prints the database ID, profile status, provisioning status, and workflow ID.
list
parix database list [options]Options:
| Option | Description |
|---|---|
-b, --base-url <url> | Parix base URL. |
--search <text> | Filter database names. |
--limit <n> | Maximum number of rows to return. |
--json | Print raw JSON. |
-h, --help | Display command help. |
Examples:
parix database list
parix database list --search payments
parix database list --jsoninfo
parix database info [options] <database-id>Arguments:
| Argument | Description |
|---|---|
<database-id> | Database ID. |
Options:
| Option | Description |
|---|---|
-b, --base-url <url> | Parix base URL. |
--json | Print raw JSON. |
-h, --help | Display command help. |
Examples:
parix database info db_123
parix database info db_123 --jsonThe default output includes database identity, provider, region, gateway URL, status, version, sizing, storage, metrics, and latest provision job when available.
remove
parix database remove [options] <database-id>Arguments:
| Argument | Description |
|---|---|
<database-id> | Database ID. |
Options:
| Option | Description |
|---|---|
-b, --base-url <url> | Parix base URL. |
--json | Print raw JSON. |
-y, --yes | Skip the confirmation prompt. |
-h, --help | Display command help. |
Examples:
parix database remove db_123
parix database remove db_123 --yes --jsonremove queues database deletion. Without --yes, the CLI asks for confirmation before sending the delete request.