Interface: ParsedAddress

Pieces recovered from parsing a single address or resource-path input.

Extends

optional branch?: string

Branch id within the project. Defaults to the project’s default branch.

optional database?: string

Postgres database name (PGDATABASE). Defaults to databricks_postgres.

optional databaseResourceId?: string

Database resource id leaf from a .../databases/{id} path. Not the Postgres database name.

optional endpoint?: string

Canonical endpoint resource path (projects/.../endpoints/...), from LAKEBASE_ENDPOINT. Defaults to the branch’s read-write endpoint.

optional endpointId?: string

Endpoint leaf id (last segment of an endpoint resource path).

optional host?: string

Postgres hostname (PGHOST). Defaults to the resolved endpoint’s host.

optional port?: number

Postgres port (PGPORT). Defaults to 5432.

optional project?: string

Lakebase project id. Resolved from the workspace when unset.

optional sslMode?: "require" | "disable" | "prefer"

Postgres TLS mode (PGSSLMODE). Defaults to require.

optional user?: string

Postgres user (URI-decoded if encoded).