Dynamic Table
List dynamic tables¶
GET/api/v2/databases/{database}/schemas/{schema}/dynamic-tables
Lists the dynamic tables under the database and schema.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Path Parameters¶
| Parameter | 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 | 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. |
| deep boolean | Optionally includes dependency information of the dynamic table. |
Response¶
| Code | Description |
|---|---|
| 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.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| createMode string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
Response¶
| Code | Description |
|---|---|
| 200 | Successful request. |
| 202 |
Fetch a dynamic table¶
GET/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}
Fetch a Dynamic Table.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Path Parameters¶
| Parameter | Description |
|---|---|
| name | Identifier (i.e. name) for the resource. |
Response¶
| Code | Description |
|---|---|
| 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.
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| ifExists boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
Response¶
| Code | Description |
|---|---|
| 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
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| 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¶
| Code | Description |
|---|---|
| 200 | |
| 202 |
Undrop a dynamic table¶
Suspend refreshes on the dynamic table¶
Resume refreshes on the dynamic table¶
Refresh the dynamic table¶
POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:refresh
Specifies that the dynamic table should be manually refreshed
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Response¶
| Code | Description |
|---|---|
| 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
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Response¶
| Code | Description |
|---|---|
| 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
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |
Swap with another dynamic table¶
POST/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:swap-with
Swap with another dynamic table
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| 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¶
| Code | Description |
|---|---|
| 200 | |
| 202 |