Skip to main content

Function: getLakebasePgConfig()

Function: getLakebasePgConfig()

function getLakebasePgConfig(
   config?: Partial<LakebasePoolConfig>, 
   telemetry?: DriverTelemetry, 
   logger?: Logger): PoolConfig;

Get Lakebase connection configuration for PostgreSQL clients.

Returns pg.PoolConfig with OAuth token authentication configured. Best used with pg.Pool directly or ORMs that accept pg.Pool instances (like Drizzle).

For ORMs that need connection parameters (TypeORM, Sequelize), use getLakebaseOrmConfig() instead.

Used internally by createLakebasePool().

Parameters

ParameterTypeDescription
config?Partial<LakebasePoolConfig>Optional configuration (reads from environment if not provided)
telemetry?DriverTelemetryOptional pre-initialized telemetry (created internally if not provided)
logger?LoggerOptional logger (silent if not provided)

Returns

PoolConfig

PostgreSQL pool configuration with OAuth token refresh

Databricks Developer Hub

Ready to ship your next agentic app in minutes?

Read docs