Rename LAKEBASE_ENDPOINT to PGENDPOINT as it is automatically injected from apps

pkosiec · pkosiec · commit 6daae12c5fe9 · 2026-02-26T14:02:50.000+01:00
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -260,7 +260,7 @@ AppKit provides `createLakebasePool()` - a factory function that returns a stand
 ```typescript
 import { createLakebasePool } from '@databricks/appkit';
 
-// Reads from PGHOST, PGDATABASE, LAKEBASE_ENDPOINT env vars
+// Reads from PGHOST, PGDATABASE, PGENDPOINT env vars
 const pool = createLakebasePool();
 
 // Standard pg.Pool API
diff --git a/apps/dev-playground/.env.dist b/apps/dev-playground/.env.dist
@@ -6,7 +6,7 @@ NODE_ENV='development'
 OTEL_EXPORTER_OTLP_ENDPOINT='http://localhost:4318'
 OTEL_RESOURCE_ATTRIBUTES='service.sample_attribute=dev'
 OTEL_SERVICE_NAME='dev-playground'
-LAKEBASE_ENDPOINT='' # Run: databricks postgres list-endpoints projects/{project-id}/branches/{branch-id} — use the `name` field from the output
+PGENDPOINT='' # Run: databricks postgres list-endpoints projects/{project-id}/branches/{branch-id} — use the `name` field from the output
 PGHOST=
 PGUSER=
 PGDATABASE=databricks_postgres
diff --git a/apps/dev-playground/server/lakebase-examples-plugin.ts b/apps/dev-playground/server/lakebase-examples-plugin.ts
@@ -34,9 +34,9 @@ export class LakebaseExamplesPlugin extends Plugin {
 
   async setup() {
     // Check if Lakebase is configured
-    if (!process.env.PGHOST || !process.env.LAKEBASE_ENDPOINT) {
+    if (!process.env.PGHOST || !process.env.PGENDPOINT) {
       console.warn(
-        "Lakebase not configured (missing PGHOST or LAKEBASE_ENDPOINT), examples disabled",
+        "Lakebase not configured (missing PGHOST or PGENDPOINT), examples disabled",
       );
       return;
     }
@@ -59,7 +59,7 @@ export class LakebaseExamplesPlugin extends Plugin {
 
   injectRoutes(router: IAppRouter): void {
     // Skip route injection if Lakebase is not configured
-    if (!process.env.PGHOST || !process.env.LAKEBASE_ENDPOINT) {
+    if (!process.env.PGHOST || !process.env.PGENDPOINT) {
       return;
     }
 
diff --git a/docs/docs/api/appkit/Enumeration.ResourceType.md b/docs/docs/api/appkit/Enumeration.ResourceType.md
@@ -44,6 +44,14 @@ JOB: "job";
 
 ***
 
+### POSTGRES
+
+```ts
+POSTGRES: "postgres";
+```
+
+***
+
 ### SECRET
 
 ```ts
diff --git a/docs/docs/api/appkit/Interface.LakebasePoolConfig.md b/docs/docs/api/appkit/Interface.LakebasePoolConfig.md
@@ -33,7 +33,7 @@ databricks postgres list-endpoints projects/{project-id}/branches/{branch-id}
 Use the `name` field from the output.
 
 Required for OAuth authentication (unless password is provided)
-Can also be set via LAKEBASE_ENDPOINT environment variable
+Can also be set via PGENDPOINT environment variable
 
 #### Example
 
diff --git a/docs/docs/api/appkit/TypeAlias.ResourcePermission.md b/docs/docs/api/appkit/TypeAlias.ResourcePermission.md
@@ -11,6 +11,7 @@ type ResourcePermission =
   | UcFunctionPermission
   | UcConnectionPermission
   | DatabasePermission
+  | PostgresPermission
   | GenieSpacePermission
   | ExperimentPermission
   | AppPermission;
diff --git a/docs/docs/plugins/lakebase.md b/docs/docs/plugins/lakebase.md
@@ -74,16 +74,16 @@ The required environment variables:
 
 | Variable | Description |
 |---|---|
-| `LAKEBASE_ENDPOINT` | Endpoint resource path (e.g. `projects/.../branches/.../endpoints/...`) |
+| `PGENDPOINT` | Endpoint resource path (e.g. `projects/.../branches/.../endpoints/...`) |
 | `PGHOST` | Lakebase host (auto-injected in production by the `postgres` Databricks Apps resource) |
 | `PGDATABASE` | Database name (auto-injected in production by the `postgres` Databricks Apps resource) |
 | `PGSSLMODE` | TLS mode — set to `require` (auto-injected in production by the `postgres` Databricks Apps resource) |
 
