Sign in
Catalog

Retrieves the list of tables from the Data Lake Analytics catalog.

get/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables

Path parameters

databaseNamestring required

The name of the database containing the tables.

schemaNamestring required

The name of the schema containing the tables.

Query parameters

$filterstring

OData filter. Optional.

$topinteger

The number of items to return. Optional.

$skipinteger

The number of items to skip over before returning elements. Optional.

$selectstring

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

$orderbystring

OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.

$countboolean

The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.

basicboolean

The basic switch indicates what level of information to return when listing tables. When basic is true, only database_name, schema_name, table_name and version are returned for each table, otherwise all table metadata is returned. By default, it is false. Optional.

api-versionstring required

Client Api Version.

Response

Successfully retrieved the list of tables in the specified database and schema.

nextLinkstring

the link to the next page of results.

Changes

No recorded changes to this endpoint across all 9 revisions of this API.