Sady SDK pro JavaScript od Databricks

Important

Sady SDK Databricks pro JavaScript jsou ve fázi Beta. Během fáze beta Databricks doporučuje pevně vázat závislost na konkrétní verzi každého balíčku Databricks SDK pro JavaScript, na kterém váš kód závisí, například v souboru projektu package.json.

Hlášení problémů se sadami SDK Databricks pro úložiště JavaScript v GitHub

Automatizujte operace Azure Databricks a urychlete vývoj pomocí sad SDK Databricks pro JavaScript. Tyto sady SDK poskytují typové klienty pro rozhraní Databricks REST API. Mají modulární architekturu s samostatným balíčkem npm pro každé rozhraní API (například @databricks/sdk-postgres). Nainstalujte pouze balíčky pro rozhraní API, která používáte.

Tato stránka doplňuje sady SDK Databricks pro javascriptový soubor README a příklady.

Požadavky

Pokud chcete používat sady SDK Databricks pro JavaScript, váš vývojový počítač musí mít:

Začínáme

  1. Nainstalujte balíček pro každé rozhraní API, které potřebujete. Každé rozhraní API Databricks se publikuje jako samostatný balíček s názvem @databricks/sdk-<api>. Pokud chcete například pracovat s Postgres, spusťte z kořenového adresáře projektu Node.js následující příkaz:

    npm install @databricks/sdk-postgres

  2. Pokud ještě není nakonfigurovaný, nastavte vývojový počítač pro ověřování Azure Databricks.

  3. Importujte klienta z verzované podcesty balíčku a poté zavolejte rozhraní API. Následující ukázka v jazyce TypeScript vypíše vaše projekty Postgres s použitím výchozího ověřování popsaného v Ověření. Metody výpisu zpřístupňují variantu Iter , která prochází výsledky transparentně při iteraci:

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

const client = new PostgresClient({});

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

Další spustitelné příklady, včetně stránkování, dlouhotrvajících operací, zpracování chyb a strategií ověřování, najdete ve složce examples v repozitáři Databricks SDK pro JavaScript na GitHubu.

Ověření

Ve výchozím nastavení klient přečte svou konfiguraci, včetně hostitele a přihlašovacích údajů, z konfiguračního profilu Databricks (~/.databrickscfg) a DATABRICKS_* proměnných prostředí. Když je toto nastavené, nemusíte v kódu předávat žádné přihlašovací údaje, takže například:

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

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

Chcete-li explicitně nakonfigurovat přihlašovací údaje, importujte pomocnou funkci z @databricks/sdk-auth/credentials a předejte ji jako credentials. Následující příklad nakonfiguruje autentizaci pomocí tokenu osobního přístupu 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),
});

Balíček @databricks/sdk-auth poskytuje další poskytovatele přihlašovacích údajů, včetně newU2mCredentials pro OAuth typu user-to-machine (U2M) a newM2mCredentials pro OAuth typu machine-to-machine (M2M), a také výchozí řetězec přihlašovacích údajů. Další informace o ověřování Azure Databricks najdete v tématu Sjednocené ověřování Databricks.

Balíčky

Každé rozhraní API Databricks se publikuje jako samostatný balíček s názvem @databricks/sdk-<api>. Naimportujte jeho klienta z verzované subcesty balíčku. Například @databricks/sdk-postgres/v1 exportuje PostgresClient.

Úplný seznam dostupných balíčků API najdete v části Balíčky v souboru README sady Databricks SDK pro JavaScript.

Sdílené balíčky

Každý klient rozhraní API sdílí tři balíčky a poskytují kusy, které importujete přímo:

Package Description
@databricks/sdk-core klient HTTP, určování konfiguračního profilu, protokolování a typy chyb rozhraní API (ApiError).
@databricks/sdk-auth Zprostředkovatelé přihlašovacích údajů (newPatCredentials, newU2mCredentials, newM2mCredentials) a výchozí řetěz přihlašovacích údajů.
@databricks/sdk-options Typy možností předávané klientům a voláním (ClientOptions, CallOptions).

Dodatečné zdroje

  • Last updated on