Lists schemas.
GET {{baseUrl}}/api/v2/databases/:database/schemas?like=<string>&startsWith=<string>&showLimit=<integer>&fromName=<string>&history=false
Lists the accessible schemas.
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 | boolean | Whether to include dropped schemas that have not yet been purged. Default: false . |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"name":"\"\"\"\"\"\"\"\"\"P\"\"\"\"f\"\"o\"\"\"","created_on":"\u003cdateTime\u003e","kind":"PERMANENT","is_default":"\u003cboolean\u003e","is_current":"\u003cboolean\u003e","database_name":"\u003cstring\u003e","owner":"\u003cstring\u003e","comment":"\u003cstring\u003e","options":"\u003cstring\u003e","managed_access":false,"retention_time":"\u003cinteger\u003e","dropped_on":"\u003cdateTime\u003e","owner_role_type":"\u003cstring\u003e","budget":"\u003cstring\u003e","data_retention_time_in_days":"\u003cinteger\u003e","default_ddl_collation":"\u003cstring\u003e","log_level":"\u003cstring\u003e","pipe_execution_paused":"\u003cboolean\u003e","max_data_extension_time_in_days":"\u003cinteger\u003e","suspend_task_after_num_failures":"\u003cinteger\u003e","trace_level":"\u003cstring\u003e","user_task_managed_initial_warehouse_size":"\u003cstring\u003e","user_task_timeout_ms":"\u003cinteger\u003e"},{"name":"nMKTzaftdJ","created_on":"\u003cdateTime\u003e","kind":"PERMANENT","is_default":"\u003cboolean\u003e","is_current":"\u003cboolean\u003e","database_name":"\u003cstring\u003e","owner":"\u003cstring\u003e","comment":"\u003cstring\u003e","options":"\u003cstring\u003e","managed_access":false,"retention_time":"\u003cinteger\u003e","dropped_on":"\u003cdateTime\u003e","owner_role_type":"\u003cstring\u003e","budget":"\u003cstring\u003e","data_retention_time_in_days":"\u003cinteger\u003e","default_ddl_collation":"\u003cstring\u003e","log_level":"\u003cstring\u003e","pipe_execution_paused":"\u003cboolean\u003e","max_data_extension_time_in_days":"\u003cinteger\u003e","suspend_task_after_num_failures":"\u003cinteger\u003e","trace_level":"\u003cstring\u003e","user_task_managed_initial_warehouse_size":"\u003cstring\u003e","user_task_timeout_ms":"\u003cinteger\u003e"}]