---
# @generated by sylphx-gen. Do not edit.
title: "Check catalog readiness on a database"
description: "`data.databases.check_catalog_readiness` (POST /v1/{name}:checkCatalogReadiness): Observes aggregate-read coverage using the database's approved reader."
type: reference
product: database
summary: "Observes aggregate-read coverage using the database's approved reader."
updated: 2026-09-28
nav: false
---

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

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:checkCatalogReadiness`
- **Scope** `data:read`
- **Effect** `read` — nothing is written.
- **Collection** [databases](/docs/api/databases)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Exact database name in the authorized environment. Required. |
| `expected_generation` | `int64` | A stale scheduled intent yields unknown without connecting. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `resource` | `string` | Exact authorized database name from the owner census. Output only. |
| `observed_generation` | `int64` | Resource generation against which the observation is fenced. Output only. |
| `observed_at` | `timestamp` | Owner clock time at which the observation completed. Output only. |
| `state` | `CatalogReadinessState` | Whether complete current evidence establishes coverage or a known gap. Output only. One of `healthy`, `unhealthy`, `unknown`. |
| `reason` | `CatalogReadinessReason` | Finite owner reason; never contains driver errors or credentials. Output only. One of `catalog_ready`, `credential_missing`, `authority_denied`, `connect_failed`, `catalog_unavailable`, `reachable_zero_declared_functions`, `declared_function_missing`, `execute_missing`, `generation_mismatch`, `reader_boundary_failed`, `unsupported_legacy`, `protected_resource`, `reader_not_ready`, `declaration_invalid`, `platform_owned_policy_excluded`. |
| `coverage_gap` | `bool` | An affirmatively observed coverage defect that can open an episode. Output only. |
| `transport_reachable` | `bool` | Whether this attempt reached the exact approved database; absent if unobserved. Output only. |
| `declared_function_count` | `uint32` | Authoritative declared signatures, present only for a complete catalog read. Output only. |
| `observed_function_count` | `uint32` | The number of declared signatures which resolve, not unrelated functions. Output only. |
| `missing_function_count` | `uint32` | Declared signatures that did not resolve; absent for unknown observations. Output only. |
| `execute_missing_count` | `uint32` | Resolved signatures lacking schema USAGE or function EXECUTE. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/databases/database:checkCatalogReadiness" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

```ts
const response = await sylphx.data.databases.checkCatalogReadiness({ name: 'orgs/acme/projects/shop/envs/production/databases/database' })
```

**Rust**

```rust
let mut req = sylphx::data::CheckDatabaseCatalogReadinessRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/databases/database".to_string();
let response = sx.data().databases().check_catalog_readiness(req).await?;
```

**CLI**

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

**MCP**

```json
{ "method_id": "data.databases.check_catalog_readiness", "args": {"name":"orgs/acme/projects/shop/envs/production/databases/database"} }
```