feat(shared): add a modular UC Connections client to the workspace client

knip.json

@@ -19,6 +19,7 @@
         "@databricks/sdk-jobs",
         "@databricks/sdk-postgres",
         "@databricks/sdk-modelserving",
+        "@databricks/sdk-uc-connections",
         "@databricks/sdk-uc-tables",
         "@databricks/sdk-uc-volumes",
         "@databricks/sdk-vectorsearch",

packages/appkit/package.json

@@ -79,6 +79,7 @@
     "@databricks/sdk-uc-functions": "0.51.0",
     "@databricks/sdk-jobs": "0.57.0",
     "@databricks/sdk-modelserving": "0.53.0",
+    "@databricks/sdk-uc-connections": "0.52.0",
     "@databricks/sdk-uc-tables": "0.52.0",
     "@databricks/sdk-uc-volumes": "0.51.0",
     "@databricks/sdk-vectorsearch": "0.51.0",

packages/appkit/src/testing/mock-workspace-client.ts

@@ -74,6 +74,7 @@ const FACADE_SERVICES = [
   "postgres",
   "volumes",
   "functions",
+  "connections",
   "statementExecution",
   "modelServing",
   "servingEndpoints",

packages/shared/package.json

@@ -56,6 +56,7 @@
     "@databricks/sdk-uc-functions": "0.51.0",
     "@databricks/sdk-jobs": "0.57.0",
     "@databricks/sdk-modelserving": "0.53.0",
+    "@databricks/sdk-uc-connections": "0.52.0",
     "@databricks/sdk-uc-tables": "0.52.0",
     "@databricks/sdk-uc-volumes": "0.51.0",
     "@databricks/sdk-vectorsearch": "0.51.0",

packages/shared/src/workspace-client/client.ts

@@ -28,6 +28,8 @@ import {
   type ModelServingClient,
   buildFilesClient,
   type FilesClient,
+  buildConnectionsClient,
+  type ConnectionsClient,
   buildTablesClient,
   type TablesClient,
   buildPostgresClient,
@@ -59,6 +61,7 @@ export class AppKitWorkspaceClient implements WorkspaceClient {
   #postgres?: PostgresClient;
   #volumes?: VolumesClient;
   #functions?: FunctionsClient;
+  #connections?: ConnectionsClient;
 
   constructor(opts: WorkspaceClientOptions) {
     this.#opts = opts;
@@ -120,6 +123,14 @@ export class AppKitWorkspaceClient implements WorkspaceClient {
     return this.#postgres;
   }
 
+  // Migrated to the modular SDK — built lazily, independent of the legacy client.
+  get connections(): ConnectionsClient {
+    if (!this.#connections) {
+      this.#connections = buildConnectionsClient(this.#opts);
+    }
+    return this.#connections;
+  }
+
   // Migrated to the modular SDK — built lazily, independent of the legacy client.
   get functions(): FunctionsClient {
     if (!this.#functions) {

packages/shared/src/workspace-client/modular.ts

@@ -60,6 +60,7 @@ import type { ClientOptions } from "@databricks/sdk-options/client";
 import type { PostgresClient } from "@databricks/sdk-postgres/v1";
 import { ScimClient } from "@databricks/sdk-scim/v1";
 import { StatementExecutionClient } from "@databricks/sdk-statementexecution/v1";
+import type { ConnectionsClient } from "@databricks/sdk-uc-connections/v1";
 import type { FunctionsClient } from "@databricks/sdk-uc-functions/v1";
 import type { TablesClient } from "@databricks/sdk-uc-tables/v1";
 import type { VolumesClient } from "@databricks/sdk-uc-volumes/v1";
@@ -661,6 +662,19 @@ export function buildFunctionsClient(
   );
 }
 
+/** Build a modular Unity Catalog Connections client from wrapper options. */
+export function buildConnectionsClient(
+  opts: WorkspaceClientOptions,
+): ConnectionsClient {
+  return lazyClient(
+    () =>
+      import("@databricks/sdk-uc-connections/v1").then(
+        (m) => m.ConnectionsClient,
+      ),
+    mapToClientOptions(opts),
+  );
+}
+
 /**
  * Build a modular Lakebase Postgres (autoscaling: projects, branches,
  * endpoints) client from wrapper options. Distinct from the provisioned
@@ -688,6 +702,7 @@ export type { PostgresClient } from "@databricks/sdk-postgres/v1";
 export type { ScimClient } from "@databricks/sdk-scim/v1";
 export type { StatementExecutionClient } from "@databricks/sdk-statementexecution/v1";
 export type { FunctionsClient } from "@databricks/sdk-uc-functions/v1";
+export type { ConnectionsClient } from "@databricks/sdk-uc-connections/v1";
 export type { TablesClient } from "@databricks/sdk-uc-tables/v1";
 export type { VolumesClient } from "@databricks/sdk-uc-volumes/v1";
 export type { VectorSearchClient } from "@databricks/sdk-vectorsearch/v1";
@@ -698,6 +713,12 @@ export type { WarehousesClient } from "@databricks/sdk-warehouses/v1";
 // than the SDK, so the import boundary holds. Type-only: the connector compares
 // state against string literals, which satisfy the SDK's `Enum | (string & {})`
 // field unions — no runtime enum values needed.
+export type {
+  ConnectionInfo,
+  GetConnectionRequest,
+  ListConnectionsRequest,
+  ListConnectionsResponse,
+} from "@databricks/sdk-uc-connections/v1";
 export type {
   ColumnInfo,
   Disposition,

packages/shared/src/workspace-client/tests/modular.test.ts

@@ -73,6 +73,12 @@ vi.mock("@databricks/sdk-uc-functions/v1", () => ({
     return { opts, getFunction: async () => ({}) };
   }),
 }));
+vi.mock("@databricks/sdk-uc-connections/v1", () => ({
+  ConnectionsClient: vi.fn().mockImplementation((opts) => {
+    ctorOpts.push(opts);
+    return { opts, getConnection: async () => ({}) };
+  }),
+}));
 vi.mock("@databricks/sdk-postgres/v1", () => ({
   PostgresClient: vi.fn().mockImplementation((opts) => {
     ctorOpts.push(opts);
@@ -143,6 +149,7 @@ vi.mock("node:child_process", () => ({
 import { ApiError } from "../errors";
 import {
   buildFunctionsClient,
+  buildConnectionsClient,
   buildGenieClient,
   buildModelServingClient,
   buildVolumesClient,
@@ -457,6 +464,31 @@ describe("modular mapToClientOptions (via buildWarehousesClient)", () => {
     expect(m2mOpts).toEqual([]);
   });
 
+  test("connections normalizes a scheme-less host and uses SP M2M creds", async () => {
+    process.env.DATABRICKS_CLIENT_ID = "sp-client-id";
+    process.env.DATABRICKS_CLIENT_SECRET = "sp-secret";
+    await buildConnectionsClient({
+      host: "my-ws.cloud.databricks.com",
+    }).getConnection({} as never);
+    expect(ctorOpts[0].host).toBe("https://my-ws.cloud.databricks.com");
+    expect(m2mOpts).toHaveLength(1);
+    expect(patTokens).toEqual([]);
+  });
+
+  test("connections (asUser) uses the OBO token as PAT", async () => {
+    process.env.DATABRICKS_CLIENT_ID = "sp-client-id";
+    process.env.DATABRICKS_CLIENT_SECRET = "sp-secret";
+    await buildConnectionsClient({
+      token: "user-token",
+      host: "https://x",
+    }).getConnection({} as never);
+    expect(ctorOpts[0].credentials).toMatchObject({
+      kind: "pat",
+      token: "user-token",
+    });
+    expect(m2mOpts).toEqual([]);
+  });
+
   test("postgres normalizes the host and passes SP M2M credentials", async () => {
     process.env.DATABRICKS_HOST = "envhost.cloud.databricks.com";
     process.env.DATABRICKS_CLIENT_ID = "sp-client-id";

packages/shared/src/workspace-client/types.ts

@@ -26,6 +26,7 @@ import type {
   TablesClient,
   VolumesClient,
   FunctionsClient,
+  ConnectionsClient,
   VectorSearchClient,
   PostgresClient,
 } from "./modular";
@@ -77,6 +78,9 @@ export interface WorkspaceClient extends WorkspaceAuth {
   /** Unity Catalog Functions (modular SDK). */
   readonly functions: FunctionsClient;
 
+  /** Unity Catalog Connections (modular SDK). */
+  readonly connections: ConnectionsClient;
+
   /** Statement Execution (modular SDK). */
   readonly statementExecution: StatementExecutionClient;