Databricks SDK's voor JavaScript

Important

Databricks SDKs voor JavaScript is in bèta. Tijdens de bètaversie raadt Databricks u aan een afhankelijkheid vast te maken aan de specifieke versie van elke Databricks SDK's voor JavaScript-pakket waarvan uw code afhankelijk is, bijvoorbeeld in het bestand van package.json een project.

Meld problemen in de Databricks SDK's voor JavaScript-opslagplaats in GitHub.

Automatiseer Azure Databricks bewerkingen en versnel de ontwikkeling met de Databricks SDK's voor JavaScript. Deze SDK's bieden getypte clients voor de Databricks REST API. Ze hebben een modulaire architectuur, met een afzonderlijk npm-pakket voor elke API (bijvoorbeeld @databricks/sdk-postgres). Installeer alleen de pakketten voor de API's die u gebruikt.

Deze pagina vormt een aanvulling op de Databricks SDK's voor JavaScript README en voorbeelden.

Requirements

Als u de Databricks SDK's voor JavaScript wilt gebruiken, moet uw ontwikkelcomputer over het volgende beschikken:

Aan de slag

  1. Installeer het pakket voor elke API die u nodig hebt. Elke Databricks-API wordt gepubliceerd als een afzonderlijk pakket met de naam @databricks/sdk-<api>. Als u bijvoorbeeld met Postgres wilt werken, voert u de volgende opdracht uit vanuit de hoofdmap van uw Node.js-project:

    npm install @databricks/sdk-postgres

  2. Als deze nog niet is geconfigureerd, stelt u uw ontwikkelcomputer in voor Azure Databricks verificatie.

  3. Importeer de client uit het subpad met versienummer van het pakket en roep vervolgens de API aan. In het volgende TypeScript-voorbeeld worden uw Postgres-projecten weergegeven met behulp van de standaardverificatie die wordt beschreven in Verifiëren. Lijstmethoden bieden een Iter-variant die tijdens het itereren automatisch en transparant door de resultaten pagineert:

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

const client = new PostgresClient({});

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

Zie de voorbeeldenmap in de Databricks SDK's voor JavaScript-opslagplaats in GitHub voor meer uitvoerbare voorbeelden, waaronder paginering, langlopende bewerkingen, foutafhandeling en verificatiestrategieën.

Verifiëren

Standaard leest een client de configuratie, inclusief de host en referenties, uit een Databricks-configuratieprofiel (~/.databrickscfg) en DATABRICKS_* omgevingsvariabelen. Als die zijn ingesteld, hoeft u geen inloggegevens in de code door te geven, dus bijvoorbeeld:

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

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

Als u inloggegevens expliciet wilt configureren, importeert u een hulpfunctie uit @databricks/sdk-auth/credentials en geeft u die mee als credentials. In het volgende voorbeeld wordt verificatie van persoonlijke toegangstokens voor Databricks geconfigureerd.

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

Het @databricks/sdk-auth pakket biedt extra referentieproviders, waaronder newU2mCredentials voor OAuth van gebruiker naar machine (U2M) en newM2mCredentials voor M2M-OAuth (machine-naar-machine) en de standaardreferentieketen. Zie Databricks unified authentication voor meer informatie over Azure Databricks-authenticatie.

Packages

Elke Databricks-API wordt gepubliceerd als een afzonderlijk pakket met de naam @databricks/sdk-<api>. Importeer de client vanuit het subpad met versie van het pakket. Bijvoorbeeld exporteert @databricks/sdk-postgres/v1PostgresClient.

Zie Pakketten in de Databricks SDK's voor JavaScript README voor de volledige lijst met beschikbare API-pakketten.

Gedeelde pakketten

Drie pakketten worden gedeeld door elke API-client en bieden stukken die u rechtstreeks importeert:

Package Description
@databricks/sdk-core De HTTP-client, configuratieprofielomzetting, logboekregistratie en API-fouttypen (ApiError).
@databricks/sdk-auth Referentieproviders (newPatCredentials, newU2mCredentials, newM2mCredentials) en de standaardreferentieketen.
@databricks/sdk-options De optietypen die aan clients en aanroepen worden doorgegeven (ClientOptions, CallOptions).

Aanvullende bronnen

  • Last updated on