Aller au contenu principal
Dernière mise à jour le

SDKs Databricks pour JavaScript

info

Bêta

Les Databricks SDK pour JavaScript sont en version bêta. Pendant la version Beta, Databricks vous recommande de pin une dépendance sur la version spécifique de chaque package Databricks SDKs pour JavaScript dont votre code dépend, par exemple dans le fichier package.json d'un projet.

Signalez les problèmes dans le repository Databricks SDK pour JavaScript sur GitHub.

Automatisez les opérations Databricks et accélérez le développement avec les SDK Databricks pour JavaScript. Ces SDKs fournissent des clients typés pour l'API REST Databricks. Elles possèdent une *architecture modulaire*, avec un package npm distinct pour chaque API (par@databricks/sdk-postgres exemple,). Installez uniquement les packages des APIs que vous utilisez.

Cette page complète les SDK Databricks pour JavaScript README et exemples.

Exigences​

Pour utiliser les SDK Databricks pour JavaScript, votre machine de développement doit disposer de :

Get start​

  1. Installez le package pour chaque API dont vous avez besoin. Chaque API Databricks est publiée en tant que package séparé nommé @databricks/sdk-<api>. Par exemple, pour travailler avec Postgres, exécutez la commande suivante à partir de la racine de votre projet Node.js :

    Bash
    npm install @databricks/sdk-postgres

  2. Si ce n'est pas déjà configuré, configurez votre machine de développement pour l'authentification Databricks.

  3. Importez le client à partir du sous-chemin versionné du package, puis appelez l'API. L'exemple TypeScript suivant répertorie vos projets Postgres, en utilisant l'authentification default décrite dans Authentifier. Les méthodes de liste exposent une variante Iter qui pagine les résultats de manière transparente lorsque vous itérez :

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

    const client = new PostgresClient({});

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

Pour plus d'exemples exécutables, y compris la pagination, les opérations de longue durée, la gestion des erreurs et les stratégies d'authentification, consultez le dossier exemples dans le repository Databricks SDKs pour JavaScript sur GitHub.

Authentifier​

Par default, un client lit sa configuration, y compris l’hôte et les informations d’identification, à partir d’un profil de configuration Databricks (~/.databrickscfg) et des variables d’environnement DATABRICKS_*. Une fois ceux-ci définis, vous n’avez pas besoin de transmettre d’informations d’identification dans le code, par exemple :

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

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

Pour configurer explicitement les identifiants, importez un utilitaire de @databricks/sdk-auth/credentials et transmettez-le en tant que credentials. L'exemple suivant configure l'authentification par jeton d'accès personnel Databricks.

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

Le package @databricks/sdk-auth fournit des fournisseurs d'informations d'identification supplémentaires, y compris newU2mCredentials pour OAuth utilisateur-machine (U2M) et newM2mCredentials pour OAuth machine-machine (M2M), ainsi que la chaîne d'informations d'identification par default. Pour plus d’informations sur l’authentification Databricks, consultez l’authentification unifiée Databricks.

package​

Chaque API Databricks est publiée en tant que package distinct nommé @databricks/sdk-<api>. Importez son client à partir du sous-chemin versionné du package. Par exemple, @databricks/sdk-postgres/v1 exporte PostgresClient.

Pour la liste complète des packages API disponibles, voir Packages dans le fichier README des SDK Databricks pour JavaScript.

packages partagés​

Trois packages sont partagés par chaque client API et fournissent des éléments que vous importez directement :

Package

Description

@databricks/sdk-core

Le client HTTP, la résolution de profil de configuration, la journalisation et les types d'erreur d'API (ApiError).

@databricks/sdk-auth

Fournisseurs d'identifiants (newPatCredentials, newU2mCredentials, newM2mCredentials) et chaîne d'identifiants par default.

@databricks/sdk-options

Les types d'options passés aux clients et aux appels (ClientOptions, CallOptions).

Package

Description

@databricks/sdk-core

Le client HTTP, la résolution de profil de configuration, la journalisation et les types d'erreur d'API (ApiError).

@databricks/sdk-auth

Fournisseurs d'identifiants (newPatCredentials, newU2mCredentials, newM2mCredentials) et chaîne d'identifiants par default.

@databricks/sdk-options

Les types d'options passés aux clients et aux appels (ClientOptions, CallOptions).

Ressources supplémentaires​

Sur cette page