openapi-directory/api/azure.com/datalake-analytics-catalog.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Creates an Azure Data Lake Analytics catalog client.","title":"DataLakeAnalyticsCatalogManagementClient","version":"2016-11-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"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/stable/2016-11-01/catalog.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"datalake-analytics-catalog","x-tags":["Azure","Microsoft"]},"paths":{"/catalog/usql/acl":{"get":{"description":"Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog.","operationId":"Catalog_ListAcls","parameters":[{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of access control list (ACL) entries for the Data Lake Analytics catalog.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclList"},"examples":{"Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_access_control_list_ACL_entries_for_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/Acl","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/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,"schema":{"type":"string"},"examples":{"Retrieves the list of databases from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of databases from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of databases from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of databases from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of databases from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of databases from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of databases.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlDatabaseList"},"examples":{"Retrieves the list of databases from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_databases_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/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,"schema":{"type":"string"},"examples":{"Retrieves the specified database from the Data Lake Analytics catalog":{"value":"master"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the details of the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlDatabase"},"examples":{"Retrieves the specified database from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_specified_database_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"]}},"/catalog/usql/databases/{databaseName}/acl":{"get":{"description":"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog.","operationId":"Catalog_ListAclsByDatabase","parameters":[{"description":"The name of the database.","in":"path","name":"databaseName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of access control list (ACL) entries for the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclList"},"examples":{"Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_access_control_list_ACL_entries_for_the_database_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/Acl","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/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,"schema":{"type":"string"},"examples":{"Retrieves the list of assemblies from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of assemblies from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of assemblies from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of assemblies from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of assemblies from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of assemblies from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of assemblies from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of assemblies in the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlAssemblyList"},"examples":{"Retrieves the list of assemblies from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_assemblies_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/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,"schema":{"type":"string"},"examples":{"Retrieves the specified assembly from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the assembly.","in":"path","name":"assemblyName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified assembly from the Data Lake Analytics catalog":{"value":"test_assembly_name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the details of the specified assembly in the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlAssembly"},"examples":{"Retrieves the specified assembly from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_specified_assembly_from_the_Data_Lake_Analytics_catalog"}}}}}},"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,"schema":{"type":"string"},"examples":{"Retrieves the list of credentials from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of credentials from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of credentials from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of credentials from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of credentials from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of credentials from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of credentials from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of credentials in the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlCredentialList"},"examples":{"Retrieves the list of credentials from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_credentials_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/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,"schema":{"type":"string"},"examples":{"Retrieves the specified credential from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the credential.","in":"path","name":"credentialName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified credential from the Data Lake Analytics catalog":{"value":"test_credential_name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified credential (name only) from the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlCredential"},"examples":{"Retrieves the specified credential from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_specified_credential_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"]},"patch":{"description":"Modifies the specified credential for use with external data sources in the specified database","operationId":"Catalog_UpdateCredential","parameters":[{"description":"The name of the database containing the credential.","in":"path","name":"databaseName","required":true,"schema":{"type":"string"},"examples":{"Modifies the specified credential for use with external data sources in the specified database":{"value":"master"}}},{"description":"The name of the credential.","in":"path","name":"credentialName","required":true,"schema":{"type":"string"},"examples":{"Modifies the specified credential for use with external data sources in the specified database":{"value":"test_credential_name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLakeAnalyticsCatalogCredentialUpdateParameters"}}},"description":"The parameters required to modify the credential (name and password)","required":true},"responses":{"200":{"description":"Successfully updated the specified credential's password in the specified database"}},"tags":["Catalog"]},"post":{"description":"Deletes the specified credential in the specified database","operationId":"Catalog_DeleteCredential","parameters":[{"description":"The name of the database containing the credential.","in":"path","name":"databaseName","required":true,"schema":{"type":"string"},"examples":{"Deletes the specified credential in the specified database":{"value":"master"}}},{"description":"The name of the credential to delete","in":"path","name":"credentialName","required":true,"schema":{"type":"string"},"examples":{"Deletes the specified credential in the specified database":{"value":"test_credential_name"}}},{"description":"Indicates if the delete should be a cascading delete (which deletes all resources dependent on the credential as well as the credential) or not. If false will fail if there are any resources relying on the credential.","in":"query","name":"cascade","required":false,"schema":{"type":"boolean","default":false},"examples":{"Deletes the specified credential in the specified database":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLakeAnalyticsCatalogCredentialDeleteParameters"}}},"description":"The parameters to delete a credential if the current user is not the account owner."},"responses":{"200":{"description":"Successfully deleted the specified credential from the specified database."}},"tags":["Catalog"]},"put":{"description":"Creates the specified credential for use with external data sources in the specified database.","operationId":"Catalog_CreateCredential","parameters":[{"description":"The name of the database in which to create the credential. Note: This is NOT an external database name, but the name of an existing U-SQL database that should contain the new credential object.","in":"path","name":"databaseName","required":true,"schema":{"type":"string"},"examples":{"Creates the specified credential for use with external data sources in the specified database":{"value":"master"}}},{"description":"The name of the credential.","in":"path","name":"credentialName","required":true,"schema":{"type":"string"},"examples":{"Creates the specified credential for use with external data sources in the specified database":{"value":"test_credential_name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataLakeAnalyticsCatalogCredentialCreateParameters"}}},"description":"The parameters required to create the credential (name and password)","required":true},"responses":{"200":{"description":"Successfully created the credential within the specified database."}},"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,"schema":{"type":"string"},"examples":{"Retrieves the list of external data sources from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of external data sources from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of external data sources from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of external data sources from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of external data sources from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of external data sources from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of external data sources from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of external data sources in the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlExternalDataSourceList"},"examples":{"Retrieves the list of external data sources from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_external_data_sources_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/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,"schema":{"type":"string"},"examples":{"Retrieves the specified external data source from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the external data source.","in":"path","name":"externalDataSourceName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified external data source from the Data Lake Analytics catalog":{"value":"test_external_data_source_name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved details of the specified external data source in the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlExternalDataSource"},"examples":{"Retrieves the specified external data source from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_specified_external_data_source_from_the_Data_Lake_Analytics_catalog"}}}}}},"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,"schema":{"type":"string"},"examples":{"Retrieves the list of schemas from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of schemas from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of schemas from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of schemas from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of schemas from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of schemas from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of schemas from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of schemas in the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlSchemaList"},"examples":{"Retrieves the list of schemas from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_schemas_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/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,"schema":{"type":"string"},"examples":{"Retrieves the specified schema from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified schema from the Data Lake Analytics catalog":{"value":"dbo"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the details of the specified schema in the specified database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlSchema"},"examples":{"Retrieves the specified schema from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_specified_schema_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"]}},"/catalog/usql/databases/{databaseName}/schemas/{schemaName}/packages":{"get":{"description":"Retrieves the list of packages from the Data Lake Analytics catalog.","operationId":"Catalog_ListPackages","parameters":[{"description":"The name of the database containing the packages.","in":"path","name":"databaseName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema containing the packages.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"value":"dbo"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of packages in the specified database and schema.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlPackageList"},"examples":{"Retrieves the list of packages from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_packages_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/USqlPackage","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/catalog/usql/databases/{databaseName}/schemas/{schemaName}/packages/{packageName}":{"get":{"description":"Retrieves the specified package from the Data Lake Analytics catalog.","operationId":"Catalog_GetPackage","parameters":[{"description":"The name of the database containing the package.","in":"path","name":"databaseName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified package from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema containing the package.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified package from the Data Lake Analytics catalog":{"value":"dbo"}}},{"description":"The name of the package.","in":"path","name":"packageName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified package from the Data Lake Analytics catalog":{"value":"test_package_name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified package from the underlying database and schema combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlPackage"},"examples":{"Retrieves the specified package from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_specified_package_from_the_Data_Lake_Analytics_catalog"}}}}}},"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,"schema":{"type":"string"},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema containing the procedures.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"value":"dbo"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of procedures in the specified database and schema.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlProcedureList"},"examples":{"Retrieves the list of procedures from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_procedures_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/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,"schema":{"type":"string"},"examples":{"Retrieves the specified procedure from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema containing the procedure.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified procedure from the Data Lake Analytics catalog":{"value":"dbo"}}},{"description":"The name of the procedure.","in":"path","name":"procedureName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified procedure from the Data Lake Analytics catalog":{"value":"test_procedure_name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified procedure from the underlying database and schema combination.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlProcedure"},"examples":{"Retrieves the specified procedure from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_specified_procedure_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"]}},"/catalog/usql/databases/{databaseName}/schemas/{schemaName}/statistics":{"get":{"description":"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog.","operationId":"Catalog_ListTableStatisticsByDatabaseAndSchema","parameters":[{"description":"The name of the database containing the statistics.","in":"path","name":"databaseName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema containing the statistics.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"value":"dbo"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of all table statistics in the specified database and schema.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlTableStatisticsList"},"examples":{"Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_all_table_statistics_within_the_specified_schema_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/USqlTableStatistics","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/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,"schema":{"type":"string"},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema containing the tables.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":"dbo"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":1}}},{"description":"The number of items to skip over before returning elements. Optional.","in":"query","name":"$skip","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":1}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":"test_select"}}},{"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,"schema":{"type":"string"},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":"test_orderby"}}},{"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,"schema":{"type":"boolean"},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":false}}},{"description":"The basic switch indicates what level of information to return when listing tables. When basic is true, only database_name, schema_name, table_name and version are returned for each table, otherwise all table metadata is returned. By default, it is false. Optional.","in":"query","name":"basic","required":false,"schema":{"type":"boolean","default":false},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"value":false}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of tables in the specified database and schema.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlTableList"},"examples":{"Retrieves the list of tables from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_list_of_tables_from_the_Data_Lake_Analytics_catalog"}}}}}},"tags":["Catalog"],"x-ms-odata":"#/components/schemas/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,"schema":{"type":"string"},"examples":{"Retrieves the specified table from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema containing the table.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified table from the Data Lake Analytics catalog":{"value":"dbo"}}},{"description":"The name of the table.","in":"path","name":"tableName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the specified table from the Data Lake Analytics catalog":{"value":"test_table_name"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified table from the underlying database and schema combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USqlTable"},"examples":{"Retrieves the specified table from the Data Lake Analytics catalog":{"$ref":"#/components/examples/Retrieves_the_specified_table_from_the_Data_Lake_Analytics_catalog"}}}}}},"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,"schema":{"type":"string"},"examples":{"Retrieves the list of table partitions from the Data Lake Analytics catalog":{"value":"master"}}},{"description":"The name of the schema containing the partitions.","in":"path","name":"schemaName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of table partitions from the Data Lake Analytics catalog":{"value":"dbo"}}},{"description":"The name of the table containing the partitions.","in":"path","name":"tableName","required":true,"schema":{"type":"string"},"examples":{"Retrieves the list of table partitions from the Data Lake Analytics catalog":{"value":"test_table_name"}}},{"description":"OData filter. Optional.","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"Retrieves the list of table partitions from the Data Lake Analytics catalog":{"value":"test_filter"}}},{"description":"The number of items to return. Optional.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32","minimum":1},"examples":{"Retrieves the list of table partitions