azure.mgmt.datalake.analytics.catalog.operations module

class azure.mgmt.datalake.analytics.catalog.operations.CatalogOperations(client, config, serializer, deserializer)[source]

Bases: object

CatalogOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2016-11-01”.

create_credential(account_name, database_name, credential_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Creates the specified credential for use with external data sources in the specified database.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – 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.
  • credential_name (str) – The name of the credential.
  • parameters (DataLakeAnalyticsCatalogCredentialCreateParameters) – The parameters required to create the credential (name and password)
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

CloudError

create_secret(account_name, database_name, secret_name, password, uri=None, custom_headers=None, raw=False, **operation_config)[source]

Creates the specified secret for use with external data sources in the specified database. This is deprecated and will be removed in the next release. Please use CreateCredential instead.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database in which to create the secret.
  • secret_name (str) – The name of the secret.
  • password (str) – the password for the secret to pass in
  • uri (str) – the URI identifier for the secret in the format <hostname>:<port>
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

CloudError

delete_all_secrets(account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes all secrets in the specified database. This is deprecated and will be removed in the next release. In the future, please only drop individual credentials using DeleteCredential.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the secret.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

CloudError

delete_credential(account_name, database_name, credential_name, cascade=False, password=None, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified credential in the specified database.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the credential.
  • credential_name (str) – The name of the credential to delete
  • cascade (bool) – 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.
  • password (str) – the current password for the credential and user with access to the data source. This is required if the requester is not the account owner.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

CloudError

delete_secret(account_name, database_name, secret_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use DeleteCredential instead.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the secret.
  • secret_name (str) – The name of the secret to delete
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

CloudError

get_assembly(account_name, database_name, assembly_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified assembly from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the assembly.
  • assembly_name (str) – The name of the assembly.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlAssembly or ClientRawResponse if raw=true

Return type:

USqlAssembly or ClientRawResponse

Raises:

CloudError

get_credential(account_name, database_name, credential_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified credential from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the schema.
  • credential_name (str) – The name of the credential.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlCredential or ClientRawResponse if raw=true

Return type:

USqlCredential or ClientRawResponse

Raises:

CloudError

get_database(account_name, database_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified database from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlDatabase or ClientRawResponse if raw=true

Return type:

USqlDatabase or ClientRawResponse

Raises:

CloudError

get_external_data_source(account_name, database_name, external_data_source_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified external data source from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the external data source.
  • external_data_source_name (str) – The name of the external data source.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlExternalDataSource or ClientRawResponse if raw=true

Return type:

USqlExternalDataSource or ClientRawResponse

Raises:

CloudError

get_package(account_name, database_name, schema_name, package_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified package from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the package.
  • schema_name (str) – The name of the schema containing the package.
  • package_name (str) – The name of the package.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlPackage or ClientRawResponse if raw=true

Return type:

USqlPackage or ClientRawResponse

Raises:

CloudError

get_procedure(account_name, database_name, schema_name, procedure_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified procedure from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the procedure.
  • schema_name (str) – The name of the schema containing the procedure.
  • procedure_name (str) – The name of the procedure.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlProcedure or ClientRawResponse if raw=true

Return type:

USqlProcedure or ClientRawResponse

Raises:

CloudError

get_schema(account_name, database_name, schema_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified schema from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the schema.
  • schema_name (str) – The name of the schema.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlSchema or ClientRawResponse if raw=true

Return type:

USqlSchema or ClientRawResponse

Raises:

CloudError

get_secret(account_name, database_name, secret_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use GetCredential instead.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the secret.
  • secret_name (str) – The name of the secret to get
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlSecret or ClientRawResponse if raw=true

Return type:

USqlSecret or ClientRawResponse

Raises:

CloudError

get_table(account_name, database_name, schema_name, table_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified table from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the table.
  • schema_name (str) – The name of the schema containing the table.
  • table_name (str) – The name of the table.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlTable or ClientRawResponse if raw=true

Return type:

USqlTable or ClientRawResponse

Raises:

CloudError

get_table_partition(account_name, database_name, schema_name, table_name, partition_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified table partition from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the partition.
  • schema_name (str) – The name of the schema containing the partition.
  • table_name (str) – The name of the table containing the partition.
  • partition_name (str) – The name of the table partition.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlTablePartition or ClientRawResponse if raw=true

Return type:

USqlTablePartition or ClientRawResponse

Raises:

CloudError

get_table_statistic(account_name, database_name, schema_name, table_name, statistics_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified table statistics from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the statistics.
  • schema_name (str) – The name of the schema containing the statistics.
  • table_name (str) – The name of the table containing the statistics.
  • statistics_name (str) – The name of the table statistics.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlTableStatistics or ClientRawResponse if raw=true

Return type:

USqlTableStatistics or ClientRawResponse

Raises:

CloudError

get_table_type(account_name, database_name, schema_name, table_type_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified table type from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the table type.
  • schema_name (str) – The name of the schema containing the table type.
  • table_type_name (str) – The name of the table type to retrieve.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlTableType or ClientRawResponse if raw=true

Return type:

USqlTableType or ClientRawResponse

Raises:

CloudError

get_table_valued_function(account_name, database_name, schema_name, table_valued_function_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified table valued function from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the table valued function.
  • schema_name (str) – The name of the schema containing the table valued function.
  • table_valued_function_name (str) – The name of the tableValuedFunction.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlTableValuedFunction or ClientRawResponse if raw=true

Return type:

USqlTableValuedFunction or ClientRawResponse

Raises:

CloudError

get_view(account_name, database_name, schema_name, view_name, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the specified view from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the view.
  • schema_name (str) – The name of the schema containing the view.
  • view_name (str) – The name of the view.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

USqlView or ClientRawResponse if raw=true

Return type:

USqlView or ClientRawResponse

Raises:

CloudError

list_assemblies(account_name, database_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of assemblies from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the assembly.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlAssemblyClr

Return type:

USqlAssemblyClrPaged

Raises:

CloudError

list_credentials(account_name, database_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of credentials from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the schema.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlCredential

Return type:

USqlCredentialPaged

Raises:

CloudError

list_databases(account_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of databases from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlDatabase

Return type:

USqlDatabasePaged

Raises:

CloudError

list_external_data_sources(account_name, database_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of external data sources from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the external data sources.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlExternalDataSource

Return type:

USqlExternalDataSourcePaged

Raises:

CloudError

list_packages(account_name, database_name, schema_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of packages from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the packages.
  • schema_name (str) – The name of the schema containing the packages.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlPackage

Return type:

USqlPackagePaged

Raises:

CloudError

list_procedures(account_name, database_name, schema_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of procedures from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the procedures.
  • schema_name (str) – The name of the schema containing the procedures.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlProcedure

Return type:

USqlProcedurePaged

Raises:

CloudError

list_schemas(account_name, database_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of schemas from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the schema.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlSchema

Return type:

USqlSchemaPaged

Raises:

CloudError

list_table_partitions(account_name, database_name, schema_name, table_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the partitions.
  • schema_name (str) – The name of the schema containing the partitions.
  • table_name (str) – The name of the table containing the partitions.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTablePartition

Return type:

USqlTablePartitionPaged

Raises:

CloudError

list_table_statistics(account_name, database_name, schema_name, table_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the statistics.
  • schema_name (str) – The name of the schema containing the statistics.
  • table_name (str) – The name of the table containing the statistics.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTableStatistics

Return type:

USqlTableStatisticsPaged

Raises:

CloudError

list_table_statistics_by_database(account_name, database_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of all statistics in a database from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the table statistics.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTableStatistics

Return type:

USqlTableStatisticsPaged

Raises:

CloudError

list_table_statistics_by_database_and_schema(account_name, database_name, schema_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the statistics.
  • schema_name (str) – The name of the schema containing the statistics.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTableStatistics

Return type:

USqlTableStatisticsPaged

Raises:

CloudError

list_table_types(account_name, database_name, schema_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the table types.
  • schema_name (str) – The name of the schema containing the table types.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTableType

Return type:

USqlTableTypePaged

Raises:

CloudError

list_table_valued_functions(account_name, database_name, schema_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of table valued functions from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the table valued functions.
  • schema_name (str) – The name of the schema containing the table valued functions.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTableValuedFunction

Return type:

USqlTableValuedFunctionPaged

Raises:

CloudError

list_table_valued_functions_by_database(account_name, database_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of all table valued functions in a database from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the table valued functions.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTableValuedFunction

Return type:

USqlTableValuedFunctionPaged

Raises:

CloudError

list_tables(account_name, database_name, schema_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, basic=False, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of tables from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the tables.
  • schema_name (str) – The name of the schema containing the tables.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • basic (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTable

Return type:

USqlTablePaged

Raises:

CloudError

list_tables_by_database(account_name, database_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, basic=False, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of all tables in a database from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the tables.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • basic (bool) – 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
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlTable

Return type:

USqlTablePaged

Raises:

CloudError

list_types(account_name, database_name, schema_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of types within the specified database and schema from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the types.
  • schema_name (str) – The name of the schema containing the types.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlType

Return type:

USqlTypePaged

Raises:

CloudError

list_views(account_name, database_name, schema_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of views from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the views.
  • schema_name (str) – The name of the schema containing the views.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlView

Return type:

USqlViewPaged

Raises:

CloudError

list_views_by_database(account_name, database_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)[source]

Retrieves the list of all views in a database from the Data Lake Analytics catalog.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the views.
  • filter (str) – OData filter. Optional.
  • top (int) – The number of items to return. Optional.
  • skip (int) – The number of items to skip over before returning elements. Optional.
  • select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • orderby (str) – 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.
  • count (bool) – 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.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of USqlView

Return type:

USqlViewPaged

Raises:

CloudError

update_credential(account_name, database_name, credential_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Modifies the specified credential for use with external data sources in the specified database.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the credential.
  • credential_name (str) – The name of the credential.
  • parameters (DataLakeAnalyticsCatalogCredentialUpdateParameters) – The parameters required to modify the credential (name and password)
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

CloudError

update_secret(account_name, database_name, secret_name, password, uri=None, custom_headers=None, raw=False, **operation_config)[source]

Modifies the specified secret for use with external data sources in the specified database. This is deprecated and will be removed in the next release. Please use UpdateCredential instead.

Parameters:
  • account_name (str) – The Azure Data Lake Analytics account upon which to execute catalog operations.
  • database_name (str) – The name of the database containing the secret.
  • secret_name (str) – The name of the secret.
  • password (str) – the password for the secret to pass in
  • uri (str) – the URI identifier for the secret in the format <hostname>:<port>
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

None or ClientRawResponse if raw=true

Return type:

None or ClientRawResponse

Raises:

CloudError