Catalog - List Table Types

Reference

Service:: Data Lake Analytics

API Version:: 2016-11-01

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

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

With optional parameters:

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

Examples

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

Sample Request

HTTP

GET https://contosoadla.azuredatalakeanalytics.net/catalog/usql/databases/master/schemas/dbo/tabletypes?$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",
      "typeName": "test_type_name",
      "typeFamily": "test_type_family",
      "cSharpName": "test_csharp_name",
      "fullCSharpName": "test_full_csharp_name",
      "systemTypeId": 1,
      "userTypeId": 2,
      "schemaId": 3,
      "principalId": 4,
      "isNullable": false,
      "isUserDefined": false,
      "isAssemblyType": false,
      "isTableType": false,
      "isComplexType": false,
      "columns": [
        {
          "name": "test_column_name",
          "type": "test_column_type"
        }
      ]
    }
  ]
}

Definitions

Name	Description
TypeFieldInfo	A Data Lake Analytics catalog type field information item.
USqlTableType	A Data Lake Analytics catalog U-SQL table type item.
USqlTableTypeList	A Data Lake Analytics catalog U-SQL table type item list.

TypeFieldInfo

A Data Lake Analytics catalog type field information item.

Name	Type	Description
name	string	the name of the field associated with this type.
type	string	the type of the field.

USqlTableType

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

Name	Type	Description
cSharpName	string	the C# name for this type.
columns	TypeFieldInfo[]	the type field information associated with this table type.
computeAccountName	string	the name of the Data Lake Analytics account.
databaseName	string	the name of the database.
fullCSharpName	string	the fully qualified C# name for this type.
isAssemblyType	boolean	The switch indicating if this type is an assembly type.
isComplexType	boolean	The switch indicating if this type is a complex type.
isNullable	boolean	The switch indicating if this type is nullable.
isTableType	boolean	The switch indicating if this type is a table type.
isUserDefined	boolean	The switch indicating if this type is user defined.
principalId	integer	the principal ID for this type.
schemaId	integer	the schema ID for this type.
schemaName	string	the name of the schema associated with this table and database.
systemTypeId	integer	the system type ID for this type.
typeFamily	string	the type family for this type.
typeName	string	the name of type for this type.
userTypeId	integer	the user type ID for this type.
version	string	the version of the catalog item.

USqlTableTypeList

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

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