---
# @generated by sylphx-gen. Do not edit.
title: "sylphx data databases"
description: "The sylphx data databases commands of Sylphx Data: every verb, with its argument, its flags and a run line."
type: reference
product: database
summary: "Every sylphx data databases command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `databases` commands of Sylphx Data, as the CLI spells them: the same
calls as [the `databases` API page](/docs/api/databases), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a database.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data databases get orgs/acme/projects/shop/envs/production/databases/database
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database` · scope `data:read` · effect `read` · [Request, response and examples](/docs/api/databases/get)

## list

Lists databases in a environment.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx data databases list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases` · scope `data:read` · effect `read` · [Request, response and examples](/docs/api/databases/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels, filterable fields, and Ready. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## check-catalog-readiness

Observes aggregate-read coverage using the database's approved reader. Reads catalog metadata only; never accepts SQL, credentials or row data.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data databases check-catalog-readiness orgs/acme/projects/shop/envs/production/databases/database
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:checkCatalogReadiness` · scope `data:read` · effect `read` · [Request, response and examples](/docs/api/databases/check_catalog_readiness)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--expected-generation` | `int` | A stale scheduled intent yields unknown without connecting. |

## query-catalog-targets

Pages the complete authorized production database population, including legacy bindings and protected resources which cannot be observed.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data databases query-catalog-targets orgs/acme/projects/shop/envs/production
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases:queryCatalogTargets` · scope `data:read` · effect `read` · [Request, response and examples](/docs/api/databases/query_catalog_targets)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | Maximum targets to return; defaults to 100 and is capped at 1000. |
| `--page-token` | `string` | Opaque cursor from the preceding page in the same environment. |

## create

Creates a database. The Operation is done when the controller settles it.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx data databases create --parent orgs/acme/projects/shop/envs/production
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases` · scope `data:write` · effect `write` · [Request, response and examples](/docs/api/databases/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.postgres-version` | `string` | The Postgres major version, for example `17`; default the newest supported. |
| `--spec.compute-units` | `number` | Compute size in units; default the plan's. `max_connections` derives from it. |
| `--spec.region` | `string` | The region; default the project's home region. Changing it moves the data by signed export and import. |
| `--spec.deletion-protection` | `bool` | While set, Delete fails with DELETION_PROTECTED. |
| `--spec.client-allowlist` | `string` | Address ranges allowed to connect to the database's endpoint. An entry is an IPv4 or IPv6 range like `203.0.113.0/24` or `2001:db8::/32`, at most 50, applied on both the pooled and the direct host a connection can reach. A connection from any other address is refused at the endpoint with the database's own answer (SQLSTATE 28000), before it reaches Postgres; a connection from a listed address is served as usual. Empty serves every address (the field absent), so clearing it re-opens the endpoint. Send `client_allowlist_set` to store an empty list. Repeat the flag for each value. |
| `--spec.client-allowlist-set` | `bool` | Stores `client_allowlist` as given, including an empty list that re-opens the endpoint. An empty repeated field is not a change on its own, so Update sends `client_allowlist_set` (or `clientAllowlistSet`) as `true` when it means to clear the list; any non-empty `client_allowlist` is stored whether or not this is set. Reads always report `false`. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## update

Updates a database.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data databases update orgs/acme/projects/shop/envs/production/databases/database
```

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database` · scope `data:write` · effect `write` · [Request, response and examples](/docs/api/databases/update)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.compute-units` | `number` | Compute size in units; default the plan's. `max_connections` derives from it. |
| `--spec.region` | `string` | The region; default the project's home region. Changing it moves the data by signed export and import. |
| `--spec.deletion-protection` | `bool` | While set, Delete fails with DELETION_PROTECTED. |
| `--spec.client-allowlist` | `string` | Address ranges allowed to connect to the database's endpoint. An entry is an IPv4 or IPv6 range like `203.0.113.0/24` or `2001:db8::/32`, at most 50, applied on both the pooled and the direct host a connection can reach. A connection from any other address is refused at the endpoint with the database's own answer (SQLSTATE 28000), before it reaches Postgres; a connection from a listed address is served as usual. Empty serves every address (the field absent), so clearing it re-opens the endpoint. Send `client_allowlist_set` to store an empty list. Repeat the flag for each value. |
| `--spec.client-allowlist-set` | `bool` | Stores `client_allowlist` as given, including an empty list that re-opens the endpoint. An empty repeated field is not a change on its own, so Update sends `client_allowlist_set` (or `clientAllowlistSet`) as `true` when it means to clear the list; any non-empty `client_allowlist` is stored whether or not this is set. Reads always report `false`. |
| `--allow-missing` | `bool` | Create the Resource when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## delete

Deletes a database. Fails while `spec.deletion_protection` is set.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data databases delete orgs/acme/projects/shop/envs/production/databases/database --yes
```

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database` · scope `data:write` · effect `destructive` · [Request, response and examples](/docs/api/databases/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the Resource does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |
| `--yes` | `bool` | Do not ask before this destructive call. |

## connect

Returns how to connect to the database: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data databases connect orgs/acme/projects/shop/envs/production/databases/database
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:connect` · scope `data:write` · effect `read` · [Request, response and examples](/docs/api/databases/connect)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--profile` | `enum` | POOLED (default) or DIRECT. One of `pooled`, `direct`. |

## rotate-credentials

Replaces the database's engine credentials; the old ones stop working once the new ones are served.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data databases rotate-credentials orgs/acme/projects/shop/envs/production/databases/database
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:rotateCredentials` · scope `data:write` · effect `write` · [Request, response and examples](/docs/api/databases/rotate_credentials)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Act only if the current etag matches. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## restore

Restores the database in place to a point in time inside its retention window; the database is unavailable while it restores.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx data databases restore orgs/acme/projects/shop/envs/production/databases/database --yes
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:restore` · scope `data:write` · effect `destructive` · [Request, response and examples](/docs/api/databases/restore)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--restore-time` | `timestamp` | The point in time to restore to. Required. |
| `--etag` | `string` | Act only if the current etag matches. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |
| `--yes` | `bool` | Do not ask before this destructive call. |
