Catalog - Get Procedure

Service:

Data Lake Analytics

API Version:

2016-11-01

Retrieves the specified procedure from the Data Lake Analytics catalog.

GET https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures/{procedureName}?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 procedure.
procedureName	path	True	string	The name of the procedure.
schemaName	path	True	string	The name of the schema containing the procedure.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	USqlProcedure	Successfully retrieved the specified procedure from the underlying database and schema combination.

Examples

Retrieves the specified procedure from the Data Lake Analytics catalog

Sample Request

HTTP

GET https://contosoadla.azuredatalakeanalytics.net/catalog/usql/databases/master/schemas/dbo/procedures/test_procedure_name?api-version=2016-11-01

Sample Response

Status code:

200

{
  "computeAccountName": "contosoadla",
  "version": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
  "databaseName": "master",
  "schemaName": "dbo",
  "procName": "test_proc_name",
  "definition": "test_definition"
}

Definitions

USqlProcedure

A Data Lake Analytics catalog U-SQL procedure item.

Name	Type	Description
computeAccountName	string	the name of the Data Lake Analytics account.
databaseName	string	the name of the database.
definition	string	the defined query of the procedure.
procName	string	the name of the procedure.
schemaName	string	the name of the schema associated with this procedure and database.
version	string	the version of the catalog item.