Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Important
SDK Databricks untuk JavaScript ada di Beta. Selama Beta, Databricks merekomendasikan agar Anda menyematkan dependensi pada versi tertentu dari setiap paket Databricks SDK untuk JavaScript yang bergantung pada kode Anda, misalnya dalam file proyek package.json .
Laporkan masalah di SDK Databricks untuk repositori JavaScript di GitHub.
Mengotomatiskan operasi Azure Databricks dan mempercepat pengembangan dengan SDK Databricks untuk JavaScript. SDK ini menyediakan klien bertipe untuk API REST Databricks. Mereka memiliki arsitektur modular, dengan paket npm terpisah untuk setiap API (misalnya, @databricks/sdk-postgres). Instal hanya paket untuk API yang Anda gunakan.
Halaman ini melengkapi SDK Databricks untuk JavaScript README dan contoh.
Persyaratan
Untuk menggunakan SDK Databricks untuk JavaScript, komputer pengembangan Anda harus memiliki:
- Node.js dan npm terinstal.
- Autentikasi Azure Databricks dikonfigurasi.
Mulai sekarang!
Instal paket untuk setiap API yang Anda butuhkan. Setiap API Databricks diterbitkan sebagai paket terpisah bernama
@databricks/sdk-<api>. Misalnya, untuk bekerja dengan Postgres, jalankan perintah berikut dari akar proyek Node.js Anda:npm install @databricks/sdk-postgresJika belum dikonfigurasi, siapkan komputer pengembangan Anda untuk autentikasi Azure Databricks.
Impor klien dari subpath berversi milik paket, kemudian panggil API. Contoh TypeScript berikut mencantumkan proyek Postgres Anda, menggunakan autentikasi default yang dijelaskan dalam Autentikasi. Metode list menyediakan varian
Iteryang membagi hasil ke dalam beberapa halaman secara transparan saat Anda mengiterasinya:import { PostgresClient } from '@databricks/sdk-postgres/v1'; const client = new PostgresClient({}); for await (const project of client.listProjectsIter({})) { console.log(project.name); }
Untuk contoh yang lebih dapat dijalankan, termasuk penomoran halaman, operasi jangka panjang, penanganan kesalahan, dan strategi autentikasi, lihat folder contoh di SDK Databricks untuk repositori JavaScript di GitHub.
Mengotentikasi
Secara bawaan, klien membaca konfigurasi, termasuk host dan kredensial, dari profil konfigurasi Databricks (~/.databrickscfg) dan variabel lingkungan DATABRICKS_*. Dengan set tersebut, Anda tidak perlu meneruskan kredensial apa pun dalam kode, jadi misalnya:
import { PostgresClient } from '@databricks/sdk-postgres/v1';
// Resolves the host and credentials from the DEFAULT profile and DATABRICKS_* environment variables.
const client = new PostgresClient({});
Untuk mengonfigurasi kredensial secara eksplisit, impor pembantu dari @databricks/sdk-auth/credentials dan berikan sebagai credentials. Contoh berikut mengonfigurasi autentikasi token akses pribadi 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),
});
Paket ini @databricks/sdk-auth menyediakan penyedia kredensial tambahan, termasuk newU2mCredentials untuk OAuth pengguna-ke-mesin (U2M) dan newM2mCredentials untuk OAuth mesin-ke-mesin (M2M), serta rantai kredensial default. Untuk informasi selengkapnya tentang autentikasi Azure Databricks, lihat Autentikasi terpadu Databricks.
Paket
Setiap API Databricks diterbitkan sebagai paket terpisah bernama @databricks/sdk-<api>. Impor kliennya dari subjalur versi paket tersebut. Misalnya, @databricks/sdk-postgres/v1 mengekspor PostgresClient.
Untuk daftar lengkap paket API yang tersedia, lihat Paket di Databricks SDK untuk JavaScript README.
Paket bersama
Tiga paket dibagikan oleh setiap klien API dan menyediakan bagian yang Anda impor secara langsung:
| Package | Description |
|---|---|
@databricks/sdk-core |
Klien HTTP, resolusi profil konfigurasi, pengelogan, dan jenis kesalahan API (ApiError). |
@databricks/sdk-auth |
Penyedia kredensial (newPatCredentials, newU2mCredentials, newM2mCredentials) dan rantai kredensial default. |
@databricks/sdk-options |
Jenis opsi diteruskan ke klien dan panggilan (ClientOptions, CallOptions). |
Sumber daya tambahan
- Databricks SDK untuk JavaScript README
- Contoh SDK Databricks untuk JavaScript
- Autentikasi terpadu Databricks