Catalog - List Table Partitions

Service:

Data Lake Analytics

API Version:

2016-11-01

Retrieves the list of table partitions from the Data Lake Analytics catalog.

GET https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions?api-version=2016-11-01

With optional parameters:

GET https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions?$filter={$filter}&$top={$top}&$skip={$skip}&$select={$select}&$orderby={$orderby}&$count={$count}&api-version=2016-11-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The Azure Data Lake Analytics account upon which to execute catalog operations.
adlaCatalogDnsSuffix	path	True	string	Gets the DNS suffix used as the base for all Azure Data Lake Analytics Catalog service requests.
databaseName	path	True	string	The name of the database containing the partitions.
schemaName	path	True	string	The name of the schema containing the partitions.
tableName	path	True	string	The name of the table containing the partitions.
api-version	query	True	string	Client Api Version.
$count	query		boolean	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.
$filter	query		string	OData filter. Optional.
$orderby	query		string	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.
$select	query		string	OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
$skip	query		integer int32	The number of items to skip over before returning elements. Optional.
$top	query		integer int32	The number of items to return. Optional.

Responses

Name	Type	Description
200 OK	USqlTablePartitionList	Successfully retrieved the list of table partitions in the specified database, schema, and table.

Examples

Retrieves the list of table partitions from the Data Lake Analytics catalog

Sample Request

HTTP

GET https://contosoadla.azuredatalakeanalytics.net/catalog/usql/databases/master/schemas/dbo/tables/test_table_name/partitions?$filter=test_filter&$top=1&$skip=1&$select=test_select&$orderby=test_orderby&$count=False&api-version=2016-11-01

Sample Response

Status code:

200

{
  "nextLink": "https://contosoadla.datalakeanalytics.net/catalog/usql/databases/master/schema/dbo/statistics?api-version=2016-11-01&%24skiptoken=<token>",
  "value": [
    {
      "computeAccountName": "contosoadla",
      "version": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
      "databaseName": "master",
      "schemaName": "dbo",
      "partitionName": "test_partition_name",
      "parentName": "test_parent_name",
      "indexId": 1,
      "label": [
        "test_label_1",
        "test_label_2"
      ],
      "createDate": "2017-04-14T13:21:56.6819037-07:00"
    }
  ]
}

Definitions

Name	Description
DdlName	A Data Lake Analytics DDL name item.
USqlTablePartition	A Data Lake Analytics catalog U-SQL table partition item.
USqlTablePartitionList	A Data Lake Analytics catalog U-SQL table partition item list.

DdlName

A Data Lake Analytics DDL name item.

Name	Type	Description
firstPart	string	the name of the table associated with this database and schema.
secondPart	string	the name of the table associated with this database and schema.
server	string	the name of the table associated with this database and schema.
thirdPart	string	the name of the table associated with this database and schema.

USqlTablePartition

A Data Lake Analytics catalog U-SQL table partition item.

Name	Type	Description
computeAccountName	string	the name of the Data Lake Analytics account.
createDate	string	the creation time of the partition
databaseName	string	the name of the database.
indexId	integer	the index ID for this partition.
label	string[]	the list of labels associated with this partition.
parentName	DdlName	the Ddl object of the partition's parent.
partitionName	string	the name of the table partition.
schemaName	string	the name of the schema associated with this table partition and database.
version	string	the version of the catalog item.

USqlTablePartitionList

A Data Lake Analytics catalog U-SQL table partition item list.

Name	Type	Description
nextLink	string	the link to the next page of results.
value	USqlTablePartition[]	the list of table partitions in the database, schema and table combination