SDK di Databricks per JavaScript

Automatizzare le operazioni di Azure Databricks e accelerare lo sviluppo con gli SDK di Databricks per JavaScript. Questi SDK forniscono client tipizzati per l'API REST di Databricks. Hanno un'architettura modulare, con un pacchetto npm separato per ogni API (ad esempio, @databricks/sdk-postgres). Installare solo i pacchetti per le API usate.

Questa pagina integra gli SDK di Databricks per javaScript README ed esempi.

Requisiti

Per usare gli SDK di Databricks per JavaScript, il computer di sviluppo deve avere:

• Node.js e npm installati.
• Autenticazione di Azure Databricks configurata.

Inizia subito

1. Installare il pacchetto per ogni API necessaria. Ogni API di Databricks viene pubblicata come pacchetto separato denominato @databricks/sdk-<api>. Ad esempio, per usare Postgres, eseguire il comando seguente dalla radice del progetto Node.js:

   npm install @databricks/sdk-postgres
   

2. Se non è già configurato, configura il computer di sviluppo per l'autenticazione ad Azure Databricks.

3. Importare il client dal sottopercorso con versione del pacchetto, quindi chiamare l'API. L'esempio TypeScript seguente elenca i progetti Postgres usando l'autenticazione predefinita descritta in Autenticare. I metodi List espongono una variante Iter che impagina i risultati in modo trasparente mentre si itera:

   import { PostgresClient } from '@databricks/sdk-postgres/v1';
   
   const client = new PostgresClient({});
   
   for await (const project of client.listProjectsIter({})) {
     console.log(project.name);
   }
   

Per esempi più eseguibili, tra cui paginazione, operazioni a esecuzione prolungata, gestione degli errori e strategie di autenticazione, vedere la cartella degli esempi nel repository Databricks SDK per JavaScript in GitHub.

Autenticare

Per impostazione predefinita, un client legge la configurazione, inclusi l'host e le credenziali, da un profilo di configurazione di Databricks (~/.databrickscfg) e DATABRICKS_* dalle variabili di ambiente. Con questi set non è necessario passare credenziali nel codice, ad esempio:

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

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

Per configurare le credenziali in modo esplicito, importare un helper da @databricks/sdk-auth/credentials e passarlo come credentials. L'esempio seguente configura l'autenticazione del token di accesso personale di 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),
});

Il @databricks/sdk-auth pacchetto fornisce provider di credenziali aggiuntivi, tra cui newU2mCredentials OAuth da utente a computer (U2M) e newM2mCredentials per OAuth da computer a computer (M2M), nonché la catena di credenziali predefinita. Per altre informazioni sull'autenticazione Azure Databricks, vedere Autenticazione unificata di Databricks.

Packages

Ogni API di Databricks viene pubblicata come pacchetto separato denominato @databricks/sdk-<api>. Importare il relativo client dal sottopercorso versionato del pacchetto. Ad esempio, @databricks/sdk-postgres/v1 esporta PostgresClient.

Per l'elenco completo dei pacchetti API disponibili, vedere Pacchetti negli SDK di Databricks per JavaScript README.

Pacchetti condivisi

Tre pacchetti vengono condivisi da ogni client API e forniscono parti importate direttamente:

Risorse aggiuntive

• SDK di Databricks per JavaScript README
• Esempi di SDK di Databricks per JavaScript
• Autenticazione unificata di Databricks