Skip to content

Interface: LakebaseResolverInputs

User-supplied Lakebase inputs (config or env) before any API resolution. Extends LakebaseConnectionInputs with resolver-only options. resolveLakebaseConnection fills gaps from the Lakebase API when it has enough context (typically a project).

optional autoCreate?: string | false

What to do when no project exists in the workspace at all.

  • undefined (default): derive a project id from project.name (the host repo’s package.json name) slugified to Lakebase id constraints, then create it.
  • string: create a new project with this exact id.
  • false: skip creation and throw with a clear error message.

optional branch?: string

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

LakebaseConnectionInputs.branch


optional database?: string

Postgres database name (PGDATABASE). Defaults to databricks_postgres.

LakebaseConnectionInputs.database


optional endpoint?: string

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

LakebaseConnectionInputs.endpoint


optional host?: string

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

LakebaseConnectionInputs.host


optional port?: number

Postgres port (PGPORT). Defaults to 5432.

LakebaseConnectionInputs.port


optional project?: string

Lakebase project id. Resolved from the workspace when unset.

LakebaseConnectionInputs.project


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

Postgres TLS mode (PGSSLMODE). Defaults to require.

LakebaseConnectionInputs.sslMode