databricks/sdk-js

databricks/sdk-js

Description: Databricks Modular SDKs for JavaScript

Language: TypeScript

License: Apache-2.0

Stars: 3

Forks: 0

Open issues: 20

Created: 2025-11-28T14:03:59Z

Pushed: 2026-06-10T10:23:50Z

Default branch: main

Fork: no

Archived: no

README:

Databricks Modular SDKs for JavaScript

> [!WARNING] > > ## PREVIEW - NOT FOR PRODUCTION USE > > This SDK is in preview and is subject to change without notice. > > - Do NOT use in production environments > - Breaking changes may occur at any time > - APIs are experimental and unstable > - Use for development and testing only

The Databricks SDKs for JavaScript provide typed clients for the Databricks REST API. They have a modular architecture, with a separate npm package for each API (for example, @databricks/sdk-postgres).

Table of Contents

• [Installation](#installation)
• [Authentication](#authentication)
• [Example](#example)
• [Packages](#packages)
• [Shared packages](#shared-packages)
• [License](#license)

Installation

Install the package for each API you need. For example, to work with Postgres:

npm install @databricks/sdk-postgres

Authentication

By default, a client reads its configuration (host and credentials) from a Databricks configuration profile (~/.databrickscfg) and DATABRICKS_* environment variables. With those set, no credentials need to be passed in code:

import {PostgresClient} from '@databricks/sdk-postgres/v1';

// Resolves the host and credentials from the DEFAULT profile and DATABRICKS_* env vars.
const client = new PostgresClient({});

To configure credentials explicitly, import a helper from @databricks/sdk-auth/credentials and pass it as credentials:

import {PostgresClient} from '@databricks/sdk-postgres/v1';
import {newPatCredentials} from '@databricks/sdk-auth/credentials';

const client = new PostgresClient({
host: 'https://example.cloud.databricks.com',
credentials: newPatCredentials(''),
});

Example

The following lists your Postgres projects, using the default authentication described above. List methods expose an Iter variant that pages through results transparently as you iterate:

import {PostgresClient} from '@databricks/sdk-postgres/v1';

const client = new PostgresClient({});

for await (const project of client.listProjectsIter({})) {
console.log(project.name);
}

More runnable examples (pagination, long-running operations, error handling, and authentication strategies) are available in [packages/examples](packages/examples).

Packages

Each Databricks API is published as a separate package named @databricks/sdk-. Import its client from the package's versioned subpath — for example, @databricks/sdk-postgres/v1 exports PostgresClient.

| Package | Version | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | @databricks/sdk-uc-systemschemas | [![npm](h