List tables
GET {{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=<string>&startsWith=<string>&showLimit=<integer>&fromName=<string>&history=<boolean>&deep=<boolean>
Lists the tables under the database and schema.
Request Params
| Key | Datatype | Required | 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 | string | 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 | string | Optionally includes dropped tables that have not yet been purged. | |
deep | string | Optionally includes dependency information of the table. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"name":"\u003cstring\u003e","kind":"PERMANENT","cluster_by":["\u003cstring\u003e","\u003cstring\u003e"],"enable_schema_evolution":"\u003cboolean\u003e","change_tracking":"\u003cboolean\u003e","data_retention_time_in_days":"\u003cinteger\u003e","max_data_extension_time_in_days":"\u003cinteger\u003e","default_ddl_collation":"\u003cstring\u003e","columns":[{"name":"\u003cstring\u003e","datatype":"\u003cstring\u003e","nullable":true,"collate":"\u003cstring\u003e","default":"\u003cstring\u003e","autoincrement":"\u003cboolean\u003e","autoincrement_start":"\u003cinteger\u003e","autoincrement_increment":"\u003cinteger\u003e","constraints":[{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"}],"comment":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","datatype":"\u003cstring\u003e","nullable":true,"collate":"\u003cstring\u003e","default":"\u003cstring\u003e","autoincrement":"\u003cboolean\u003e","autoincrement_start":"\u003cinteger\u003e","autoincrement_increment":"\u003cinteger\u003e","constraints":[{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"}],"comment":"\u003cstring\u003e"}],"constraints":[{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"}],"comment":"\u003cstring\u003e","created_on":"\u003cdateTime\u003e","database_name":"\u003cstring\u003e","schema_name":"\u003cstring\u003e","rows":"\u003clong\u003e","bytes":"\u003clong\u003e","owner":"\u003cstring\u003e","dropped_on":"\u003cdateTime\u003e","automatic_clustering":"\u003cboolean\u003e","search_optimization":"\u003cboolean\u003e","search_optimization_progress":"\u003clong\u003e","search_optimization_bytes":"\u003clong\u003e","owner_role_type":"\u003cstring\u003e","budget":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","kind":"PERMANENT","cluster_by":["\u003cstring\u003e","\u003cstring\u003e"],"enable_schema_evolution":"\u003cboolean\u003e","change_tracking":"\u003cboolean\u003e","data_retention_time_in_days":"\u003cinteger\u003e","max_data_extension_time_in_days":"\u003cinteger\u003e","default_ddl_collation":"\u003cstring\u003e","columns":[{"name":"\u003cstring\u003e","datatype":"\u003cstring\u003e","nullable":true,"collate":"\u003cstring\u003e","default":"\u003cstring\u003e","autoincrement":"\u003cboolean\u003e","autoincrement_start":"\u003cinteger\u003e","autoincrement_increment":"\u003cinteger\u003e","constraints":[{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"}],"comment":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","datatype":"\u003cstring\u003e","nullable":true,"collate":"\u003cstring\u003e","default":"\u003cstring\u003e","autoincrement":"\u003cboolean\u003e","autoincrement_start":"\u003cinteger\u003e","autoincrement_increment":"\u003cinteger\u003e","constraints":[{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"}],"comment":"\u003cstring\u003e"}],"constraints":[{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","column_names":["\u003cstring\u003e","\u003cstring\u003e"],"constraint_type":"\u003cstring\u003e"}],"comment":"\u003cstring\u003e","created_on":"\u003cdateTime\u003e","database_name":"\u003cstring\u003e","schema_name":"\u003cstring\u003e","rows":"\u003clong\u003e","bytes":"\u003clong\u003e","owner":"\u003cstring\u003e","dropped_on":"\u003cdateTime\u003e","automatic_clustering":"\u003cboolean\u003e","search_optimization":"\u003cboolean\u003e","search_optimization_progress":"\u003clong\u003e","search_optimization_bytes":"\u003clong\u003e","owner_role_type":"\u003cstring\u003e","budget":"\u003cstring\u003e"}]