Interface: LakebaseConnection
Fully-resolved Lakebase Postgres connection.
Extends
Section titled “Extends”Properties
Section titled “Properties”branch?
Section titled “branch?”
optionalbranch?:string
Branch id within the project. Defaults to the project’s default branch.
Inherited from
Section titled “Inherited from”LakebaseConnectionInputs.branch
database?
Section titled “database?”
optionaldatabase?:string
Postgres database name (PGDATABASE). Defaults to databricks_postgres.
Inherited from
Section titled “Inherited from”LakebaseConnectionInputs.database
endpoint?
Section titled “endpoint?”
optionalendpoint?:string
Canonical endpoint resource path (projects/.../endpoints/...), from
LAKEBASE_ENDPOINT. Defaults to the branch’s read-write endpoint.
Inherited from
Section titled “Inherited from”LakebaseConnectionInputs.endpoint
optionalhost?:string
Postgres hostname (PGHOST). Defaults to the resolved endpoint’s host.
Inherited from
Section titled “Inherited from”port:
number
Postgres port (PGPORT). Defaults to 5432.
Overrides
Section titled “Overrides”project?
Section titled “project?”
optionalproject?:string
Lakebase project id. Resolved from the workspace when unset.
Inherited from
Section titled “Inherited from”LakebaseConnectionInputs.project
sslMode
Section titled “sslMode”sslMode:
"require"|"disable"|"prefer"
Postgres TLS mode (PGSSLMODE). Defaults to require.