Catalog - List Table Fragments

Reference

Service:: Data Lake Analytics

API Version:: 2016-11-01

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

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

With optional parameters:

GET https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/tablefragments?$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 table fragments.
schemaName	path	True	string	The name of the schema containing the table fragments.
tableName	path	True	string	The name of the table containing the table fragments.
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	USqlTableFragmentList	Successfully retrieved the list of table fragments in the specified database and schema.

Examples

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

Sample Request

HTTP

GET https://contosoadla.azuredatalakeanalytics.net/catalog/usql/databases/master/schemas/dbo/tables/test_table_name/tablefragments?$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/tables/test_table_name/tablefragments?api-version=2016-11-01&%24skiptoken=<token>",
  "value": [
    {
      "parentId": "9d2d7abd-c641-4ddb-88ab-90cafdfe1c1b",
      "fragmentId": "797d2643-eed9-4900-8090-0f8ddd9e8ba7",
      "indexId": 1,
      "size": 33786,
      "rowCount": 1,
      "createDate": "2017-10-11T06:38:31.567-07:00",
      "streamPath": "catalog/database/86bf2a20-b511-48c8-91c5-1f73c4c0ec74/schema/b83d3be1-9e11-40b7-85f9-ad823efe2414/table/1e666ab1-d6f0-4990-8180-1a6160caf405/91193f18-06dd-47a2-96fa-2cca3b4777e1.ss"
    }
  ]
}

Definitions

Name	Description
USqlTableFragment	A Data Lake Analytics catalog U-SQL table fragment item.
USqlTableFragmentList	A Data Lake Analytics catalog U-SQL table fragment item list.

USqlTableFragment

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

Name	Type	Description
createDate	string	the creation time of the table fragment.
fragmentId	string	the version of the catalog item.
indexId	integer	the ordinal of the index which contains the table fragment.
parentId	string	the parent object Id of the table fragment. The parent could be a table or table partition.
rowCount	integer	the number of rows in the table fragment.
size	integer	the data size of the table fragment in bytes.
streamPath	string	the relative path for the table fragment location.

USqlTableFragmentList

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

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

Share via