Databricks JavaScripthez készült SDK-k

Important

A JavaScripthez készült Databricks SDK-k bétaverzióban érhetőek el. A béta időszakában a Databricks azt javasolja, hogy a kódja által használt Databricks JavaScript SDK-csomagok mindegyikénél konkrét verzióhoz rögzítse a függőséget, például egy projekt package.json fájljában.

Jelentse a problémákat a Databricks SDK-k javaScript-adattárában a GitHub.

Automatizálhatja Azure Databricks műveleteket, és felgyorsíthatja a fejlesztést a JavaScripthez készült Databricks SDK-kkal. Ezek az SDK-k gépelt ügyfeleket biztosítanak a Databricks REST API-hoz. Moduláris architektúrával rendelkeznek, minden API-hoz külön npm-csomaggal (például@databricks/sdk-postgres). Csak a használt API-k csomagjait telepítse.

Ez az oldal kiegészíti a JavaScripthez készült Databricks SDK-k README-jét és példáit.

Requirements

A JavaScripthez készült Databricks SDK-k használatához a fejlesztőgépnek a következőkkel kell rendelkeznie:

  • Node.js és npm telepítve.
  • A(z) Azure Databricks-hitelesítés be lett konfigurálva.

Első lépések

  1. Telepítse a csomagot minden szükséges API-hoz. Minden Databricks API külön csomagként @databricks/sdk-<api>van közzétéve. A Postgres használatához például futtassa a következő parancsot a Node.js projekt gyökeréből:

    npm install @databricks/sdk-postgres
    
  2. Ha még nincs konfigurálva, állítsa be a fejlesztőgépet Azure Databricks hitelesítéshez.

  3. Importálja a klienst a csomag verziózott alútvonaláról, majd hívja meg az API-t. Az alábbi TypeScript-példa a Postgres-projekteket sorolja fel a Hitelesítés szakaszban ismertetett alapértelmezett hitelesítéssel. A listametelyek egy olyan változatot Iter fednek fel, amely az iteráció során transzparens módon böngészi az eredményeket:

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

További futtatható példákért, beleértve a lapozást, a hosszan futó műveleteket, a hibakezelést és a hitelesítési stratégiákat, tekintse meg a Példák mappát a Databricks SDK-k JavaScript-adattárában GitHub.

Hitelesítés

Az ügyfél alapértelmezés szerint egy Databricks-konfigurációs profilból (~/.databrickscfg) és DATABRICKS_* környezeti változókból olvassa be a konfigurációját, beleértve a gazdagépet és a hitelesítő adatokat is. Ezekkel a beállításokkal nem kell hitelesítő adatokat átadnia a kódban, így például:

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

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

A hitelesítő adatok explicit módon történő konfigurálásához importáljon egy segédfüggvényt a(z) @databricks/sdk-auth/credentials helyről, és adja át credentials formában. Az alábbi példa a Databricks személyes hozzáférési jogkivonat-hitelesítését konfigurálja.

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

A @databricks/sdk-auth csomag további hitelesítőadat-szolgáltatókat biztosít, beleértve newU2mCredentials a felhasználó–gép (U2M) OAuth és newM2mCredentials a gép–gép (M2M) OAuth szolgáltatást, valamint az alapértelmezett hitelesítőadat-láncot. A Azure Databricks hitelesítéssel kapcsolatos további információkért lásd a Databricks egyesített hitelesítését.

Csomagok

Minden Databricks API külön csomagként @databricks/sdk-<api>van közzétéve. Importálja a klienst a csomag verziózott alútvonaláról. Például: @databricks/sdk-postgres/v1 exportok PostgresClient.

Az elérhető API-csomagok teljes listáját a JavaScript README Databricks SDK-jában található Csomagok című témakörben találja.

Megosztott csomagok

Minden API-ügyfél három csomagot oszt meg, és közvetlenül importált elemeket biztosít:

Package Description
@databricks/sdk-core A HTTP-ügyfél, a konfigurációprofil feloldása, a naplózás és az API-hibatípusok (ApiError).
@databricks/sdk-auth Hitelesítőadat-szolgáltatók (newPatCredentials, newU2mCredentials, ) newM2mCredentialsés az alapértelmezett hitelesítőadat-lánc.
@databricks/sdk-options Az ügyfeleknek és hívásoknak átadott beállítástípusok (ClientOptions, CallOptions).

További források