스키마 있는 테이블 가져오기 생성(Create Table Import) (V2)
외부 시스템에서 스키마가 있는 표 데이터를 읽는 TableImport 구성을 만듭니다. 출력 데이터셋 RID, 수집 모드, 표시 이름과 원천 커넥터에 맞는 쿼리 구성이 필요합니다.
출력 데이터셋과 브랜치는 생성 후 바꿀 수 없습니다. 신규 가져오기에서 allowSchemaChanges의 기본값은 false이며, true를 지정하면 수집 행의 스키마가 기존 데이터셋과 달라도 가져오기 성공을 허용합니다. 이 옵션을 의도한 스키마 정책에 맞게 정합니다.
HTTP 요청
POST /api/v2/connectivity/connections/{connectionRid}/tableImports
작업 식별자는 v2.createTableImport입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:connectivity-table-import-write 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
connectionRid | string | 필수 | 소스라고도 부르는 Connection의 RID입니다. | ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
본문 형식은 CreateTableImportRequest이며 필수입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
datasetRid | string | 필수 | 출력 데이터셋의 RID입니다. 테이블 가져오기를 생성한 뒤에는 바꿀 수 없습니다. | ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da |
importMode | enum | 필수 | 외부 데이터를 읽고 출력에 반영하는 방식입니다. SNAPSHOT은 이번 실행의 데이터만으로 새 데이터셋 상태를 구성합니다. APPEND는 이전 실행의 데이터에 새 데이터를 추가합니다. 허용값: SNAPSHOT, APPEND. | SNAPSHOT |
displayName | string | 필수 | My table import | |
allowSchemaChanges | boolean | 선택 | 가져온 행의 스키마가 기존 데이터셋의 스키마와 달라도 가져오기 성공을 허용합니다. 새 테이블 가져오기에서는 기본값이 false입니다. | true |
branchName | string | 선택 | 수집 데이터를 담을 출력 브랜치입니다. 대부분의 플랫폼 인스턴스에서는 기본값이 master이며 생성 후에는 바꿀 수 없습니다. | master |
config | TableImportConfig | 필수 | 해당 커넥터 유형의 테이블 가져오기 구성입니다. | 본문 예시 참조 |
config의 구조
7가지 구성 분기와 공통 필드는 테이블 가져오기 쿼리 구성을 따릅니다. 증분 열과 값의 6가지 자료형은 증분 초기 상태에 있습니다.
다음 본문의 식별자와 값은 가상 예시입니다.
{
"datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"importMode": "SNAPSHOT",
"displayName": "My table import",
"allowSchemaChanges": true,
"branchName": "master",
"config": {
"type": "jdbcImportConfig",
"query": "SELECT order_id, order_date FROM example_orders"
}
}
응답
응답 형식은 TableImport입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
rid | string | 필수 | 배치 동기화라고도 부르는 TableImport의 RID입니다. | ri.magritte..extract.27bb4f2b-63b8-44b8-a579-4e2bd65ba158 |
connectionRid | string | 필수 | 이 테이블 가져오기가 사용하는 Connection, 즉 소스의 RID입니다. | ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b |
datasetRid | string | 필수 | 출력 데이터셋의 RID입니다. 테이블 가져오기를 생성한 뒤에는 바꿀 수 없습니다. | ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da |
branchName | string | 선택 | 수집 데이터를 담을 출력 브랜치입니다. 대부분의 플랫폼 인스턴스에서는 기본값이 master이며 생성 후에는 바꿀 수 없습니다. | master |
displayName | string | 필수 | My table import | |
importMode | enum | 필수 | 외부 데이터를 읽고 출력에 반영하는 방식입니다. SNAPSHOT은 이번 실행의 데이터만으로 새 데이터셋 상태를 구성합니다. APPEND는 이전 실행의 데이터에 새 데이터를 추가합니다. 허용값: SNAPSHOT, APPEND. | SNAPSHOT |
allowSchemaChanges | boolean | 필수 | 가져온 행의 스키마가 기존 데이터셋의 스키마와 달라도 가져오기 성공을 허용합니다. 새 테이블 가져오기에서는 기본값이 false입니다. | true |
config | TableImportConfig | 필수 | 해당 커넥터 유형의 테이블 가져오기 구성입니다. | 응답 예시 참조 |
config의 구조
7가지 구성 분기와 공통 필드는 테이블 가져오기 쿼리 구성을 따릅니다. 증분 열과 값의 6가지 자료형은 증분 초기 상태에 있습니다.
가상 테이블 가져오기 구성의 응답 예시입니다.
{
"datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"importMode": "SNAPSHOT",
"displayName": "My table import",
"allowSchemaChanges": true,
"connectionRid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b",
"branchName": "master",
"rid": "ri.magritte..extract.27bb4f2b-63b8-44b8-a579-4e2bd65ba158",
"config": {
"type": "jdbcImportConfig",
"query": "SELECT order_id, order_date FROM example_orders"
}
}
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
TableImportTypeNotSupported | INTERNAL | 500 | 지정한 테이블 가져오기 유형은 Platform API에서 아직 지원하지 않습니다. | tableImportType |
ConnectionDetailsNotDetermined | INTERNAL | 500 | 연결이 지원하는 가져오기 유형 등의 연결 정보를 확인하지 못했습니다. | connectionRid, connectionType |
TableImportNotSupportedForConnection | INVALID_ARGUMENT | 400 | 이 연결은 지정한 구성의 테이블 가져오기 생성 또는 교체를 지원하지 않습니다. | connectionRid, tableImportType |
DatasetNotFound | NOT_FOUND | 404 | 데이터셋이 없거나 호출 토큰으로 접근할 수 없습니다. | datasetRid |
CreateTableImportPermissionDenied | PERMISSION_DENIED | 403 | 테이블 가져오기를 생성할 수 없습니다. | connectionRid |
ConnectionNotFound | NOT_FOUND | 404 | 지정한 연결을 찾을 수 없습니다. | connectionRid |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
가상의 example_orders에서 order_id, order_date를 읽는 예제입니다. 데이터셋 RID, 브랜치, SQL과 연결을 실제 작업 대상으로 바꿉니다. 예제는 스키마 변경을 명시적으로 허용합니다.
cURL
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/tableImports" \
-d '{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","importMode":"SNAPSHOT","displayName":"My table import","allowSchemaChanges":true,"branchName":"master","config":{"type":"jdbcImportConfig","query":"SELECT order_id, order_date FROM example_orders"}}'
Python
Requests 라이브러리가 설치된 Python 환경에서 사용합니다.
import os
import requests
HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
"content-type": "application/json",
"authorization": "Bearer {}".format(TOKEN)
}
request_body = {
"datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"importMode": "SNAPSHOT",
"displayName": "My table import",
"allowSchemaChanges": True,
"branchName": "master",
"config": {
"type": "jdbcImportConfig",
"query": "SELECT order_id, order_date FROM example_orders"
}
}
response = requests.post('https://{}/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/tableImports'.format(HOSTNAME), headers=headers, json=request_body)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateTableImportExample.java 파일에서 사용합니다.
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
public class CreateTableImportExample {
public static void main(String[] args) throws Exception {
String HOSTNAME = System.getenv("FOUNDRY_HOST");
String TOKEN = System.getenv("FOUNDRY_TOKEN");
try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/tableImports");
request.addHeader("content-type", "application/json");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
request.setEntity(new StringEntity("{\"datasetRid\":\"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da\",\"importMode\":\"SNAPSHOT\",\"displayName\":\"My table import\",\"allowSchemaChanges\":true,\"branchName\":\"master\",\"config\":{\"type\":\"jdbcImportConfig\",\"query\":\"SELECT order_id, order_date FROM example_orders\"}}", ContentType.APPLICATION_JSON));
try (CloseableHttpResponse response = httpClient.execute(request)) {
System.out.println(response);
}
}
}
}
JavaScript
fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.
const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;
fetch(`https://${HOSTNAME}/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/tableImports`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${TOKEN}`,
},
body: '{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","importMode":"SNAPSHOT","displayName":"My table import","allowSchemaChanges":true,"branchName":"master","config":{"type":"jdbcImportConfig","query":"SELECT order_id, order_date FROM example_orders"}}'
}).then((response) => {
console.log(response)
});
PowerShell
$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST
$headers = @{
"authorization" = "Bearer $TOKEN"
}
$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/tableImports" `
-Method Post `
-Headers $headers `
-ContentType application/json `
-Body "{`"datasetRid`":`"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`",`"importMode`":`"SNAPSHOT`",`"displayName`":`"My table import`",`"allowSchemaChanges`":true,`"branchName`":`"master`",`"config`":{`"type`":`"jdbcImportConfig`",`"query`":`"SELECT order_id, order_date FROM example_orders`"}}"
$response.content