Pular para o conteúdo principal
Última atualização em

SDKs do Databricks para JavaScript

info

Beta

O Databricks SDKs for JavaScript está em Beta. Durante o Beta, o Databricks recomenda que se pin uma dependência na versão específica de cada pacote do Databricks SDKs for JavaScript da qual seu código depende, por exemplo, no arquivo package.json de um projeto.

Relate problemas no repositório dos SDKs do Databricks para JavaScript no GitHub.

Automatize as operações do Databricks e acelere o desenvolvimento com os SDKs do Databricks para JavaScript. Esses SDKs fornecem clientes tipados para a API REST do Databricks. Eles têm uma arquitetura modular , com um pacote npm separado para cada API (por exemplo, @databricks/sdk-postgres). Instale apenas os pacotes para as APIs que você usa.

Esta página complementa os README e exemplos dos SDKs do Databricks para JavaScript.

Requisitos​

Para usar os SDKs do Databricks para JavaScript, sua máquina de desenvolvimento deve ter:

Começar​

  1. Instale o pacote para cada API de que você precisa. Cada API do Databricks é publicada como um pacote separado chamado @databricks/sdk-<api>. Por exemplo, para trabalhar com o Postgres, execute o seguinte comando a partir da raiz do seu projeto Node.js:

    Bash
    npm install @databricks/sdk-postgres

  2. Se ainda não estiver configurado, configure sua máquina de desenvolvimento para autenticação do Databricks.

  3. Importe o cliente do subcaminho versionado do pacote e, em seguida, chame a API. O exemplo TypeScript a seguir lista seus projetos Postgres, usando a autenticação default descrita em Autenticar. Os métodos de lista expõem uma variante Iter que pagina os resultados de forma transparente à medida que você itera:

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

    const client = new PostgresClient({});

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

Para mais exemplos executáveis, incluindo paginação, operações de longa execução, tratamento de erros e estratégias de autenticação, consulte a pasta exemplos no repositório Databricks SDKs para JavaScript no GitHub.

Autenticar​

Por default, um cliente lê sua configuração, incluindo o host e as credenciais, de um perfil de configuração do Databricks (~/.databrickscfg) e DATABRICKS_* variáveis de ambiente. Com isso definido, você não precisa passar nenhuma credencial no código, então, por exemplo:

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({});

Para configurar credenciais explicitamente, importe um auxiliar de @databricks/sdk-auth/credentials e passe-o como credentials. O exemplo a seguir configura a autenticação por access token pessoal do 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),
});

O pacote @databricks/sdk-auth fornece provedores de credenciais adicionais, incluindo newU2mCredentials para OAuth de usuário para máquina (U2M) e newM2mCredentials para OAuth de máquina para máquina (M2M), bem como a cadeia de credenciais default. Para obter mais informações sobre a autenticação Databricks, consulte autenticação unificada Databricks.

pacote​

Cada API do Databricks é publicada como um pacote separado chamado @databricks/sdk-<api>. Importe seu cliente do subcaminho versionado do pacote. Por exemplo, @databricks/sdk-postgres/v1 exporta PostgresClient.

Para obter a lista completa de pacotes de API disponíveis, consulte Pacotes no README dos SDKs do Databricks para JavaScript.

Pacotes compartilhados​

Três pacotes são compartilhados por cada cliente de API e fornecem peças que você importa diretamente:

Pacote

Descrição

@databricks/sdk-core

O cliente HTTP, a resolução do perfil de configuração, o registro em log e os tipos de erro da API (ApiError).

@databricks/sdk-auth

Provedores de credenciais (newPatCredentials, newU2mCredentials, newM2mCredentials) e a cadeia de credenciais default.

@databricks/sdk-options

Os tipos de opção passados para clientes e chamadas (ClientOptions, CallOptions).

Recursos adicionais​

Nesta página