SDK Databricks для JavaScript

Important

Пакеты SDK Databricks для JavaScript доступны в бета-версии. Во время бета-версии Databricks рекомендует закрепить зависимость от конкретной версии каждого пакета SDK Databricks для пакета JavaScript, от которой зависит ваш код, например в файле проекта package.json .

Сообщайте о проблемах в репозитории Databricks SDK для JavaScript на GitHub.

Автоматизируйте операции в Azure Databricks и ускорьте разработку с помощью SDK Databricks для JavaScript. Эти пакеты SDK предоставляют типизированные клиенты для REST API Databricks. Они имеют модульную архитектуру с отдельным пакетом npm для каждого API (например, @databricks/sdk-postgres). Установите только пакеты для используемых API.

Эта страница дополняет пакеты SDK Databricks для JavaScript README и примеры.

Требования

Чтобы использовать пакеты SDK Databricks для JavaScript, компьютер разработки должен иметь следующие компоненты:

Get started

  1. Установите пакет для каждого необходимого API. Каждый API Databricks публикуется как отдельный пакет с именем @databricks/sdk-<api>. Например, чтобы работать с Postgres, выполните следующую команду из корневого каталога проекта Node.js:

    npm install @databricks/sdk-postgres

  2. Если он еще не настроен, настройте компьютер разработки для Azure Databricks проверки подлинности.

  3. Импортируйте клиент из подpath версии пакета, а затем вызовите API. В следующем примере TypeScript перечислены проекты Postgres, используя проверку подлинности по умолчанию, описанную в разделе "Проверка подлинности". Методы получения списка имеют вариант Iter, который автоматически постранично перебирает результаты по мере итерации:

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

const client = new PostgresClient({});

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

Дополнительные примеры запуска, включая разбиение на страницы, длительные операции, обработку ошибок и стратегии проверки подлинности, см. в папке примеров в репозитории Databricks SDK для JavaScript в GitHub.

Аутентифицироваться

По умолчанию клиент считывает конфигурацию, включая хост и учетные данные, из профиля конфигурации Databricks (~/.databrickscfg) и DATABRICKS_* переменных среды. Когда все это настроено, вам не нужно указывать какие-либо учетные данные в коде, например:

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

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

Чтобы явно настроить учетные данные, импортируйте вспомогательную функцию из @databricks/sdk-auth/credentials и передайте её как credentials. В следующем примере настраивается аутентификация с помощью персонального токена доступа Databricks.

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

const client = new PostgresClient({
  host: 'https://my-company.databricks.com',
  credentials: newPatCredentials(MY_PAT_ENV_VAR),
});

Пакет @databricks/sdk-auth предоставляет дополнительные поставщики учетных данных, включая newU2mCredentials для OAuth user-to-machine (U2M) и newM2mCredentials для OAuth machine-to-machine (M2M), а также цепочку учетных данных по умолчанию. Дополнительные сведения о проверке подлинности Azure Databricks см. в статье Databricks с унифицированной проверкой подлинности.

Packages

Каждый API Databricks публикуется как отдельный пакет с именем @databricks/sdk-<api>. Импортируйте его клиент из версионированного подпути пакета. Например, @databricks/sdk-postgres/v1 экспортирует PostgresClient.

Полный список доступных пакетов API см. в разделе Packages в README Databricks SDK for JavaScript.

Совместно используемые пакеты

Три пакета совместно используются каждым клиентом API и предоставляют элементы, импортируемые напрямую:

Package Description
@databricks/sdk-core HTTP-клиент, определение профиля конфигурации, журналирование и типы ошибок API (ApiError).
@databricks/sdk-auth Поставщики учетных данных (newPatCredentials, newU2mCredentials, newM2mCredentials) и цепочка учетных данных по умолчанию.
@databricks/sdk-options Типы параметров, передаваемые клиентам и вызовам (ClientOptions, CallOptions).

Дополнительные ресурсы

  • Last updated on