Dataform에 패키지 설치

이 문서에서는 Dataform 저장소에 자바스크립트 패키지를 설치하고, 자바스크립트 파일 및 SQLX 파일로 가져와 패키지를 사용하여 Dataform에서 SQL 워크플로를 개발하는 방법을 보여줍니다.

Dataform에서 패키지를 사용하려면 저장소에 설치해야 합니다.

Dataform에 다음 유형의 패키지를 설치할 수 있습니다.

게시된 공개 NPM 패키지
게시되지 않은 공개 NPM 패키지
인증된 비공개 NPM 패키지

그런 다음 자바스크립트 또는 SQLX 파일에서 패키지를 사용하려면 패키지의 선택한 콘텐츠를 파일로 가져와야 합니다. 또한 선택한 콘텐츠 대신 전체 패키지를 자바스크립트 또는 SQLX 파일로 가져올 수 있습니다.

시작하기 전에

Google Cloud 콘솔에서 Dataform 페이지로 이동합니다.

Dataform 페이지로 이동
저장소를 선택하거나 만듭니다.
개발 작업공간을 선택하거나 만듭니다.
[선택사항] 비공개 패키지를 설치하려면 비공개 패키지를 인증합니다.

필요한 역할

패키지를 가져오는 데 필요한 권한을 얻으려면 관리자에게 작업공간의 Dataform 편집자(roles/dataform.editor) IAM 권한을 부여해 달라고 요청하세요. 역할 부여에 대한 자세한 내용은 액세스 관리를 참조하세요.

커스텀 역할이나 다른 사전 정의된 역할을 통해 필요한 권한을 얻을 수도 있습니다.

Dataform 저장소에 패키지 설치

Dataform 저장소에 패키지를 설치하려면 package.json 파일에 종속 항목으로 추가해야 합니다. package.json 파일의 종속 항목 정의 형식은 패키지 유형에 따라 다릅니다. workflow_settings.yaml 파일이 dataformCoreVersion을 지정하므로 package.json 파일이 없으면 workflow_settings.yaml에서 dataformCoreVersion을 삭제한 후 package.json 파일을 만들고 @dataform/core를 종속 항목으로 추가합니다.

Dataform 저장소에 패키지를 설치하려면 다음 단계를 수행합니다.

작업공간의 파일 창에서 package.json을 선택합니다.
패키지를 dependencies 블록에 추가합니다.
1. 게시된 공개 NPM 패키지를 다음 형식으로 추가합니다.
```
"PACKAGE-NAME": "PACKAGE-VERSION"
```
  다음을 바꿉니다.
  - PACKAGE-NAME: 패키지 이름
  - PACKAGE-VERSION을 게시된 공개 NPM 패키지의 최신 버전으로 바꿉니다.