-When deployed to Databricks Apps with a `postgres` database resource configured, `PGHOST`, `PGDATABASE`, `PGSSLMODE`, `PGUSER`, `PGPORT`, and `PGAPPNAME` are automatically injected by the platform. Only `LAKEBASE_ENDPOINT` must be set explicitly:
+When deployed to Databricks Apps with a `postgres` database resource configured, `PGHOST`, `PGDATABASE`, `PGSSLMODE`, `PGUSER`, `PGPORT`, and `PGAPPNAME` are automatically injected by the platform. Only `PGENDPOINT` must be set explicitly:
 
 ```yaml
 env:
-  - name: LAKEBASE_ENDPOINT
+  - name: PGENDPOINT
     valueFrom: postgres
 ```
 
@@ -92,7 +92,7 @@ For local development, set all variables in your `.env` file:
 ```env
 PGHOST=your-lakebase-host.databricks.com
 PGDATABASE=databricks_postgres
-LAKEBASE_ENDPOINT=projects/<project-id>/branches/<branch-id>/endpoints/<endpoint-id>
+PGENDPOINT=projects/<project-id>/branches/<branch-id>/endpoints/<endpoint-id>
 PGSSLMODE=require
 ```
 
diff --git a/docs/static/schemas/plugin-manifest.schema.json b/docs/static/schemas/plugin-manifest.schema.json
@@ -197,14 +197,7 @@
     },
     "resourceRequirement": {
       "type": "object",
-      "required": [
-        "type",
-        "alias",
-        "resourceKey",
-        "description",
-        "permission",
-        "fields"
-      ],
+      "required": ["type", "alias", "resourceKey", "description", "permission"],
       "properties": {
         "type": {
           "$ref": "#/$defs/resourceType"
diff --git a/packages/appkit/src/plugins/lakebase/manifest.json b/packages/appkit/src/plugins/lakebase/manifest.json
@@ -11,13 +11,7 @@
         "alias": "Postgres",
         "resourceKey": "postgres",
         "description": "Lakebase Postgres database for persistent storage",
-        "permission": "CAN_CONNECT_AND_CREATE",
-        "fields": {
-          "name": {
-            "env": "LAKEBASE_ENDPOINT",
-            "description": "Lakebase endpoint resource path"
-          }
-        }
+        "permission": "CAN_CONNECT_AND_CREATE"
       }
     ],
     "optional": []
diff --git a/packages/appkit/src/plugins/lakebase/types.ts b/packages/appkit/src/plugins/lakebase/types.ts
@@ -5,7 +5,7 @@ import type { LakebasePoolConfig } from "../../connectors/lakebase";
  * Configuration for the Lakebase plugin.
  *
  * The minimum required setup is via environment variables — no `pool` config
- * is needed if `PGHOST`, `PGDATABASE`, and `LAKEBASE_ENDPOINT` are set.
+ * is needed if `PGHOST`, `PGDATABASE`, and `PGENDPOINT` are set.
  *
  * @see {@link https://github.com/databricks/appkit/blob/main/packages/lakebase/README.md} for the full configuration reference.
  */
diff --git a/packages/lakebase/README.md b/packages/lakebase/README.md
@@ -31,12 +31,12 @@ Set the following environment variables:
 ```bash
 export PGHOST=your-lakebase-host.databricks.com
 export PGDATABASE=your_database_name
-export LAKEBASE_ENDPOINT=projects/6bef4151-4b5d-4147-b4d0-c2f4fd5b40db/branches/br-broad-pine-y12n6gnv/endpoints/ep-summer-frost-y131l3vx
+export PGENDPOINT=projects/6bef4151-4b5d-4147-b4d0-c2f4fd5b40db/branches/br-broad-pine-y12n6gnv/endpoints/ep-summer-frost-y131l3vx
 export PGUSER=your_user # optionally, defaults to DATABRICKS_CLIENT_ID
 export PGSSLMODE=require
 ```
 
-To find your `LAKEBASE_ENDPOINT`, run the Databricks CLI and use the `name` field from the output:
+To find your `PGENDPOINT`, run the Databricks CLI and use the `name` field from the output:
 
 ```bash
 databricks postgres list-endpoints projects/{project-id}/branches/{branch-id}
@@ -63,7 +63,7 @@ const pool = createLakebasePool({
   host: "your-lakebase-host.databricks.com", // defaults to PGHOST environment variable
   database: "your_database_name", // defaults to PGDATABASE environment variable
   endpoint:
-    "projects/6bef4151-4b5d-4147-b4d0-c2f4fd5b40db/branches/br-broad-pine-y12n6gnv/endpoints/ep-summer-frost-y131l3vx", // defaults to LAKEBASE_ENDPOINT environment variable
+    "projects/6bef4151-4b5d-4147-b4d0-c2f4fd5b40db/branches/br-broad-pine-y12n6gnv/endpoints/ep-summer-frost-y131l3vx", // defaults to PGENDPOINT environment variable
   user: "user_id", // Optional, defaults to PGUSER or DATABRICKS_CLIENT_ID
   max: 10, // Connection pool size
 });
@@ -114,7 +114,7 @@ const pool = createLakebasePool({ user });
 | ------------------------- | ---------------------------------- | --------------------------------------- | ----------------------- |
 | `host`                    | `PGHOST`                           | Lakebase host                           | _Required_              |
 | `database`                | `PGDATABASE`                       | Database name                           | _Required_              |
-| `endpoint`                | `LAKEBASE_ENDPOINT`                | Endpoint resource path                  | _Required_              |
+| `endpoint`                | `PGENDPOINT`                       | Endpoint resource path                  | _Required_              |
 | `user`                    | `PGUSER` or `DATABRICKS_CLIENT_ID` | Username or service principal ID        | See [Username Resolution](#username-resolution)|
 | `port`                    | `PGPORT`                           | Port number                             | `5432`                  |
 | `sslMode`                 | `PGSSLMODE`                        | SSL mode                                | `require`               |
diff --git a/packages/lakebase/src/__tests__/pool.test.ts b/packages/lakebase/src/__tests__/pool.test.ts
@@ -94,7 +94,7 @@ describe("createLakebasePool", () => {
   const envKeysUsed = [
     "PGHOST",
     "PGDATABASE",
-    "LAKEBASE_ENDPOINT",
+    "PGENDPOINT",
     "PGUSER",
     "PGPORT",
     "PGSSLMODE",
@@ -112,7 +112,7 @@ describe("createLakebasePool", () => {
     // Setup environment variables
     process.env.PGHOST = "ep-test.database.us-east-1.databricks.com";
     process.env.PGDATABASE = "databricks_postgres";
-    process.env.LAKEBASE_ENDPOINT =
+    process.env.PGENDPOINT =
       "projects/test-project/branches/main/endpoints/primary";
     process.env.PGUSER = "test-user@example.com";
 
@@ -172,13 +172,13 @@ describe("createLakebasePool", () => {
     });
 
     test("should throw error when endpoint is missing", () => {
-      delete process.env.LAKEBASE_ENDPOINT;
+      delete process.env.PGENDPOINT;
 
       expect(() =>
         createLakebasePool({
           workspaceClient: {} as any,
         }),
-      ).toThrow("LAKEBASE_ENDPOINT or config.endpoint");
+      ).toThrow("PGENDPOINT or config.endpoint");
     });
 
     test("should throw error when host is missing", () => {
@@ -537,7 +537,7 @@ describe("createLakebasePool", () => {
     });
 
     test("should not require endpoint when password is provided", () => {
-      delete process.env.LAKEBASE_ENDPOINT;
+      delete process.env.PGENDPOINT;
 
       expect(() =>
         createLakebasePool({
diff --git a/packages/lakebase/src/config.ts b/packages/lakebase/src/config.ts
@@ -32,12 +32,12 @@ export function parsePoolConfig(
   userConfig?: Partial<LakebasePoolConfig>,
 ): ParsedPoolConfig {
   // Get endpoint (required only for OAuth auth)
-  const endpoint = userConfig?.endpoint ?? process.env.LAKEBASE_ENDPOINT;
+  const endpoint = userConfig?.endpoint ?? process.env.PGENDPOINT;
 
   // Only require endpoint if no password provided
   if (!endpoint && !userConfig?.password) {
     throw ConfigurationError.missingEnvVar(
-      "LAKEBASE_ENDPOINT or config.endpoint (or provide config.password for native auth)",
+      "PGENDPOINT or config.endpoint (or provide config.password for native auth)",
     );
   }
 
diff --git a/packages/lakebase/src/pool.ts b/packages/lakebase/src/pool.ts
@@ -23,7 +23,7 @@ import type { LakebasePoolConfig } from "./types";
  *
  * @example Using environment variables
  * ```typescript
- * // Set: PGHOST, PGDATABASE, LAKEBASE_ENDPOINT
+ * // Set: PGHOST, PGDATABASE, PGENDPOINT
  * const pool = createLakebasePool();
  * const result = await pool.query('SELECT * FROM users');
  * ```
diff --git a/packages/lakebase/src/types.ts b/packages/lakebase/src/types.ts
@@ -67,7 +67,7 @@ export interface LakebasePoolConfig extends PoolConfig {
    * Use the `name` field from the output.
    *
    * Required for OAuth authentication (unless password is provided)
-   * Can also be set via LAKEBASE_ENDPOINT environment variable
+   * Can also be set via PGENDPOINT environment variable
    *
    * @example "projects/{project-id}/branches/{branch-id}/endpoints/{endpoint-identifier}"
    */
diff --git a/packages/shared/src/schemas/plugin-manifest.schema.json b/packages/shared/src/schemas/plugin-manifest.schema.json
@@ -197,14 +197,7 @@
     },
     "resourceRequirement": {
       "type": "object",
-      "required": [
-        "type",
-        "alias",
-        "resourceKey",
-        "description",
-        "permission",
-        "fields"
-      ],
+      "required": ["type", "alias", "resourceKey", "description", "permission"],
       "properties": {
         "type": {
           "$ref": "#/$defs/resourceType"
diff --git a/template/.env.example.tmpl b/template/.env.example.tmpl
@@ -6,7 +6,7 @@ DATABRICKS_HOST=https://...
 PGHOST=your-lakebase-host.databricks.com
 PGDATABASE=databricks_postgres
 # Run: databricks postgres list-endpoints projects/{project-id}/branches/{branch-id}
-LAKEBASE_ENDPOINT=projects/<project-id>/branches/<branch-id>/endpoints/<endpoint-id>
+PGENDPOINT=projects/<project-id>/branches/<branch-id>/endpoints/<endpoint-id>
 # PGUSER=your_user  # optional, defaults to DATABRICKS_CLIENT_ID
 PGSSLMODE=require
 {{- end}}
diff --git a/template/.env.tmpl b/template/.env.tmpl
@@ -10,7 +10,7 @@ DATABRICKS_HOST={{.workspaceHost}}
 PGHOST=
 PGDATABASE=
 # Run: databricks postgres list-endpoints projects/{project-id}/branches/{branch-id}
-LAKEBASE_ENDPOINT=
+PGENDPOINT=
 # PGUSER=  # optional, defaults to DATABRICKS_CLIENT_ID
 PGSSLMODE=require
 {{- end}}
diff --git a/template/appkit.plugins.json b/template/appkit.plugins.json
@@ -38,13 +38,7 @@
             "alias": "Postgres",
             "resourceKey": "postgres",
             "description": "Lakebase Postgres database for persistent storage",
-            "permission": "CAN_CONNECT_AND_CREATE",
-            "fields": {
-              "name": {
-                "env": "LAKEBASE_ENDPOINT",
-                "description": "Lakebase endpoint resource path"
-              }
-            }
+            "permission": "CAN_CONNECT_AND_CREATE"
           }
         ],
         "optional": []
diff --git a/template/server/routes/lakebase/todo-routes.ts b/template/server/routes/lakebase/todo-routes.ts
@@ -1,10 +1,14 @@
 {{if .plugins.lakebase -}}
 import { z } from 'zod';
-import type { LakebasePlugin, ServerPlugin } from '@databricks/appkit';
+import type { Application } from 'express';
 
 interface AppKitWithLakebase {
-  lakebase: ReturnType<LakebasePlugin['exports']>;
-  server: ReturnType<ServerPlugin['exports']>;
+  lakebase: {
+    query(text: string, params?: unknown[]): Promise<{ rows: Record<string, unknown>[] }>;
+  };
+  server: {
+    extend(fn: (app: Application) => void): void;
+  };
 }
 
 const CREATE_TABLE_SQL = `

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import type { LakebasePoolConfig } from "../../connectors/lakebase";`
`5`	`5`	`* Configuration for the Lakebase plugin.`
`6`	`6`	`*`
`7`	`7`	* The minimum required setup is via environment variables — no `pool` config
`8`		- * is needed if `PGHOST`, `PGDATABASE`, and `LAKEBASE_ENDPOINT` are set.
	`8`	+ * is needed if `PGHOST`, `PGDATABASE`, and `PGENDPOINT` are set.
`9`	`9`	`*`
`10`	`10`	`* @see {@link https://github.com/databricks/appkit/blob/main/packages/lakebase/README.md} for the full configuration reference.`
`11`	`11`	`*/`