{ "swagger": "2.0", "schemes": [ "https" ], "host": "azure.local", "info": { "description": "Creates an Azure Data Lake Analytics catalog client.", "title": "DataLakeAnalyticsCatalogManagementClient", "version": "2015-10-01-preview", "x-apisguru-categories": [ "cloud" ], "x-logo": { "url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png" }, "x-origin": [ { "format": "swagger", "url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/catalog.json", "version": "2.0" } ], "x-preferred": false, "x-providerName": "azure.com", "x-serviceName": "datalake-analytics-catalog", "x-tags": [ "Azure", "Microsoft" ] }, "consumes": [ "application/json", "text/json", "application/octet-stream" ], "produces": [ "application/json", "text/json", "application/octet-stream" ], "parameters": { "ApiVersionParameter": { "description": "Client Api Version.", "in": "query", "name": "api-version", "required": true, "type": "string" }, "adlaCatalogDnsSuffixInPath": { "default": "azuredatalakeanalytics.net", "description": "Gets the DNS suffix used as the base for all Azure Data Lake Analytics Catalog service requests.", "in": "path", "name": "adlaCatalogDnsSuffix", "required": true, "type": "string", "x-ms-parameter-location": "client", "x-ms-skip-url-encoding": true } }, "paths": { "/catalog/usql/databases": { "get": { "description": "Retrieves the list of databases from the Data Lake Analytics catalog.", "operationId": "Catalog_ListDatabases", "parameters": [ { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlDatabaseList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlDatabase", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}": { "get": { "description": "Retrieves the specified database from the Data Lake Analytics catalog.", "operationId": "Catalog_GetDatabase", "parameters": [ { "description": "The name of the database.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlDatabase" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/assemblies": { "get": { "description": "Retrieves the list of assemblies from the Data Lake Analytics catalog.", "operationId": "Catalog_ListAssemblies", "parameters": [ { "description": "The name of the database containing the assembly.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlAssemblyList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlAssembly", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/assemblies/{assemblyName}": { "get": { "description": "Retrieves the specified assembly from the Data Lake Analytics catalog.", "operationId": "Catalog_GetAssembly", "parameters": [ { "description": "The name of the database containing the assembly.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the assembly.", "in": "path", "name": "assemblyName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlAssembly" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/credentials": { "get": { "description": "Retrieves the list of credentials from the Data Lake Analytics catalog.", "operationId": "Catalog_ListCredentials", "parameters": [ { "description": "The name of the database containing the schema.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlCredentialList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlCredential", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/credentials/{credentialName}": { "get": { "description": "Retrieves the specified credential from the Data Lake Analytics catalog.", "operationId": "Catalog_GetCredential", "parameters": [ { "description": "The name of the database containing the schema.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the credential.", "in": "path", "name": "credentialName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlCredential" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/externaldatasources": { "get": { "description": "Retrieves the list of external data sources from the Data Lake Analytics catalog.", "operationId": "Catalog_ListExternalDataSources", "parameters": [ { "description": "The name of the database containing the external data sources.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlExternalDataSourceList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlExternalDataSource", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/externaldatasources/{externalDataSourceName}": { "get": { "description": "Retrieves the specified external data source from the Data Lake Analytics catalog.", "operationId": "Catalog_GetExternalDataSource", "parameters": [ { "description": "The name of the database containing the external data source.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the external data source.", "in": "path", "name": "externalDataSourceName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlExternalDataSource" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/schemas": { "get": { "description": "Retrieves the list of schemas from the Data Lake Analytics catalog.", "operationId": "Catalog_ListSchemas", "parameters": [ { "description": "The name of the database containing the schema.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlSchemaList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlSchema", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}": { "get": { "description": "Retrieves the specified schema from the Data Lake Analytics catalog.", "operationId": "Catalog_GetSchema", "parameters": [ { "description": "The name of the database containing the schema.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlSchema" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures": { "get": { "description": "Retrieves the list of procedures from the Data Lake Analytics catalog.", "operationId": "Catalog_ListProcedures", "parameters": [ { "description": "The name of the database containing the procedures.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the procedures.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlProcedureList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlProcedure", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures/{procedureName}": { "get": { "description": "Retrieves the specified procedure from the Data Lake Analytics catalog.", "operationId": "Catalog_GetProcedure", "parameters": [ { "description": "The name of the database containing the procedure.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the procedure.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the procedure.", "in": "path", "name": "procedureName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlProcedure" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables": { "get": { "description": "Retrieves the list of tables from the Data Lake Analytics catalog.", "operationId": "Catalog_ListTables", "parameters": [ { "description": "The name of the database containing the tables.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the tables.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTableList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlTable", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}": { "get": { "description": "Retrieves the specified table from the Data Lake Analytics catalog.", "operationId": "Catalog_GetTable", "parameters": [ { "description": "The name of the database containing the table.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the table.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the table.", "in": "path", "name": "tableName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTable" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions": { "get": { "description": "Retrieves the list of table partitions from the Data Lake Analytics catalog.", "operationId": "Catalog_ListTablePartitions", "parameters": [ { "description": "The name of the database containing the partitions.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the partitions.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the table containing the partitions.", "in": "path", "name": "tableName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTablePartitionList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlTablePartition", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}": { "get": { "description": "Retrieves the specified table partition from the Data Lake Analytics catalog.", "operationId": "Catalog_GetTablePartition", "parameters": [ { "description": "The name of the database containing the partition.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the partition.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the table containing the partition.", "in": "path", "name": "tableName", "required": true, "type": "string" }, { "description": "The name of the table partition.", "in": "path", "name": "partitionName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTablePartition" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics": { "get": { "description": "Retrieves the list of table statistics from the Data Lake Analytics catalog.", "operationId": "Catalog_ListTableStatistics", "parameters": [ { "description": "The name of the database containing the statistics.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the statistics.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the table containing the statistics.", "in": "path", "name": "tableName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTableStatisticsList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlTableStatistics", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics/{statisticsName}": { "get": { "description": "Retrieves the specified table statistics from the Data Lake Analytics catalog.", "operationId": "Catalog_GetTableStatistic", "parameters": [ { "description": "The name of the database containing the statistics.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the statistics.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the table containing the statistics.", "in": "path", "name": "tableName", "required": true, "type": "string" }, { "description": "The name of the table statistics.", "in": "path", "name": "statisticsName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTableStatistics" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tabletypes": { "get": { "description": "Retrieves the list of table types from the Data Lake Analytics catalog.", "operationId": "Catalog_ListTableTypes", "parameters": [ { "description": "The name of the database containing the table types.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the table types.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTableTypeList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlTableType", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tabletypes/{tableTypeName}": { "get": { "description": "Retrieves the specified table type from the Data Lake Analytics catalog.", "operationId": "Catalog_GetTableType", "parameters": [ { "description": "The name of the database containing the table type.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the table type.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the table type to retrieve.", "in": "path", "name": "tableTypeName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTableType" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions": { "get": { "description": "Retrieves the list of table valued functions from the Data Lake Analytics catalog.", "operationId": "Catalog_ListTableValuedFunctions", "parameters": [ { "description": "The name of the database containing the table valued functions.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the table valued functions.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTableValuedFunctionList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlTableValuedFunction", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions/{tableValuedFunctionName}": { "get": { "description": "Retrieves the specified table valued function from the Data Lake Analytics catalog.", "operationId": "Catalog_GetTableValuedFunction", "parameters": [ { "description": "The name of the database containing the table valued function.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the table valued function.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the tableValuedFunction.", "in": "path", "name": "tableValuedFunctionName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTableValuedFunction" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/types": { "get": { "description": "Retrieves the list of types within the specified database and schema from the Data Lake Analytics catalog.", "operationId": "Catalog_ListTypes", "parameters": [ { "description": "The name of the database containing the types.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the types.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlTypeList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlType", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/views": { "get": { "description": "Retrieves the list of views from the Data Lake Analytics catalog.", "operationId": "Catalog_ListViews", "parameters": [ { "description": "The name of the database containing the views.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the views.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "OData filter. Optional.", "in": "query", "name": "$filter", "required": false, "type": "string" }, { "description": "The number of items to return. Optional.", "format": "int32", "in": "query", "name": "$top", "required": false, "type": "integer" }, { "description": "The number of items to skip over before returning elements. Optional.", "format": "int32", "in": "query", "name": "$skip", "required": false, "type": "integer" }, { "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional.", "in": "query", "name": "$expand", "required": false, "type": "string" }, { "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.", "in": "query", "name": "$select", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$orderby", "required": false, "type": "string" }, { "description": "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.", "in": "query", "name": "$count", "required": false, "type": "boolean" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlViewList" } } }, "tags": [ "Catalog" ], "x-ms-odata": "#/definitions/USqlView", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/views/{viewName}": { "get": { "description": "Retrieves the specified view from the Data Lake Analytics catalog.", "operationId": "Catalog_GetView", "parameters": [ { "description": "The name of the database containing the view.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the schema containing the view.", "in": "path", "name": "schemaName", "required": true, "type": "string" }, { "description": "The name of the view.", "in": "path", "name": "viewName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlView" } } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/secrets": { "delete": { "description": "Deletes all secrets in the specified database", "operationId": "Catalog_DeleteAllSecrets", "parameters": [ { "description": "The name of the database containing the secret.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "" } }, "tags": [ "Catalog" ] } }, "/catalog/usql/databases/{databaseName}/secrets/{secretName}": { "delete": { "description": "Deletes the specified secret in the specified database", "operationId": "Catalog_DeleteSecret", "parameters": [ { "description": "The name of the database containing the secret.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the secret to delete", "in": "path", "name": "secretName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "" } }, "tags": [ "Catalog" ] }, "get": { "description": "Gets the specified secret in the specified database", "operationId": "Catalog_GetSecret", "parameters": [ { "description": "The name of the database containing the secret.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the secret to get", "in": "path", "name": "secretName", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlSecret" } } }, "tags": [ "Catalog" ] }, "patch": { "description": "Modifies the specified secret for use with external data sources in the specified database", "operationId": "Catalog_UpdateSecret", "parameters": [ { "description": "The name of the database containing the secret.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the secret.", "in": "path", "name": "secretName", "required": true, "type": "string" }, { "description": "The parameters required to modify the secret (name and password)", "in": "body", "name": "parameters", "required": true, "schema": { "$ref": "#/definitions/DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlSecret" } } }, "tags": [ "Catalog" ] }, "put": { "description": "Creates the specified secret for use with external data sources in the specified database.", "operationId": "Catalog_CreateSecret", "parameters": [ { "description": "The name of the database in which to create the secret.", "in": "path", "name": "databaseName", "required": true, "type": "string" }, { "description": "The name of the secret.", "in": "path", "name": "secretName", "required": true, "type": "string" }, { "description": "The parameters required to create the secret (name and password)", "in": "body", "name": "parameters", "required": true, "schema": { "$ref": "#/definitions/DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/USqlSecret" } } }, "tags": [ "Catalog" ] } } }, "definitions": { "CatalogItem": { "description": "A Data Lake Analytics catalog item.", "properties": { "computeAccountName": { "description": "the name of the Data Lake Analytics account.", "type": "string" }, "version": { "description": "the version of the catalog item.", "format": "uuid", "type": "string" } } }, "CatalogItemList": { "description": "A Data Lake Analytics catalog item list.", "properties": { "count": { "description": "the count of items in the list.", "format": "int32", "type": "integer" }, "nextLink": { "description": "the link to the next page of results.", "type": "string" } } }, "DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters": { "description": "DataLakeAnalytics DataLakeAnalyticsAccount information.", "properties": { "password": { "description": "the password for the secret to pass in", "type": "string" }, "uri": { "description": "the URI identifier for the secret in the format :", "type": "string" } }, "required": [ "password" ] }, "DdlName": { "description": "A Data Lake Analytics DDL name item.", "properties": { "firstPart": { "description": "the name of the table associated with this database and schema.", "type": "string" }, "secondPart": { "description": "the name of the table associated with this database and schema.", "type": "string" }, "server": { "description": "the name of the table associated with this database and schema.", "type": "string" }, "thirdPart": { "description": "the name of the table associated with this database and schema.", "type": "string" } } }, "EntityId": { "description": "A Data Lake Analytics catalog entity identifier object.", "properties": { "name": { "$ref": "#/definitions/DdlName", "description": "the name of the external table associated with this database, schema and table." }, "version": { "description": "the version of the external data source.", "format": "uuid", "type": "string" } } }, "ExternalTable": { "description": "A Data Lake Analytics catalog external table item.", "properties": { "dataSource": { "$ref": "#/definitions/EntityId", "description": "the data source associated with this external table." }, "tableName": { "description": "the name of the table associated with this database and schema.", "type": "string" } } }, "TypeFieldInfo": { "description": "A Data Lake Analytics catalog type field information item.", "properties": { "name": { "description": "the name of the field associated with this type.", "type": "string" }, "type": { "description": "the type of the field.", "type": "string" } } }, "USqlAssembly": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL Assembly.", "properties": { "assemblyName": { "description": "the name of the assembly.", "type": "string", "x-ms-client-name": "name" }, "clrName": { "description": "the name of the CLR.", "type": "string" }, "databaseName": { "description": "the name of the database.", "type": "string" }, "dependencies": { "description": "the list of dependencies associated with the assembly", "items": { "$ref": "#/definitions/USqlAssemblyDependencyInfo" }, "type": "array" }, "files": { "description": "the list of files associated with the assembly", "items": { "$ref": "#/definitions/USqlAssemblyFileInfo" }, "type": "array" }, "isUserDefined": { "description": "the switch indicating if this assembly is user defined or not.", "type": "boolean" }, "isVisible": { "description": "the switch indicating if this assembly is visible or not.", "type": "boolean" } } }, "USqlAssemblyClr": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL assembly CLR item.", "properties": { "assemblyClrName": { "description": "the name of the assembly.", "type": "string", "x-ms-client-name": "name" }, "clrName": { "description": "the name of the CLR.", "type": "string" }, "databaseName": { "description": "the name of the database.", "type": "string" } } }, "USqlAssemblyDependencyInfo": { "description": "A Data Lake Analytics catalog U-SQL dependency information item.", "properties": { "entityId": { "$ref": "#/definitions/EntityId", "description": "the EntityId of the dependency." } } }, "USqlAssemblyFileInfo": { "description": "A Data Lake Analytics catalog U-SQL assembly file information item.", "properties": { "contentPath": { "description": "The content path to the assembly file.", "type": "string" }, "originalPath": { "description": "The original path to the assembly file.", "type": "string" }, "type": { "description": "the assembly file type.", "enum": [ "Assembly", "Resource" ], "type": "string", "x-ms-enum": { "modelAsString": false, "name": "FileType" } } } }, "USqlAssemblyList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL assembly CLR item list.", "properties": { "value": { "description": "the list of assemblies in the database", "items": { "$ref": "#/definitions/USqlAssemblyClr" }, "readOnly": true, "type": "array" } } }, "USqlCredential": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL credential item.", "properties": { "credentialName": { "description": "the name of the credential.", "type": "string", "x-ms-client-name": "name" }, "databaseName": { "description": "the name of the database the credential is in.", "type": "string" }, "identity": { "description": "the name of the secret associated with the credential.", "type": "string" }, "userName": { "description": "the user name associated with the credential.", "type": "string" } } }, "USqlCredentialList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL credential item list.", "properties": { "value": { "description": "the list of credentials in the database", "items": { "$ref": "#/definitions/USqlCredential" }, "readOnly": true, "type": "array" } } }, "USqlDatabase": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL database item.", "properties": { "databaseName": { "description": "the name of the database.", "type": "string", "x-ms-client-name": "name" } } }, "USqlDatabaseList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL database item list.", "properties": { "value": { "description": "the list of databases", "items": { "$ref": "#/definitions/USqlDatabase" }, "readOnly": true, "type": "array" } } }, "USqlDirectedColumn": { "description": "A Data Lake Analytics catalog U-SQL directed column item.", "properties": { "descending": { "description": "the switch indicating if the index is descending or not.", "type": "boolean" }, "name": { "description": "the name of the index in the table.", "type": "string" } } }, "USqlDistributionInfo": { "description": "A Data Lake Analytics catalog U-SQL distribution information object.", "properties": { "count": { "description": "the count of indices using this distribution.", "format": "int32", "type": "integer" }, "dynamicCount": { "description": "the dynamic count of indices using this distribution.", "format": "int32", "type": "integer" }, "keys": { "description": "the list of directed columns in the distribution", "items": { "$ref": "#/definitions/USqlDirectedColumn" }, "type": "array" }, "type": { "description": "the type of this distribution.", "format": "int32", "type": "integer" } } }, "USqlExternalDataSource": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL external datasource item.", "properties": { "databaseName": { "description": "the name of the database.", "type": "string" }, "externalDataSourceName": { "description": "the name of the external data source.", "type": "string", "x-ms-client-name": "name" }, "provider": { "description": "the name of the provider for the external data source.", "type": "string" }, "providerString": { "description": "the name of the provider string for the external data source.", "type": "string" }, "pushdownTypes": { "description": "the list of types to push down from the external data source.", "items": { "type": "string" }, "type": "array" } } }, "USqlExternalDataSourceList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL external datasource item list.", "properties": { "value": { "description": "the list of external data sources in the database", "items": { "$ref": "#/definitions/USqlExternalDataSource" }, "readOnly": true, "type": "array" } } }, "USqlIndex": { "description": "A Data Lake Analytics catalog U-SQL table index item.", "properties": { "columns": { "description": "the list of columns in the index", "items": { "type": "string" }, "type": "array" }, "distributionInfo": { "$ref": "#/definitions/USqlDistributionInfo", "description": "the distributions info of the index" }, "indexId": { "description": "the ID of this index within the table.", "format": "int32", "type": "integer" }, "indexKeys": { "description": "the list of directed columns in the index", "items": { "$ref": "#/definitions/USqlDirectedColumn" }, "type": "array" }, "isColumnstore": { "description": "the switch indicating if this index is a columnstore index.", "type": "boolean" }, "isUnique": { "description": "the switch indicating if this index is a unique index.", "type": "boolean" }, "name": { "description": "the name of the index in the table.", "type": "string" }, "partitionFunction": { "description": "partition function ID for the index.", "format": "uuid", "type": "string" }, "partitionKeyList": { "description": "the list of partition keys in the index", "items": { "type": "string" }, "type": "array" }, "streamNames": { "description": "the list of full paths to the streams that contain this index in the DataLake account.", "items": { "type": "string" }, "type": "array" } } }, "USqlProcedure": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL procedure item.", "properties": { "databaseName": { "description": "the name of the database.", "type": "string" }, "definition": { "description": "the defined query of the procedure.", "type": "string" }, "procName": { "description": "the name of the procedure.", "type": "string", "x-ms-client-name": "name" }, "schemaName": { "description": "the name of the schema associated with this procedure and database.", "type": "string" } } }, "USqlProcedureList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL procedure item list.", "properties": { "value": { "description": "the list of procedure in the database and schema combination", "items": { "$ref": "#/definitions/USqlProcedure" }, "readOnly": true, "type": "array" } } }, "USqlSchema": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL schema item.", "properties": { "databaseName": { "description": "the name of the database.", "type": "string" }, "schemaName": { "description": "the name of the schema.", "type": "string", "x-ms-client-name": "name" } } }, "USqlSchemaList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL schema item list.", "properties": { "value": { "description": "the list of schemas in the database", "items": { "$ref": "#/definitions/USqlSchema" }, "readOnly": true, "type": "array" } } }, "USqlSecret": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL secret item.", "properties": { "creationTime": { "description": "the creation time of the credential object. This is the only information returned about a secret from a GET.", "format": "date-time", "type": "string" }, "databaseName": { "description": "the name of the database.", "type": "string" }, "password": { "description": "the password for the secret to pass in", "type": "string" }, "secretName": { "description": "the name of the secret.", "type": "string", "x-ms-client-name": "name" }, "uri": { "description": "the URI identifier for the secret in the format :", "type": "string" } } }, "USqlTable": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL table item.", "properties": { "columnList": { "description": "the list of columns in this table", "items": { "$ref": "#/definitions/USqlTableColumn" }, "type": "array" }, "databaseName": { "description": "the name of the database.", "type": "string" }, "distributionInfo": { "$ref": "#/definitions/USqlDistributionInfo", "description": "the distributions info of the table" }, "externalTable": { "$ref": "#/definitions/ExternalTable", "description": "the external table associated with the table." }, "indexList": { "description": "the list of indices in this table", "items": { "$ref": "#/definitions/USqlIndex" }, "type": "array" }, "partitionKeyList": { "description": "the list of partition keys in the table", "items": { "type": "string" }, "type": "array" }, "schemaName": { "description": "the name of the schema associated with this table and database.", "type": "string" }, "tableName": { "description": "the name of the table.", "type": "string", "x-ms-client-name": "name" } } }, "USqlTableColumn": { "description": "A Data Lake Analytics catalog U-SQL table column item.", "properties": { "name": { "description": "the name of the column in the table.", "type": "string" }, "type": { "description": "the object type of the specified column (such as System.String).", "type": "string" } } }, "USqlTableList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL table item list.", "properties": { "value": { "description": "the list of tables in the database and schema combination", "items": { "$ref": "#/definitions/USqlTable" }, "readOnly": true, "type": "array" } } }, "USqlTablePartition": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL table partition item.", "properties": { "createDate": { "description": "the creation time of the partition", "format": "date-time", "type": "string" }, "databaseName": { "description": "the name of the database.", "type": "string" }, "indexId": { "description": "the index ID for this partition.", "format": "int32", "type": "integer" }, "label": { "description": "the list of labels associated with this partition.", "items": { "type": "string" }, "type": "array" }, "parentName": { "$ref": "#/definitions/DdlName", "description": "the Ddl object of the partition's parent." }, "partitionName": { "description": "the name of the table partition.", "type": "string", "x-ms-client-name": "name" }, "schemaName": { "description": "the name of the schema associated with this table partition and database.", "type": "string" } } }, "USqlTablePartitionList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL table partition item list.", "properties": { "value": { "description": "the list of table partitions in the database, schema and table combination", "items": { "$ref": "#/definitions/USqlTablePartition" }, "readOnly": true, "type": "array" } } }, "USqlTableStatistics": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL table statistics item.", "properties": { "colNames": { "description": "the list of column names associated with these statistics.", "items": { "type": "string" }, "type": "array" }, "createTime": { "description": "the creation time of the statistics.", "format": "date-time", "type": "string" }, "databaseName": { "description": "the name of the database.", "type": "string" }, "filterDefinition": { "description": "the filter definition for the statistics.", "type": "string" }, "hasFilter": { "description": "the switch indicating if these statistics have a filter.", "type": "boolean" }, "isAutoCreated": { "description": "the switch indicating if these statistics are automatically created.", "type": "boolean" }, "isUserCreated": { "description": "the switch indicating if these statistics are user created.", "type": "boolean" }, "schemaName": { "description": "the name of the schema associated with this table and database.", "type": "string" }, "statDataPath": { "description": "the path to the statistics data.", "type": "string" }, "statisticsName": { "description": "the name of the table statistics.", "type": "string", "x-ms-client-name": "name" }, "tableName": { "description": "the name of the table.", "type": "string" }, "updateTime": { "description": "the last time the statistics were updated.", "format": "date-time", "type": "string" }, "userStatName": { "description": "the name of the user statistics.", "type": "string" } } }, "USqlTableStatisticsList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL table statistics item list.", "properties": { "value": { "description": "the list of table statistics in the database, schema and table combination", "items": { "$ref": "#/definitions/USqlTableStatistics" }, "readOnly": true, "type": "array" } } }, "USqlTableType": { "allOf": [ { "$ref": "#/definitions/USqlType" } ], "description": "A Data Lake Analytics catalog U-SQL table type item.", "properties": { "columns": { "description": "the type field information associated with this table type.", "items": { "$ref": "#/definitions/TypeFieldInfo" }, "readOnly": true, "type": "array" } } }, "USqlTableTypeList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL table type item list.", "properties": { "value": { "description": "the list of table types in the database and schema combination", "items": { "$ref": "#/definitions/USqlTableType" }, "readOnly": true, "type": "array" } } }, "USqlTableValuedFunction": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL table valued function item.", "properties": { "databaseName": { "description": "the name of the database.", "type": "string" }, "definition": { "description": "the definition of the table valued function.", "type": "string" }, "schemaName": { "description": "the name of the schema associated with this database.", "type": "string" }, "tvfName": { "description": "the name of the table valued function.", "type": "string", "x-ms-client-name": "name" } } }, "USqlTableValuedFunctionList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL table valued function item list.", "properties": { "value": { "description": "the list of table valued functions in the database and schema combination", "items": { "$ref": "#/definitions/USqlTableValuedFunction" }, "readOnly": true, "type": "array" } } }, "USqlType": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL type item.", "properties": { "cSharpName": { "description": "the C# name for this type.", "type": "string" }, "databaseName": { "description": "the name of the database.", "type": "string" }, "fullCSharpName": { "description": "the fully qualified C# name for this type.", "type": "string" }, "isAssemblyType": { "description": "The switch indicating if this type is an assembly type.", "type": "boolean" }, "isComplexType": { "description": "The switch indicating if this type is a complex type.", "type": "boolean" }, "isNullable": { "description": "The switch indicating if this type is nullable.", "type": "boolean" }, "isTableType": { "description": "The switch indicating if this type is a table type.", "type": "boolean" }, "isUserDefined": { "description": "The switch indicating if this type is user defined.", "type": "boolean" }, "principalId": { "description": "the principal ID for this type.", "format": "int32", "type": "integer" }, "schemaId": { "description": "the schema ID for this type.", "format": "int32", "type": "integer" }, "schemaName": { "description": "the name of the schema associated with this table and database.", "type": "string" }, "systemTypeId": { "description": "the system type ID for this type.", "format": "int32", "type": "integer" }, "typeFamily": { "description": "the type family for this type.", "type": "string" }, "typeName": { "description": "the name of type for this type.", "type": "string", "x-ms-client-name": "name" }, "userTypeId": { "description": "the user type ID for this type.", "format": "int32", "type": "integer" } } }, "USqlTypeList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL type item list.", "properties": { "value": { "description": "the list of types in the database and schema combination", "items": { "$ref": "#/definitions/USqlType" }, "readOnly": true, "type": "array" } } }, "USqlView": { "allOf": [ { "$ref": "#/definitions/CatalogItem" } ], "description": "A Data Lake Analytics catalog U-SQL view item.", "properties": { "databaseName": { "description": "the name of the database.", "type": "string" }, "definition": { "description": "the defined query of the view.", "type": "string" }, "schemaName": { "description": "the name of the schema associated with this view and database.", "type": "string" }, "viewName": { "description": "the name of the view.", "type": "string", "x-ms-client-name": "name" } } }, "USqlViewList": { "allOf": [ { "$ref": "#/definitions/CatalogItemList" } ], "description": "A Data Lake Analytics catalog U-SQL view item list.", "properties": { "value": { "description": "the list of view in the database and schema combination", "items": { "$ref": "#/definitions/USqlView" }, "readOnly": true, "type": "array" } } } }, "x-ms-parameterized-host": { "hostTemplate": "{accountName}.{adlaCatalogDnsSuffix}", "parameters": [ { "description": "The Azure Data Lake Analytics account to execute catalog operations on.", "in": "path", "name": "accountName", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/adlaCatalogDnsSuffixInPath" } ] } }