Table
List tablesΒΆ
GET/api/v2/databases/{database}/schemas/{schema}/tables
Lists the tables under the database and schema.
Path Parameters
Parameter | Type | Description |
---|---|---|
database | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. | |
schema | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
Query Parameters
Parameter | Type | Description |
---|---|---|
like | string | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
startsWith | string | Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
showLimit | integer | Query parameter to limit the maximum number of rows returned by a command. |
fromName | string | Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
history | boolean | Optionally includes dropped tables that have not yet been purged. |
deep | boolean | Optionally includes dependency information of the table. |
Response
Code | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
200 | successful [
{
"name": "string",
"kind": "PERMANENT",
"cluster_by": [
"string"
],
"enable_schema_evolution": true,
"change_tracking": true,
"data_retention_time_in_days": 0,
"max_data_extension_time_in_days": 0,
"default_ddl_collation": "string",
"columns": [
{
"name": "string",
"datatype": "string",
"nullable": true,
"collate": "string",
"default": "string",
"autoincrement": true,
"autoincrement_start": 0,
"autoincrement_increment": 0,
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string"
}
],
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string",
"created_on": "2019-08-24T14:15:22Z",
"database_name": "string",
"schema_name": "string",
"rows": 0,
"bytes": 0,
"owner": "string",
"dropped_on": "2019-08-24T14:15:22Z",
"automatic_clustering": true,
"search_optimization": true,
"search_optimization_progress": 0,
"search_optimization_bytes": 0,
"owner_role_type": "string",
"budget": "string"
}
]
| |||||||||
202 | Successfully accepted the request, but it is not completed yet. {
"code": "392604",
"message": "Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management."
}
|
400 | Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the request body for retry. |
401 | Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a new access token for retry. |
403 | Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled. |
404 | Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled. |
405 | Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST. |
408 | Request Timeout. This indicates that the request from the client timed out and was not completed by the server. |
409 | Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the options orReplace/ifNotExists. |
410 | Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable. |
429 | Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints. |
500 | Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support. |
503 | Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended. |
504 | Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended. |
Parameter | Type | Description |
---|
Create a table (clone and undrop are separate subresources)ΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables
Create a table.
Query Parameters
Parameter | Type | Description |
---|---|---|
createMode | string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
copyGrants | boolean | Query parameter to enable copy grants when creating the object. |
Parameter | Type | Description |
---|
{
"name": "string",
"kind": "PERMANENT",
"cluster_by": [
"string"
],
"enable_schema_evolution": true,
"change_tracking": true,
"data_retention_time_in_days": 0,
"max_data_extension_time_in_days": 0,
"default_ddl_collation": "string",
"columns": [
{
"name": "string",
"datatype": "string",
"nullable": true,
"collate": "string",
"default": "string",
"autoincrement": true,
"autoincrement_start": 0,
"autoincrement_increment": 0,
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string"
}
],
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string",
"created_on": "2019-08-24T14:15:22Z",
"database_name": "string",
"schema_name": "string",
"rows": 0,
"bytes": 0,
"owner": "string",
"dropped_on": "2019-08-24T14:15:22Z",
"automatic_clustering": true,
"search_optimization": true,
"search_optimization_progress": 0,
"search_optimization_bytes": 0,
"owner_role_type": "string",
"budget": "string"
}
Response
Code | Description | ||||
---|---|---|---|---|---|
200 | Successful request. {
"status": "Request successfully completed"
}
| ||||
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Parameter | Type | Description |
---|---|---|
status | string | Message returned by the server. |
Create a table using the result of the specified select query (Deprecated)ΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:as_select
Create a table as select.
Query Parameters
Parameter | Type | Description |
---|---|---|
query | string | The SQL select query to run to set up the table values (and possibly columns). |
Parameter | Type | Description |
---|
{
"name": "string",
"kind": "PERMANENT",
"cluster_by": [
"string"
],
"enable_schema_evolution": true,
"change_tracking": true,
"data_retention_time_in_days": 0,
"max_data_extension_time_in_days": 0,
"default_ddl_collation": "string",
"columns": [
{
"name": "string",
"datatype": "string",
"nullable": true,
"collate": "string",
"default": "string",
"autoincrement": true,
"autoincrement_start": 0,
"autoincrement_increment": 0,
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string"
}
],
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string",
"created_on": "2019-08-24T14:15:22Z",
"database_name": "string",
"schema_name": "string",
"rows": 0,
"bytes": 0,
"owner": "string",
"dropped_on": "2019-08-24T14:15:22Z",
"automatic_clustering": true,
"search_optimization": true,
"search_optimization_progress": 0,
"search_optimization_bytes": 0,
"owner_role_type": "string",
"budget": "string"
}
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Create a table using the result of the specified select queryΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables:as-select
Create a table as select.
Query Parameters
Parameter | Type | Description |
---|---|---|
query | string | The SQL select query to run to set up the table values (and possibly columns). |
Parameter | Type | Description |
---|
{
"name": "string",
"columns": [
{
"name": "string",
"datatype": "string",
"nullable": true,
"collate": "string",
"default": "string",
"autoincrement": true,
"autoincrement_start": 0,
"autoincrement_increment": 0,
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string"
}
],
"cluster_by": [
"string"
]
}
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Create a table using the templates specified in staged files (Deprecated)ΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:using_template
Create a table using template.
Query Parameters
Parameter | Type | Description |
---|---|---|
query | string | The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table. |
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Create a table using the templates specified in staged filesΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables:using-template
Create a table using template.
Query Parameters
Parameter | Type | Description |
---|---|---|
query | string | The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table. |
Parameter | Type | Description |
---|
{
"name": "string"
}
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Fetch a tableΒΆ
GET/api/v2/databases/{database}/schemas/{schema}/tables/{name}
Fetch a Table using the describe command output.
Path Parameters
Parameter | Type | Description |
---|---|---|
name | Identifier (i.e. name) for the resource. |
Response
Code | Description | ||||
---|---|---|---|---|---|
200 | successful {
"name": "string",
"kind": "PERMANENT",
"cluster_by": [
"string"
],
"enable_schema_evolution": true,
"change_tracking": true,
"data_retention_time_in_days": 0,
"max_data_extension_time_in_days": 0,
"default_ddl_collation": "string",
"columns": [
{
"name": "string",
"datatype": "string",
"nullable": true,
"collate": "string",
"default": "string",
"autoincrement": true,
"autoincrement_start": 0,
"autoincrement_increment": 0,
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string"
}
],
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string",
"created_on": "2019-08-24T14:15:22Z",
"database_name": "string",
"schema_name": "string",
"rows": 0,
"bytes": 0,
"owner": "string",
"dropped_on": "2019-08-24T14:15:22Z",
"automatic_clustering": true,
"search_optimization": true,
"search_optimization_progress": 0,
"search_optimization_bytes": 0,
"owner_role_type": "string",
"budget": "string"
}
| ||||
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Parameter | Type | Description |
---|
Create a (or alter an existing) tableΒΆ
PUT/api/v2/databases/{database}/schemas/{schema}/tables/{name}
Create a (or alter an existing) table. Even if the operation is just an alter, the full property set must be provided.
Parameter | Type | Description |
---|
{
"name": "string",
"kind": "PERMANENT",
"cluster_by": [
"string"
],
"enable_schema_evolution": true,
"change_tracking": true,
"data_retention_time_in_days": 0,
"max_data_extension_time_in_days": 0,
"default_ddl_collation": "string",
"columns": [
{
"name": "string",
"datatype": "string",
"nullable": true,
"collate": "string",
"default": "string",
"autoincrement": true,
"autoincrement_start": 0,
"autoincrement_increment": 0,
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string"
}
],
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string",
"created_on": "2019-08-24T14:15:22Z",
"database_name": "string",
"schema_name": "string",
"rows": 0,
"bytes": 0,
"owner": "string",
"dropped_on": "2019-08-24T14:15:22Z",
"automatic_clustering": true,
"search_optimization": true,
"search_optimization_progress": 0,
"search_optimization_bytes": 0,
"owner_role_type": "string",
"budget": "string"
}
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Delete a tableΒΆ
DELETE/api/v2/databases/{database}/schemas/{schema}/tables/{name}
Delete a table with the given name.
Query Parameters
Parameter | Type | Description |
---|---|---|
ifExists | boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Clone tableΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:clone
Create a new table by cloning from the specified resource
Query Parameters
Parameter | Type | Description |
---|---|---|
targetDatabase | string | Database of the newly created table. Defaults to the source table's database. |
targetSchema | Schema of the newly created table. Defaults to the source table's schema. |
Parameter | Type | Description |
---|
{
"point_of_time": {
"point_of_time_type": "string",
"reference": "string"
},
"name": "string",
"kind": "PERMANENT",
"cluster_by": [
"string"
],
"enable_schema_evolution": true,
"change_tracking": true,
"data_retention_time_in_days": 0,
"max_data_extension_time_in_days": 0,
"default_ddl_collation": "string",
"columns": [
{
"name": "string",
"datatype": "string",
"nullable": true,
"collate": "string",
"default": "string",
"autoincrement": true,
"autoincrement_start": 0,
"autoincrement_increment": 0,
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string"
}
],
"constraints": [
{
"name": "string",
"column_names": [
"string"
],
"constraint_type": "string"
}
],
"comment": "string",
"created_on": "2019-08-24T14:15:22Z",
"database_name": "string",
"schema_name": "string",
"rows": 0,
"bytes": 0,
"owner": "string",
"dropped_on": "2019-08-24T14:15:22Z",
"automatic_clustering": true,
"search_optimization": true,
"search_optimization_progress": 0,
"search_optimization_bytes": 0,
"owner_role_type": "string",
"budget": "string"
}
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Create a table like this existing one (Deprecated)ΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:create_like
Create a new table like the specified resource, but empty
Query Parameters
Parameter | Type | Description |
---|---|---|
newTableName | string | The name of the table to be created. |
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Create a table like this existing oneΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:create-like
Create a new table like the specified resource, but empty
Parameter | Type | Description |
---|
{
"name": "string"
}
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Undrop a tableΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:undrop
Undrop specified table
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Suspend recluster of a table (Deprecated)ΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:suspend_recluster
Suspend recluster of a table
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Suspend recluster of a tableΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:suspend-recluster
Suspend recluster of a table
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Resume recluster of a table (Deprecated)ΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:resume_recluster
Resume recluster of a table
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Resume recluster of a tableΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:resume-recluster
Resume recluster of a table
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Swap with another table (Deprecated)ΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:swapwith
Swap with another table
Query Parameters
Parameter | Type | Description |
---|---|---|
targetTableName | string | The fully-specified name of the target table to be swapped with. |
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |
Swap with another tableΒΆ
POST/api/v2/databases/{database}/schemas/{schema}/tables/{name}:swap-with
Swap with another table
Query Parameters
Parameter | Type | Description |
---|---|---|
targetName | string | The fully-specified name of the target table to be swapped with. |
Response
Code | Description |
---|---|
200 | |
202 |
400 | |
401 | |
403 | |
404 | |
405 | |
408 | |
409 | |
410 | |
429 | |
500 | |
503 | |
504 |