Dynamic Table

List dynamic tables¶

GET/api/v2/databases/{database}/schemas/{schema}/dynamic-tables
Lists the dynamic tables under the database and schema.

Path Parameters¶

ParameterDescription
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¶

ParameterDescription
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.
deep boolean
Optionally includes dependency information of the dynamic table.

Response¶

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create a dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables
Create a dynamic table, with standard create modifiers as query parameters. See the Dynamic Table component definition for what is required to be provided in the request body.

Query Parameters¶

ParameterDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response¶

CodeDescription
200
Successful request.
202

Fetch a dynamic table¶

GET/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}
Fetch a Dynamic Table.

Path Parameters¶

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
successful
202

Delete a dynamic table¶

DELETE/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}
Delete a dynamic table with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful.

Query Parameters¶

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202

Clone dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:clone
Create a new dynamic table by cloning from the specified resource

Query Parameters¶

ParameterDescription
copyGrants boolean
Query parameter to enable copy grants when creating the object.
targetDatabase string
Database of the newly created dynamic table. Defaults to the source table's database.
targetSchema 
Schema of the newly created dynamic table. Defaults to the source table's schema.

Response¶

CodeDescription
200
202

Undrop a dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:undrop
Undrop specified dynamic table

Response¶

CodeDescription
200
202

Suspend refreshes on the dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:suspend
Suspend refreshes on the dynamic table

Response¶

CodeDescription
200
202

Resume refreshes on the dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:resume
Resume refreshes on the dynamic table

Response¶

CodeDescription
200
202

Refresh the dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:refresh
Specifies that the dynamic table should be manually refreshed

Response¶

CodeDescription
200
202

Suspend recluster of a dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:suspend-recluster
Suspend recluster of a dynamic table

Response¶

CodeDescription
200
202

Resume recluster of a dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:resume-recluster
Resume recluster of a dynamic table

Response¶

CodeDescription
200
202

Swap with another dynamic table¶

POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:swap-with
Swap with another dynamic table

Query Parameters¶

ParameterDescription
targetName 
The name of the target dynamic table to be swapped with.
targetDatabase 
Database of the target dynamic table. Defaults to the source table's database.
targetSchema 
Schema of the target dynamic table. Defaults to the source table's schema.

Response¶

CodeDescription
200
202
Language: English