2. 게시되지 않은 공개 NPM 패키지를 다음 형식으로 추가합니다.
```
"PACKAGE-NAME": "PACKAGE-URL"
```
  다음을 바꿉니다.
  - PACKAGE-NAME: 패키지 이름
  - PACKAGE-URL을 제3자 패키지 저장소의 tar.gz URL(예: https://github.com/user/sample-package-repository/archive/master.tar.gz)로 바꿉니다.
3. 인증된 비공개 NPM 패키지를 다음 형식으로 추가합니다.
```
"REGISTRY-SCOPE/PACKAGE-NAME": "PACKAGE-URL"
```
  다음을 바꿉니다.
  - REGISTRY-SCOPE: 패키지 이름. REGISTRY-SCOPE은 저장소의 .nmprc 파일에 정의된 레지스트리 범위와 일치해야 합니다.
  - PACKAGE-NAME: 패키지 이름
  - PACKAGE-URL: 패키지 저장소의 tar.gz URL(예: https://github.com/user/sample-package-repository/archive/master.tar.gz)
패키지 설치를 클릭합니다.
변경사항을 커밋하고 푸시합니다.

다음 코드 샘플은 .package.json 파일에 추가된 공개 오픈소스 지연 변경 측정기준 패키지를 보여줍니다.

 ```
 {
   "name": "repository-name",
   "dependencies": {
     "@dataform/core": "2.0.3",
     "dataform-scd": "https://github.com/dataform-co/dataform-scd/archive/0.3.tar.gz"
   }
 }
 ```

Dataform에서 자바스크립트 파일로 패키지 함수 또는 상수 가져오기

Dataform의 자바스크립트 파일 내 패키지에서 함수 또는 상수를 사용하려면 먼저 파일로 가져와야 합니다.

패키지에서 자바스크립트 파일로 함수 또는 상수를 가져오려면 다음 단계를 따르세요.

작업공간의 파일 창에서 패키지를 사용할 .js 파일을 선택합니다.
파일에서 함수 또는 상수를 다음 형식으로 가져옵니다.
```
const { EXPORT-NAME } = require("PACKAGE-NAME");
```
1. EXPORT-NAME을 패키지 index.js 파일의 module.exports에서 선언된 사용하려는 함수 또는 상수의 이름으로 바꿉니다.
2. PACKAGE-NAME을 사용하려는 패키지의 이름으로 바꿉니다.
변경사항을 커밋하고 푸시합니다.

다음 코드 샘플은 자바스크립트 파일에서 가져오고 사용한 postoffice 패키지의 getDomain 함수를 보여줍니다.

/*
 * Contents of postoffice index.js:
 * module.exports = { getDomain };
 */

const { getDomain } = require("postoffice");
getDomain();

Dataform에서 전체 패키지를 자바스크립트 파일로 가져옵니다.

선택한 함수 또는 상수를 자바스크립트 파일로 가져오는 대신 전체 패키지를 자바스크립트 파일로 가져오려면 다음 단계를 따르세요.

작업공간의 파일 창에서 패키지를 사용할 .js 파일을 선택합니다.
파일에서 패키지를 다음 형식으로 가져옵니다.
```
const CONSTANT-NAME = require("PACKAGE-NAME");
```
1. CONSTANT-NAME을 상수 이름으로 바꿉니다.
2. PACKAGE-NAME을 사용하려는 패키지의 이름으로 바꿉니다.
변경사항을 커밋하고 푸시합니다.

다음 코드 샘플은 자바스크립트 파일에 사용된 가져온 postoffice 패키지의 getDomain 함수를 보여줍니다.

/*
 * Contents of postoffice index.js:
 * module.exports = { getDomain };
 */

const postoffice = require("postoffice");
postoffice.getDomain();

Dataform에서 SQLX 파일로 패키지 함수 또는 상수 가져오기

SQLX 파일 내 패키지에서 함수 또는 상수를 사용하려면 먼저 파일로 가져와야 합니다.

패키지에서 SQLX 파일로 함수 또는 상수를 가져오려면 다음 단계를 따르세요.

작업공간의 파일 창에서 패키지를 사용할 .sqlx 파일을 선택합니다.
파일에 다음 js 블록을 입력합니다.
```
js {
  const { EXPORT-NAME } = require("PACKAGE-NAME");
}
```
1. EXPORT-NAME을 패키지 index.js 파일의 module.exports에서 선언된 사용하려는 함수 또는 상수의 이름으로 바꿉니다.
2. PACKAGE-NAME을 사용하려는 패키지의 이름으로 바꿉니다.
변경사항을 커밋하고 푸시합니다.

다음 코드 샘플은 js 블록에서 가져오고 SQLX 파일의 SELECT 문에서 사용된 postoffice 패키지의 getDomain 함수를 보여줍니다.

/*
 * Contents of postoffice index.js:
 * module.exports = { getDomain };
 */

config {
    type: "table",
}

js {
  const { getDomain } = require("postoffice");
}

SELECT ${getDomain("email")} as test

Dataform에서 SQLX 파일로 전체 패키지 가져오기

선택한 함수 또는 상수를 자바스크립트 파일로 가져오는 대신 전체 패키지를 SQLX 파일로 가져오려면 다음 단계를 따르세요.

작업공간의 파일 창에서 패키지를 사용할 .sqlx 파일을 선택합니다.
파일에서 패키지를 다음 형식으로 가져옵니다.
```
js {
  const CONSTANT-NAME = require("PACKAGE-NAME");
}
```
1. CONSTANT-NAME을 상수 이름으로 바꿉니다.
2. PACKAGE-NAME을 사용하려는 패키지의 이름으로 바꿉니다.
변경사항을 커밋하고 푸시합니다.

다음 코드 샘플은 js 블록에서 가져온 postoffice 패키지와 SQLX 파일의 SELECT 문에서 사용된 getDomain 함수를 보여줍니다.

/*
 * Contents of postoffice index.js:
 * module.exports = { getDomain };
 */

config {
    type: "table",
}

js {
  const postoffice = require("postoffice");
}

SELECT ${postoffice.getDomain("email")} as test

다음 단계

Dataform에서 비공개 NPM 패키지를 인증하는 방법은 Dataform에서 비공개 패키지 인증을 참조하세요.
Dataform의 패키지에 대한 자세한 내용은 패키지를 사용하여 여러 저장소 간에 코드 재사용을 참조하세요.
Dataform에서 자체 패키지를 만드는 방법은 Dataform에서 패키지 만들기를 참조하세요.
Dataform에서 오픈소스 패키지를 사용하는 방법은 Dataform에서 지연 변경 측정기준 사용을 참조하세요.