Create Table
curl --request POST \
--url https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"relational": {
"connector": "<string>",
"sourceCatalog": "<string>",
"sourceSchema": "<string>",
"sourceTable": "<string>",
"snapshot": {
"schema": {
"ipcMessage": "<string>"
}
}
},
"listing": {
"connector": "<string>",
"tablePaths": [
"<string>"
],
"snapshot": {
"fileSchema": {
"ipcMessage": "<string>"
},
"options": {
"fileType": "<string>",
"formatOptions": {},
"fileExtension": "",
"tablePartitionSchema": {
"ipcMessage": "<string>"
},
"collectStat": true,
"targetPartitions": 123
}
}
}
},
"name": "",
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"revision": 0,
"revisionHash": ""
}
'import requests
url = "https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables"
payload = {
"spec": {
"relational": {
"connector": "<string>",
"sourceCatalog": "<string>",
"sourceSchema": "<string>",
"sourceTable": "<string>",
"snapshot": { "schema": { "ipcMessage": "<string>" } }
},
"listing": {
"connector": "<string>",
"tablePaths": ["<string>"],
"snapshot": {
"fileSchema": { "ipcMessage": "<string>" },
"options": {
"fileType": "<string>",
"formatOptions": {},
"fileExtension": "",
"tablePartitionSchema": { "ipcMessage": "<string>" },
"collectStat": True,
"targetPartitions": 123
}
}
}
},
"name": "",
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"revision": 0,
"revisionHash": ""
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: {
relational: {
connector: '<string>',
sourceCatalog: '<string>',
sourceSchema: '<string>',
sourceTable: '<string>',
snapshot: {schema: {ipcMessage: '<string>'}}
},
listing: {
connector: '<string>',
tablePaths: ['<string>'],
snapshot: {
fileSchema: {ipcMessage: '<string>'},
options: {
fileType: '<string>',
formatOptions: {},
fileExtension: '',
tablePartitionSchema: {ipcMessage: '<string>'},
collectStat: true,
targetPartitions: 123
}
}
}
},
name: '',
createTime: '2023-11-07T05:31:56Z',
updateTime: '2023-11-07T05:31:56Z',
revision: 0,
revisionHash: ''
})
};
fetch('https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'spec' => [
'relational' => [
'connector' => '<string>',
'sourceCatalog' => '<string>',
'sourceSchema' => '<string>',
'sourceTable' => '<string>',
'snapshot' => [
'schema' => [
'ipcMessage' => '<string>'
]
]
],
'listing' => [
'connector' => '<string>',
'tablePaths' => [
'<string>'
],
'snapshot' => [
'fileSchema' => [
'ipcMessage' => '<string>'
],
'options' => [
'fileType' => '<string>',
'formatOptions' => [
],
'fileExtension' => '',
'tablePartitionSchema' => [
'ipcMessage' => '<string>'
],
'collectStat' => true,
'targetPartitions' => 123
]
]
]
],
'name' => '',
'createTime' => '2023-11-07T05:31:56Z',
'updateTime' => '2023-11-07T05:31:56Z',
'revision' => 0,
'revisionHash' => ''
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables"
payload := strings.NewReader("{\n \"spec\": {\n \"relational\": {\n \"connector\": \"<string>\",\n \"sourceCatalog\": \"<string>\",\n \"sourceSchema\": \"<string>\",\n \"sourceTable\": \"<string>\",\n \"snapshot\": {\n \"schema\": {\n \"ipcMessage\": \"<string>\"\n }\n }\n },\n \"listing\": {\n \"connector\": \"<string>\",\n \"tablePaths\": [\n \"<string>\"\n ],\n \"snapshot\": {\n \"fileSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"options\": {\n \"fileType\": \"<string>\",\n \"formatOptions\": {},\n \"fileExtension\": \"\",\n \"tablePartitionSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"collectStat\": true,\n \"targetPartitions\": 123\n }\n }\n }\n },\n \"name\": \"\",\n \"createTime\": \"2023-11-07T05:31:56Z\",\n \"updateTime\": \"2023-11-07T05:31:56Z\",\n \"revision\": 0,\n \"revisionHash\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": {\n \"relational\": {\n \"connector\": \"<string>\",\n \"sourceCatalog\": \"<string>\",\n \"sourceSchema\": \"<string>\",\n \"sourceTable\": \"<string>\",\n \"snapshot\": {\n \"schema\": {\n \"ipcMessage\": \"<string>\"\n }\n }\n },\n \"listing\": {\n \"connector\": \"<string>\",\n \"tablePaths\": [\n \"<string>\"\n ],\n \"snapshot\": {\n \"fileSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"options\": {\n \"fileType\": \"<string>\",\n \"formatOptions\": {},\n \"fileExtension\": \"\",\n \"tablePartitionSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"collectStat\": true,\n \"targetPartitions\": 123\n }\n }\n }\n },\n \"name\": \"\",\n \"createTime\": \"2023-11-07T05:31:56Z\",\n \"updateTime\": \"2023-11-07T05:31:56Z\",\n \"revision\": 0,\n \"revisionHash\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spec\": {\n \"relational\": {\n \"connector\": \"<string>\",\n \"sourceCatalog\": \"<string>\",\n \"sourceSchema\": \"<string>\",\n \"sourceTable\": \"<string>\",\n \"snapshot\": {\n \"schema\": {\n \"ipcMessage\": \"<string>\"\n }\n }\n },\n \"listing\": {\n \"connector\": \"<string>\",\n \"tablePaths\": [\n \"<string>\"\n ],\n \"snapshot\": {\n \"fileSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"options\": {\n \"fileType\": \"<string>\",\n \"formatOptions\": {},\n \"fileExtension\": \"\",\n \"tablePartitionSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"collectStat\": true,\n \"targetPartitions\": 123\n }\n }\n }\n },\n \"name\": \"\",\n \"createTime\": \"2023-11-07T05:31:56Z\",\n \"updateTime\": \"2023-11-07T05:31:56Z\",\n \"revision\": 0,\n \"revisionHash\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"spec": {
"relational": {
"connector": "<string>",
"sourceCatalog": "<string>",
"sourceSchema": "<string>",
"sourceTable": "<string>",
"snapshot": {
"schema": {
"ipcMessage": "<string>"
}
}
},
"listing": {
"connector": "<string>",
"tablePaths": [
"<string>"
],
"snapshot": {
"fileSchema": {
"ipcMessage": "<string>"
},
"options": {
"fileType": "<string>",
"formatOptions": {},
"fileExtension": "",
"tablePartitionSchema": {
"ipcMessage": "<string>"
},
"collectStat": true,
"targetPartitions": "<string>"
}
}
}
},
"createTime": "<string>",
"updateTime": "<string>",
"revision": "0",
"revisionHash": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}table
Create Table
POST
/
v1
/
workspaces
/
{workspace_id}
/
catalogs
/
{catalog_id}
/
schemas
/
{schema_id}
/
tables
Create Table
curl --request POST \
--url https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"relational": {
"connector": "<string>",
"sourceCatalog": "<string>",
"sourceSchema": "<string>",
"sourceTable": "<string>",
"snapshot": {
"schema": {
"ipcMessage": "<string>"
}
}
},
"listing": {
"connector": "<string>",
"tablePaths": [
"<string>"
],
"snapshot": {
"fileSchema": {
"ipcMessage": "<string>"
},
"options": {
"fileType": "<string>",
"formatOptions": {},
"fileExtension": "",
"tablePartitionSchema": {
"ipcMessage": "<string>"
},
"collectStat": true,
"targetPartitions": 123
}
}
}
},
"name": "",
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"revision": 0,
"revisionHash": ""
}
'import requests
url = "https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables"
payload = {
"spec": {
"relational": {
"connector": "<string>",
"sourceCatalog": "<string>",
"sourceSchema": "<string>",
"sourceTable": "<string>",
"snapshot": { "schema": { "ipcMessage": "<string>" } }
},
"listing": {
"connector": "<string>",
"tablePaths": ["<string>"],
"snapshot": {
"fileSchema": { "ipcMessage": "<string>" },
"options": {
"fileType": "<string>",
"formatOptions": {},
"fileExtension": "",
"tablePartitionSchema": { "ipcMessage": "<string>" },
"collectStat": True,
"targetPartitions": 123
}
}
}
},
"name": "",
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"revision": 0,
"revisionHash": ""
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: {
relational: {
connector: '<string>',
sourceCatalog: '<string>',
sourceSchema: '<string>',
sourceTable: '<string>',
snapshot: {schema: {ipcMessage: '<string>'}}
},
listing: {
connector: '<string>',
tablePaths: ['<string>'],
snapshot: {
fileSchema: {ipcMessage: '<string>'},
options: {
fileType: '<string>',
formatOptions: {},
fileExtension: '',
tablePartitionSchema: {ipcMessage: '<string>'},
collectStat: true,
targetPartitions: 123
}
}
}
},
name: '',
createTime: '2023-11-07T05:31:56Z',
updateTime: '2023-11-07T05:31:56Z',
revision: 0,
revisionHash: ''
})
};
fetch('https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'spec' => [
'relational' => [
'connector' => '<string>',
'sourceCatalog' => '<string>',
'sourceSchema' => '<string>',
'sourceTable' => '<string>',
'snapshot' => [
'schema' => [
'ipcMessage' => '<string>'
]
]
],
'listing' => [
'connector' => '<string>',
'tablePaths' => [
'<string>'
],
'snapshot' => [
'fileSchema' => [
'ipcMessage' => '<string>'
],
'options' => [
'fileType' => '<string>',
'formatOptions' => [
],
'fileExtension' => '',
'tablePartitionSchema' => [
'ipcMessage' => '<string>'
],
'collectStat' => true,
'targetPartitions' => 123
]
]
]
],
'name' => '',
'createTime' => '2023-11-07T05:31:56Z',
'updateTime' => '2023-11-07T05:31:56Z',
'revision' => 0,
'revisionHash' => ''
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables"
payload := strings.NewReader("{\n \"spec\": {\n \"relational\": {\n \"connector\": \"<string>\",\n \"sourceCatalog\": \"<string>\",\n \"sourceSchema\": \"<string>\",\n \"sourceTable\": \"<string>\",\n \"snapshot\": {\n \"schema\": {\n \"ipcMessage\": \"<string>\"\n }\n }\n },\n \"listing\": {\n \"connector\": \"<string>\",\n \"tablePaths\": [\n \"<string>\"\n ],\n \"snapshot\": {\n \"fileSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"options\": {\n \"fileType\": \"<string>\",\n \"formatOptions\": {},\n \"fileExtension\": \"\",\n \"tablePartitionSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"collectStat\": true,\n \"targetPartitions\": 123\n }\n }\n }\n },\n \"name\": \"\",\n \"createTime\": \"2023-11-07T05:31:56Z\",\n \"updateTime\": \"2023-11-07T05:31:56Z\",\n \"revision\": 0,\n \"revisionHash\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": {\n \"relational\": {\n \"connector\": \"<string>\",\n \"sourceCatalog\": \"<string>\",\n \"sourceSchema\": \"<string>\",\n \"sourceTable\": \"<string>\",\n \"snapshot\": {\n \"schema\": {\n \"ipcMessage\": \"<string>\"\n }\n }\n },\n \"listing\": {\n \"connector\": \"<string>\",\n \"tablePaths\": [\n \"<string>\"\n ],\n \"snapshot\": {\n \"fileSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"options\": {\n \"fileType\": \"<string>\",\n \"formatOptions\": {},\n \"fileExtension\": \"\",\n \"tablePartitionSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"collectStat\": true,\n \"targetPartitions\": 123\n }\n }\n }\n },\n \"name\": \"\",\n \"createTime\": \"2023-11-07T05:31:56Z\",\n \"updateTime\": \"2023-11-07T05:31:56Z\",\n \"revision\": 0,\n \"revisionHash\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workspaces/{workspace_id}/catalogs/{catalog_id}/schemas/{schema_id}/tables")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spec\": {\n \"relational\": {\n \"connector\": \"<string>\",\n \"sourceCatalog\": \"<string>\",\n \"sourceSchema\": \"<string>\",\n \"sourceTable\": \"<string>\",\n \"snapshot\": {\n \"schema\": {\n \"ipcMessage\": \"<string>\"\n }\n }\n },\n \"listing\": {\n \"connector\": \"<string>\",\n \"tablePaths\": [\n \"<string>\"\n ],\n \"snapshot\": {\n \"fileSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"options\": {\n \"fileType\": \"<string>\",\n \"formatOptions\": {},\n \"fileExtension\": \"\",\n \"tablePartitionSchema\": {\n \"ipcMessage\": \"<string>\"\n },\n \"collectStat\": true,\n \"targetPartitions\": 123\n }\n }\n }\n },\n \"name\": \"\",\n \"createTime\": \"2023-11-07T05:31:56Z\",\n \"updateTime\": \"2023-11-07T05:31:56Z\",\n \"revision\": 0,\n \"revisionHash\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"spec": {
"relational": {
"connector": "<string>",
"sourceCatalog": "<string>",
"sourceSchema": "<string>",
"sourceTable": "<string>",
"snapshot": {
"schema": {
"ipcMessage": "<string>"
}
}
},
"listing": {
"connector": "<string>",
"tablePaths": [
"<string>"
],
"snapshot": {
"fileSchema": {
"ipcMessage": "<string>"
},
"options": {
"fileType": "<string>",
"formatOptions": {},
"fileExtension": "",
"tablePartitionSchema": {
"ipcMessage": "<string>"
},
"collectStat": true,
"targetPartitions": "<string>"
}
}
}
},
"createTime": "<string>",
"updateTime": "<string>",
"revision": "0",
"revisionHash": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
An API key or OAuth2/OIDC access token sent as Authorization: Bearer <token>.
Query Parameters
Body
application/json
A SQL-visible table owned by its parent schema.
Definition used to construct this table.
Show child attributes
Show child attributes
Resource name in the form
workspaces/{workspace}/catalogs/{catalog}/schemas/{schema}/tables/{table}.
The terminal resource ID is the SQL-visible table name.
Pattern:
^workspaces/[a-z0-9](?:[a-z0-9._~-]*[a-z0-9])?/catalogs/[a-z][a-z0-9_]{0,62}/schemas/[a-z][a-z0-9_]{0,62}/tables/[a-z][a-z0-9_]{0,62}$Time at which the table was created.
Time at which the table was most recently updated.
Monotonically increasing revision of this table definition.
Lowercase SHA-256 hash of the canonical stored table definition.
Response
Successful Response
A SQL-visible table owned by its parent schema.
Resource name in the form
workspaces/{workspace}/catalogs/{catalog}/schemas/{schema}/tables/{table}.
The terminal resource ID is the SQL-visible table name.
Pattern:
^workspaces/[a-z0-9](?:[a-z0-9._~-]*[a-z0-9])?/catalogs/[a-z][a-z0-9_]{0,62}/schemas/[a-z][a-z0-9_]{0,62}/tables/[a-z][a-z0-9_]{0,62}$Definition used to construct this table.
Show child attributes
Show child attributes
Time at which the table was created.
Time at which the table was most recently updated.
Monotonically increasing revision of this table definition.
Lowercase SHA-256 hash of the canonical stored table definition.