외부 테이블을 가상 테이블로 등록(Create Virtual Table) (V2)

외부의 원천 테이블을 지정한 상위 폴더에 VirtualTable로 등록합니다. 등록한 리소스는 Foundry의 데이터 접근 API를 통해 조회할 수 있습니다. 등록 작업이므로 사용할 연결과 상위 폴더, 이름 및 보안 표지를 확인합니다.

parentRid, name, config는 필수입니다. markings는 선택적인 보안 표지 ID 목록입니다. 같은 폴더에 같은 이름이 있으면 HTTP 409가 발생하며, 해당 연결을 가상 테이블 등록에 사용할 권한도 필요합니다.

HTTP 요청

POST /api/v2/connectivity/connections/{connectionRid}/virtualTables

작업 식별자는 v2.createVirtualTable입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:connectivity-virtual-table-write 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

지정할 쿼리 매개변수가 없습니다.

요청 본문

본문 형식은 CreateVirtualTableRequest이며 필수입니다.

markings의 구조

배열 항목은 MarkingId이며 자료형은 string입니다.

보안 표지의 ID입니다.

config의 구조

7가지 원천 포인터의 필수 및 선택 필드와 파일 형식, 경로 및 카탈로그 조건은 가상 테이블 구성을 따릅니다.

다음 본문의 식별자와 값은 가상 예시입니다.

{
  "markings": [
    "18212f9a-0e63-4b79-96a0-aae04df23336"
  ],
  "parentRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
  "name": "my_table",
  "config": {
    "type": "snowflake",
    "database": "MY_DATABASE",
    "schema": "PUBLIC",
    "table": "MY_TABLE"
  }
}

응답

생성한 VirtualTable의 RID, 이름, 상위 폴더, 원천 포인터와 보안 표지를 반환합니다. 입력의 config는 응답에서도 필수입니다.

config의 구조

7가지 원천 포인터의 필수 및 선택 필드와 파일 형식, 경로 및 카탈로그 조건은 가상 테이블 구성을 따릅니다.

markings의 구조

배열 항목은 MarkingId이며 자료형은 string입니다.

보안 표지의 ID입니다.

Snowflake 테이블을 등록했을 때 받는 응답의 가상 예시입니다.

{
  "markings": [
    "18212f9a-0e63-4b79-96a0-aae04df23336"
  ],
  "parentRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
  "name": "my_table",
  "rid": "ri.foundry.main.table.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
  "config": {
    "type": "snowflake",
    "database": "MY_DATABASE",
    "schema": "PUBLIC",
    "table": "MY_TABLE"
  }
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

Snowflake 테이블을 등록하는 가상 예제입니다. Connection RID는 실제 Snowflake 연결로, 데이터베이스와 스키마 및 테이블 이름은 그 연결에서 접근할 수 있는 원천 값으로 바꿉니다. 상위 폴더와 표지 ID도 실제 등록 정책에 맞게 지정합니다.

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/virtualTables" \
	-d '{"markings":["18212f9a-0e63-4b79-96a0-aae04df23336"],"parentRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"my_table","config":{"type":"snowflake","database":"MY_DATABASE","schema":"PUBLIC","table":"MY_TABLE"}}'

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 = {
    "markings": [
        "18212f9a-0e63-4b79-96a0-aae04df23336"
    ],
    "parentRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
    "name": "my_table",
    "config": {
        "type": "snowflake",
        "database": "MY_DATABASE",
        "schema": "PUBLIC",
        "table": "MY_TABLE"
    }
}

response = requests.post('https://{}/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/virtualTables'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateVirtualTableExample.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 CreateVirtualTableExample {
    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/virtualTables");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"markings\":[\"18212f9a-0e63-4b79-96a0-aae04df23336\"],\"parentRid\":\"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791\",\"name\":\"my_table\",\"config\":{\"type\":\"snowflake\",\"database\":\"MY_DATABASE\",\"schema\":\"PUBLIC\",\"table\":\"MY_TABLE\"}}", 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/virtualTables`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"markings":["18212f9a-0e63-4b79-96a0-aae04df23336"],"parentRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"my_table","config":{"type":"snowflake","database":"MY_DATABASE","schema":"PUBLIC","table":"MY_TABLE"}}'
}).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/virtualTables" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"markings`":[`"18212f9a-0e63-4b79-96a0-aae04df23336`"],`"parentRid`":`"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791`",`"name`":`"my_table`",`"config`":{`"type`":`"snowflake`",`"database`":`"MY_DATABASE`",`"schema`":`"PUBLIC`",`"table`":`"MY_TABLE`"}}"

$response.content