Important
JavaScript용 Databricks SDK는 베타 버전입니다. 베타 중에 Databricks는 코드가 종속하는 JavaScript용 각 Databricks SDK 패키지의 특정 버전(예: 프로젝트 package.json 파일)에 대한 종속성을 고정하는 것이 좋습니다.
GitHub JavaScript용 Databricks SDK 리포지토리의 문제를 보고합니다.
JavaScript용 Databricks SDK를 사용하여 Azure Databricks 작업을 자동화하고 개발을 가속화합니다. 이러한 SDK는 Databricks REST API에 대해 형식화된 클라이언트를 제공합니다. 각 API에 대해 별도의 npm 패키지가 있는 모듈식 아키텍처가 있습니다(예: @databricks/sdk-postgres). 사용하는 API에 대한 패키지만 설치합니다.
이 페이지에서는 JavaScript 추가 정보 및 예제에 대한 Databricks SDK 를 보완합니다.
요구 사항
JavaScript용 Databricks SDK를 사용하려면 개발 머신에 다음이 있어야 합니다.
시작하기
필요한 각 API에 대한 패키지를 설치합니다. 각 Databricks API는 명명
@databricks/sdk-<api>된 별도의 패키지로 게시됩니다. 예를 들어 Postgres를 사용하려면 Node.js 프로젝트의 루트에서 다음 명령을 실행합니다.npm install @databricks/sdk-postgres아직 구성되지 않은 경우 Azure Databricks 인증을 위해 개발 머신을 설정합니다.
패키지의 버전이 지정된 하위 경로에서 클라이언트를 가져온 다음 API를 호출합니다. 다음 TypeScript 예제에서는 인증에 설명된 기본 인증을 사용하여 Postgres 프로젝트를 나열 합니다. 목록 메서드는
Iter반복할 때 결과를 투명하게 페이지로 표시하는 변형을 노출합니다.import { PostgresClient } from '@databricks/sdk-postgres/v1'; const client = new PostgresClient({}); for await (const project of client.listProjectsIter({})) { console.log(project.name); }
페이지 매김, 장기 실행 작업, 오류 처리 및 인증 전략을 포함하여 실행 가능한 더 많은 예제는 GitHub JavaScript 리포지토리용 Databricks SDK의 예제 폴더를 참조하세요.
인증
기본적으로 클라이언트는 Databricks 구성 프로필 (~/.databrickscfg) DATABRICKS_* 및 환경 변수에서 호스트 및 자격 증명을 포함한 해당 구성을 읽습니다. 이러한 집합을 사용하면 코드에서 자격 증명을 전달할 필요가 없으므로 다음과 같습니다.
import { PostgresClient } from '@databricks/sdk-postgres/v1';
// Resolves the host and credentials from the DEFAULT profile and DATABRICKS_* environment variables.
const client = new PostgresClient({});
자격 증명을 명시적으로 구성하려면 @databricks/sdk-auth/credentials에서 헬퍼를 가져오고 이를 credentials로 전달합니다. 다음 예제에서는 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),
});
이 패키지는 @databricks/sdk-auth 기본 자격 증명 체인뿐만 아니라 U2M(사용자 간) OAuth 및 newU2mCredentials M2M(컴퓨터 간) OAuth를 비롯한 newM2mCredentials 추가 자격 증명 공급자를 제공합니다. Azure Databricks 인증에 대한 자세한 내용은 Databricks 통합 인증을 참조하세요.
Packages
각 Databricks API는 명명 @databricks/sdk-<api>된 별도의 패키지로 게시됩니다. 패키지의 버전이 지정된 하위 경로에서 클라이언트를 가져옵니다. 예를 들어, @databricks/sdk-postgres/v1은 PostgresClient을 내보냅니다.
사용 가능한 API 패키지의 전체 목록은 JavaScript 추가 정보용 Databricks SDK의 패키지를 참조하세요.
공유 패키지
세 개의 패키지는 모든 API 클라이언트에서 공유되며 직접 가져오는 부분을 제공합니다.
| Package | 설명 |
|---|---|
@databricks/sdk-core |
HTTP 클라이언트, 구성 프로필 확인, 로깅 및 API 오류 유형(ApiError)입니다. |
@databricks/sdk-auth |
자격 증명 공급자(newPatCredentials, newU2mCredentials, newM2mCredentials) 및 기본 자격 증명 체인입니다. |
@databricks/sdk-options |
클라이언트 및 호출(ClientOptions, CallOptions)에 전달되는 옵션 유형입니다. |
추가 리소스
- Databricks JavaScript SDK README
- JavaScript용 Databricks SDK 예제
- Databricks 통합 인증