Catalog - Get Table Partition

Retrieves the specified table partition from the Data Lake Analytics catalog.

GET https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}?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 partition.

partitionName
path True
  • string

The name of the table partition.

schemaName
path True
  • string

The name of the schema containing the partition.

tableName
path True
  • string

The name of the table containing the partition.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

Successfully retrieved the details of the specified table partition in the specified database, schema, and table.

Examples

Retrieves the specified table partition from the Data Lake Analytics catalog

Sample Request

GET https://contosoadla.azuredatalakeanalytics.net/catalog/usql/databases/master/schemas/dbo/tables/test_table_name/partitions/test_partition_name?api-version=2016-11-01

Sample Response

{
  "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

DdlName

A Data Lake Analytics DDL name item.

USqlTablePartition

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

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

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.