curl --request PATCH \
--url https://api.nekt.ai/api/v1/tables/{id}/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"description": "<string>"
}
'import requests
url = "https://api.nekt.ai/api/v1/tables/{id}/"
payload = { "description": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({description: '<string>'})
};
fetch('https://api.nekt.ai/api/v1/tables/{id}/', 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.nekt.ai/api/v1/tables/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.nekt.ai/api/v1/tables/{id}/"
payload := strings.NewReader("{\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.patch("https://api.nekt.ai/api/v1/tables/{id}/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/tables/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"database_id": "<string>",
"s3_path": "<string>",
"table_format": "delta",
"catalog": "<string>",
"is_scd_type_2": true,
"primary_keys": [
"<string>"
],
"number_of_rows": 123,
"size_in_bytes": 123,
"is_external": true,
"external_source_project": "<string>",
"external_source_dataset": "<string>",
"external_source_table": "<string>",
"external_source_kind": "NATIVE",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"folder": "<string>",
"layer": "<string>",
"description": "<string>",
"type": "GENERAL",
"hidden": true,
"delta_log_retention_duration": -1,
"delta_partitions": [
"<string>"
],
"delta_z_order_columns": [
"<string>"
],
"bigquery_partition_field": "<string>",
"bigquery_partition_granularity": "HOUR",
"bigquery_allow_partition_rebuild": true
}Update Table
curl --request PATCH \
--url https://api.nekt.ai/api/v1/tables/{id}/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"description": "<string>"
}
'import requests
url = "https://api.nekt.ai/api/v1/tables/{id}/"
payload = { "description": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({description: '<string>'})
};
fetch('https://api.nekt.ai/api/v1/tables/{id}/', 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.nekt.ai/api/v1/tables/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.nekt.ai/api/v1/tables/{id}/"
payload := strings.NewReader("{\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.patch("https://api.nekt.ai/api/v1/tables/{id}/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/tables/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"database_id": "<string>",
"s3_path": "<string>",
"table_format": "delta",
"catalog": "<string>",
"is_scd_type_2": true,
"primary_keys": [
"<string>"
],
"number_of_rows": 123,
"size_in_bytes": 123,
"is_external": true,
"external_source_project": "<string>",
"external_source_dataset": "<string>",
"external_source_table": "<string>",
"external_source_kind": "NATIVE",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"folder": "<string>",
"layer": "<string>",
"description": "<string>",
"type": "GENERAL",
"hidden": true,
"delta_log_retention_duration": -1,
"delta_partitions": [
"<string>"
],
"delta_z_order_columns": [
"<string>"
],
"bigquery_partition_field": "<string>",
"bigquery_partition_granularity": "HOUR",
"bigquery_allow_partition_rebuild": true
}Authorizations
API Key authentication. Format: 'x-api-key: api_key'
Path Parameters
A UUID string identifying this Table.
Body
Response
^[-a-zA-Z0-9_]+$delta- deltaiceberg- icebergbigquery- bigquery
delta, iceberg, bigquery Athena catalog to query this table through (federated s3tablescatalog/ for iceberg, AwsDataCatalog for delta).
256Whether this table points at a customer's pre-existing BigQuery table.
Derived, not stored, so it cannot drift from the address. NB: it is a property,
so it is NOT filterable in a queryset — filter on external_source_table
(see TableFilterSet.is_external), the same trap as Organization.cloud_provider.
GCP project of the customer's pre-existing BigQuery table. Empty for a Nekt-managed table.
Set iff this table is external — it is what is_external reads.
NATIVE- NATIVEBIGLAKE- BIGLAKEVIEW- VIEWMATERIALIZED_VIEW- MATERIALIZED_VIEW
NATIVE, BIGLAKE, VIEW, MATERIALIZED_VIEW Folder of the table (Expandable)
Layer of the table (Expandable)
GENERAL- GeneralDIMENSION- DimensionFACT- Fact
GENERAL, DIMENSION, FACT -2147483648 <= x <= 214748364710241024Top-level TIMESTAMP field to partition the BigQuery table on. BigQuery allows exactly one partition column per table — use clustering for additional pruning dimensions.
512Time granularity for the partition field. Ignored when no partition field is set. Pick the coarsest granularity that still prunes well: BigQuery caps a table at 10,000 partitions.
HOUR- HOURDAY- DAYMONTH- MONTHYEAR- YEAR
HOUR, DAY, MONTH, YEAR Allow the loader to rebuild this table when its partitioning does not match the configuration. BigQuery cannot change partitioning in place, so this is a one-time full-table rewrite whose cost scales with table size. It no-ops once the partitioning matches, but stays enabled — a later change to the partition field or granularity will rebuild the table again.
Was this page helpful?