SQL 쿼리 제출(Execute SQL Query) (V2)

새 SQL 쿼리를 실행합니다. 실행한 사용자만 해당 쿼리를 조작할 수 있으며 결과 크기는 기본적으로 100만 행으로 제한됩니다. 더 높은 한도는 Palantir 담당자와 협의합니다.

경로와 쿼리 매개변수는 없습니다. ExecuteSqlQueryRequest JSON 본문은 필수입니다.

데이터셋은 SQL 문에서 경로나 RID로 참조합니다. SELECT 조회만 지원합니다. fallbackBranchIds는 우선 대상 브랜치에서 실행할 수 없을 때 사용할 대체 목록입니다. SQL 문에 브랜치를 명시하지 않으면 제공한 목록에서 존재하는 첫 브랜치를 사용합니다. 목록을 생략하면 기본 브랜치를 사용하며, 많은 플랫폼 인스턴스에서는 master입니다.

응답은 QueryStatus입니다. running 및 succeeded 상태의 queryId로 상태, 결과 조회 또는 취소를 요청합니다. canceled 상태에는 추가 필드가 없고 failed에는 실패 이유인 errorMessage가 있습니다. 결과는 제출 응답의 상태 객체와 별도로 Get Results에서 받습니다.

예시는 /Path/To/Dataset이라는 가상 데이터셋을 master 브랜치에서 조회하여 CSV 결과를 요청합니다. 경로와 브랜치는 실제 리소스에 맞게 변경합니다.

HTTP 요청

POST /api/v2/sqlQueries/execute

작업 식별자는 v2.executeSqlQuery입니다. Authorization: Bearer <접근 토큰> 헤더로 인증합니다. OAuth 클라이언트에는 api:sql-queries-execute 권한 범위가 필요합니다.

JSON 요청 예시

가상 데이터셋을 조회하는 요청 예시입니다.

{
  "fallbackBranchIds": [
    "master"
  ],
  "serializationFormat": "CSV",
  "query": "SELECT * FROM `/Path/To/Dataset`"
}

오류

실패 응답은 공통 오류 형식을 따릅니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 식별자와 입력값은 예시이므로 실제 요청 대상에 맞게 지정합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/sqlQueries/execute" \
	-d '{"fallbackBranchIds":["master"],"serializationFormat":"CSV","query":"SELECT * FROM `/Path/To/Dataset`"}'

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 = {'fallbackBranchIds': ['master'],
 'serializationFormat': 'CSV',
 'query': 'SELECT * FROM `/Path/To/Dataset`'}

response = requests.post('https://{}/api/v2/sqlQueries/execute'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 ExecuteSqlQueryExample.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 ExecuteSqlQueryExample {
    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/sqlQueries/execute");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"fallbackBranchIds\":[\"master\"],\"serializationFormat\":\"CSV\",\"query\":\"SELECT * FROM `/Path/To/Dataset`\"}", 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/sqlQueries/execute`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: JSON.stringify({
    "fallbackBranchIds": [
        "master"
    ],
    "serializationFormat": "CSV",
    "query": "SELECT * FROM `/Path/To/Dataset`"
})
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/sqlQueries/execute" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body '{"fallbackBranchIds":["master"],"serializationFormat":"CSV","query":"SELECT * FROM `/Path/To/Dataset`"}'

$response.content