connections

Read a connection's synced warehouse catalog.

Returns the persisted catalog (databases/schemas/tables/views, with columns on tables/views) for a connection with catalogSyncEnabled: true (A3, DVT-1810). This is a pure read of what jobs.CatalogSyncJob has already persisted — it never drives the warehouse itself (use POST .../catalog/sync to request a fresh pass). Metadata only (names/types/comments) — never data rows (ADR-0011 amendment).

With no query params, returns the full tree ordered parent-before-child. query and/or kind switch to a bounded (200-row), name-prefix search instead of the full tree. Requires the data:query scope (same floor as POST /v1/data/describe) — an API key without it is rejected even if the connection itself is accessible.

Returns an empty array (not a 404) for a connection that has never been synced, or has catalogSyncEnabled: false.

get/v1/connections/{id}/catalog

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/connections/{id}/catalog
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Query parameters

querystring

Case-insensitive name PREFIX match (not substring). Empty/omitted matches every object.

kind'database' | 'schema' | 'table' | 'view'

Filter to one object kind.

Response

The connection's synced catalog (possibly empty).

Changes

No recorded changes to this operation across all 1 revision of this API.