Skip to content

Type Alias: ConnectDatabaseRequest

type ConnectDatabaseRequest = object;

Defined in: packages/sdk/src/index.ts:238

SK-DBCONN-001 — body for client.databases.connect(). Connect a bring-your-own Postgres / ClickHouse: the server seals the connection_url (GLOBAL-031), introspects the schema, and returns a live, queryable DB. connectionUrl is the same trust class as a BYOLLM key — HTTPS-only, sent ONLY in the request body, never logged.

Property Type Description Defined in
connectionUrl string The full DSN to the user’s own database. Sealed at rest server-side (GLOBAL-031); the SDK transmits it once, in the JSON body, and never embeds it in a URL / log / telemetry value. packages/sdk/src/index.ts:243
engine Engine - packages/sdk/src/index.ts:239
name? string - packages/sdk/src/index.ts:244