GET

/catalog/usql/databases/{databaseName}/tables

https://azure.com/catalog/usql/databases/{databaseName}/tables

Retrieves the list of all tables in a database from the Data Lake Analytics catalog.

Access Token Required: API Key

Path Parameters

databaseNamestringrequired

The name of the database containing the tables.

Query Params

$filterstring

OData filter. Optional.

$topstring

The number of items to return. Optional.

$skipstring

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.

$countstring

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.

basicstring

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://azure.com/catalog/usql/databases/{databaseName}/tables' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET