Databricks-SDKs für JavaScript

Important

Databricks SDKs für JavaScript befindet sich in Der Betaversion. Während der Beta empfiehlt Databricks, die Abhängigkeit von jedem Databricks SDK for JavaScript-Paket, von dem Ihr Code abhängt, auf die jeweils konkrete Version festzulegen, zum Beispiel in der package.json-Datei eines Projekts.

Melden Sie Probleme im Databricks-SDKs für javaScript-Repository in GitHub.

Automatisieren Sie Azure Databricks Vorgänge, und beschleunigen Sie die Entwicklung mit den Databricks-SDKs für JavaScript. Diese SDKs stellen typisiert Clients für die Databricks-REST-API bereit. Sie verfügen über eine modulare Architektur mit einem separaten npm-Paket für jede API (z. B @databricks/sdk-postgres. ). Installieren Sie nur die Pakete für die von Ihnen verwendeten APIs.

Diese Seite ergänzt die Databricks-SDKs für JavaScript README und Beispiele.

Requirements

Um die Databricks-SDKs für JavaScript zu verwenden, muss Ihr Entwicklungscomputer folgendes haben:

Get started

  1. Installieren Sie das Paket für jede api, die Sie benötigen. Jede Databricks-API wird als separates Paket mit dem Namen @databricks/sdk-<api>veröffentlicht. Um beispielsweise mit Postgres zu arbeiten, führen Sie den folgenden Befehl aus dem Stammverzeichnis Ihres Node.js Projekts aus:

    npm install @databricks/sdk-postgres

  2. Wenn sie noch nicht konfiguriert ist, richten Sie Ihren Entwicklungscomputer für Azure Databricks Authentifizierung ein.

  3. Importieren Sie den Client aus dem versionsierten Unterpfad des Pakets, und rufen Sie dann die API auf. Im folgenden TypeScript-Beispiel werden Ihre Postgres-Projekte aufgelistet, wobei die unter "Authenticate" beschriebene Standardauthentifizierung verwendet wird. Listenmethoden stellen eine Iter-Variante bereit, die beim Iterieren transparent durch die Ergebnisse paginiert:

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

const client = new PostgresClient({});

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

Weitere ausführbare Beispiele, darunter Paginierung, lang andauernde Vorgänge sowie Strategien zur Fehlerbehandlung und Authentifizierung, finden Sie im Ordner examples im GitHub-Repository der Databricks SDKs für JavaScript.

Authentifizieren

Standardmäßig liest ein Client seine Konfiguration, einschließlich des Hosts und der Anmeldeinformationen, aus einem Databricks-Konfigurationsprofil (~/.databrickscfg) und DATABRICKS_* Umgebungsvariablen. Wenn diese festgelegt sind, müssen Sie keine Anmeldeinformationen im Code angeben, z. B.:

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

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

Um Anmeldeinformationen explizit zu konfigurieren, importieren Sie ein Hilfsprogramm aus @databricks/sdk-auth/credentials , und übergeben Sie sie als credentials. Im folgenden Beispiel wird die Authentifizierung des persönlichen Zugriffstokens von Databricks konfiguriert.

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),
});

Das Paket @databricks/sdk-auth bietet zusätzliche Anmeldeinformationsprovider, darunter newU2mCredentials für Benutzer-zu-Maschine-OAuth (U2M) und newM2mCredentials für Maschine-zu-Maschine-OAuth (M2M) sowie die standardmäßige Anmeldeinformationskette. Weitere Informationen zur Azure Databricks Authentifizierung finden Sie unter "Databricks unified authentication".

Pakete

Jede Databricks-API wird als separates Paket mit dem Namen @databricks/sdk-<api>veröffentlicht. Importieren Sie den Client aus dem versionierten Unterpfad des Pakets. Zum Beispiel exportiert @databricks/sdk-postgres/v1PostgresClient.

Die vollständige Liste der verfügbaren API-Pakete finden Sie unter "Pakete " in den Databricks-SDKs für JavaScript README.

Geteilte Pakete

Drei Pakete werden von jedem API-Client freigegeben und stellen Teile bereit, die Sie direkt importieren:

Package Description
@databricks/sdk-core Der HTTP-Client, die Auflösung von Konfigurationsprofilen, die Protokollierung und die API-Fehlertypen (ApiError).
@databricks/sdk-auth Anmeldeinformationsanbieter (newPatCredentials, newU2mCredentials, newM2mCredentials) und die Standardanmeldeinformationskette.
@databricks/sdk-options Die Optionstypen, die an Clients und Anrufe übergeben werden (ClientOptions, CallOptions).

Weitere Ressourcen

  • Last updated on