CatalogOperations Class

CatalogOperations operations.

Inheritance

builtins.object

CatalogOperations

Constructor

CatalogOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

api_version

Client Api Version. Constant value: "2016-11-01".

Methods

create_credential	Creates the specified credential for use with external data sources in the specified database.
create_secret	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.
delete_all_secrets	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.
delete_credential	Deletes the specified credential in the specified database.
delete_secret	Deletes the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use DeleteCredential instead.
get_assembly	Retrieves the specified assembly from the Data Lake Analytics catalog.
get_credential	Retrieves the specified credential from the Data Lake Analytics catalog.
get_database	Retrieves the specified database from the Data Lake Analytics catalog.
get_external_data_source	Retrieves the specified external data source from the Data Lake Analytics catalog.
get_package	Retrieves the specified package from the Data Lake Analytics catalog.
get_procedure	Retrieves the specified procedure from the Data Lake Analytics catalog.
get_schema	Retrieves the specified schema from the Data Lake Analytics catalog.
get_secret	Gets the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use GetCredential instead.
get_table	Retrieves the specified table from the Data Lake Analytics catalog.
get_table_partition	Retrieves the specified table partition from the Data Lake Analytics catalog.
get_table_statistic	Retrieves the specified table statistics from the Data Lake Analytics catalog.
get_table_type	Retrieves the specified table type from the Data Lake Analytics catalog.
get_table_valued_function	Retrieves the specified table valued function from the Data Lake Analytics catalog.
get_view	Retrieves the specified view from the Data Lake Analytics catalog.
grant_acl	Grants an access control list (ACL) entry to the Data Lake Analytics catalog.
grant_acl_to_database	Grants an access control list (ACL) entry to the database from the Data Lake Analytics catalog.
list_acls	Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog.
list_acls_by_database	Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog.
list_assemblies	Retrieves the list of assemblies from the Data Lake Analytics catalog.
list_credentials	Retrieves the list of credentials from the Data Lake Analytics catalog.
list_databases	Retrieves the list of databases from the Data Lake Analytics catalog.
list_external_data_sources	Retrieves the list of external data sources from the Data Lake Analytics catalog.
list_packages	Retrieves the list of packages from the Data Lake Analytics catalog.
list_procedures	Retrieves the list of procedures from the Data Lake Analytics catalog.
list_schemas	Retrieves the list of schemas from the Data Lake Analytics catalog.
list_table_fragments	Retrieves the list of table fragments from the Data Lake Analytics catalog.
list_table_partitions	Retrieves the list of table partitions from the Data Lake Analytics catalog.
list_table_statistics	Retrieves the list of table statistics from the Data Lake Analytics catalog.
list_table_statistics_by_database	Retrieves the list of all statistics in a database from the Data Lake Analytics catalog.
list_table_statistics_by_database_and_schema	Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog.
list_table_types	Retrieves the list of table types from the Data Lake Analytics catalog.
list_table_valued_functions	Retrieves the list of table valued functions from the Data Lake Analytics catalog.
list_table_valued_functions_by_database	Retrieves the list of all table valued functions in a database from the Data Lake Analytics catalog.
list_tables	Retrieves the list of tables from the Data Lake Analytics catalog.
list_tables_by_database	Retrieves the list of all tables in a database from the Data Lake Analytics catalog.
list_types	Retrieves the list of types within the specified database and schema from the Data Lake Analytics catalog.
list_views	Retrieves the list of views from the Data Lake Analytics catalog.
list_views_by_database	Retrieves the list of all views in a database from the Data Lake Analytics catalog.
preview_table	Retrieves a preview set of rows in given table.
preview_table_partition	Retrieves a preview set of rows in given partition.
revoke_acl	Revokes an access control list (ACL) entry from the Data Lake Analytics catalog.
revoke_acl_from_database	Revokes an access control list (ACL) entry for the database from the Data Lake Analytics catalog.
update_credential	Modifies the specified credential for use with external data sources in the specified database.
update_secret	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.

create_credential

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

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

Required

The name of the credential.

parameters

DataLakeAnalyticsCatalogCredentialCreateParameters

Required

The parameters required to create the credential (name and password)

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

create_secret

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.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database in which to create the secret.

secret_name

str

Required

The name of the secret.

password

str

Required

the password for the secret to pass in

uri

str

default value: None

the URI identifier for the secret in the format :

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

delete_all_secrets

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.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the secret.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

delete_credential

Deletes the specified credential in the specified database.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the credential.

credential_name

str

Required

The name of the credential to delete

cascade

bool

default value: False

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

delete_secret

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the secret.

secret_name

str

Required

The name of the secret to delete

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

get_assembly

Retrieves the specified assembly from the Data Lake Analytics catalog.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the assembly.

assembly_name

str

Required

The name of the assembly.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlAssembly or ClientRawResponse if raw=true

Return type

USqlAssembly,

ClientRawResponse

Exceptions

CloudError

get_credential

Retrieves the specified credential from the Data Lake Analytics catalog.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the schema.

credential_name

str

Required

The name of the credential.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlCredential or ClientRawResponse if raw=true

Return type

USqlCredential,

ClientRawResponse

Exceptions

CloudError

get_database

Retrieves the specified database from the Data Lake Analytics catalog.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlDatabase or ClientRawResponse if raw=true

Return type

USqlDatabase,

ClientRawResponse

Exceptions

CloudError

get_external_data_source

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the external data source.

external_data_source_name

str

Required

The name of the external data source.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlExternalDataSource or ClientRawResponse if raw=true

Return type

USqlExternalDataSource,

ClientRawResponse

Exceptions

CloudError

get_package

Retrieves the specified package from the Data Lake Analytics catalog.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the package.

schema_name

str

Required

The name of the schema containing the package.

package_name

str

Required

The name of the package.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlPackage or ClientRawResponse if raw=true

Return type

USqlPackage,

ClientRawResponse

Exceptions

CloudError

get_procedure

Retrieves the specified procedure from the Data Lake Analytics catalog.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the procedure.

schema_name

str

Required

The name of the schema containing the procedure.

procedure_name

str

Required

The name of the procedure.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlProcedure or ClientRawResponse if raw=true

Return type

USqlProcedure,

ClientRawResponse

Exceptions

CloudError

get_schema

Retrieves the specified schema from the Data Lake Analytics catalog.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the schema.

schema_name

str

Required

The name of the schema.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlSchema or ClientRawResponse if raw=true

Return type

USqlSchema,

ClientRawResponse

Exceptions

CloudError

get_secret

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the secret.

secret_name

str

Required

The name of the secret to get

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlSecret or ClientRawResponse if raw=true

Return type

USqlSecret,

ClientRawResponse

Exceptions

CloudError

get_table

Retrieves the specified table from the Data Lake Analytics catalog.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table.

schema_name

str

Required

The name of the schema containing the table.

table_name

str

Required

The name of the table.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlTable or ClientRawResponse if raw=true

Return type

USqlTable,

ClientRawResponse

Exceptions

CloudError

get_table_partition

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the partition.

schema_name

str

Required

The name of the schema containing the partition.

table_name

str

Required

The name of the table containing the partition.

partition_name

str

Required

The name of the table partition.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlTablePartition or ClientRawResponse if raw=true

Return type

USqlTablePartition,

ClientRawResponse

Exceptions

CloudError

get_table_statistic

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the statistics.

schema_name

str

Required

The name of the schema containing the statistics.

table_name

str

Required

The name of the table containing the statistics.

statistics_name

str

Required

The name of the table statistics.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlTableStatistics or ClientRawResponse if raw=true

Return type

USqlTableStatistics,

ClientRawResponse

Exceptions

CloudError

get_table_type

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table type.

schema_name

str

Required

The name of the schema containing the table type.

table_type_name

str

Required

The name of the table type to retrieve.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlTableType or ClientRawResponse if raw=true

Return type

USqlTableType,

ClientRawResponse

Exceptions

CloudError

get_table_valued_function

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table valued function.

schema_name

str

Required

The name of the schema containing the table valued function.

table_valued_function_name

str

Required

The name of the tableValuedFunction.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlTableValuedFunction or ClientRawResponse if raw=true

Return type

USqlTableValuedFunction,

ClientRawResponse

Exceptions

CloudError

get_view

Retrieves the specified view from the Data Lake Analytics catalog.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the view.

schema_name

str

Required

The name of the schema containing the view.

view_name

str

Required

The name of the view.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlView or ClientRawResponse if raw=true

Return type

USqlView,

ClientRawResponse

Exceptions

CloudError

grant_acl

Grants an access control list (ACL) entry to the Data Lake Analytics catalog.

grant_acl(account_name, parameters, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

parameters

AclCreateOrUpdateParameters

Required

Parameters supplied to create or update an access control list (ACL) entry for a Data Lake Analytics catalog.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

grant_acl_to_database

Grants an access control list (ACL) entry to the database from the Data Lake Analytics catalog.

grant_acl_to_database(account_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database.

parameters

AclCreateOrUpdateParameters

Required

Parameters supplied to create or update an access control list (ACL) entry for a database.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

list_acls

Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog.

list_acls(account_name, filter=None, top=None, skip=None, select=None, orderby=None, count=None, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of Acl

Return type

AclPaged[Acl]

Exceptions

CloudError

list_acls_by_database

Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog.

list_acls_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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of Acl

Return type

AclPaged[Acl]

Exceptions

CloudError

list_assemblies

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the assembly.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlAssemblyClr

Return type

USqlAssemblyClrPaged[USqlAssemblyClr]

Exceptions

CloudError

list_credentials

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the schema.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlCredential

Return type

USqlCredentialPaged[USqlCredential]

Exceptions

CloudError

list_databases

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlDatabase

Return type

USqlDatabasePaged[USqlDatabase]

Exceptions

CloudError

list_external_data_sources

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the external data sources.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlExternalDataSource

Return type

USqlExternalDataSourcePaged[USqlExternalDataSource]

Exceptions

CloudError

list_packages

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the packages.

schema_name

str

Required

The name of the schema containing the packages.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlPackage

Return type

USqlPackagePaged[USqlPackage]

Exceptions

CloudError

list_procedures

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the procedures.

schema_name

str

Required

The name of the schema containing the procedures.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlProcedure

Return type

USqlProcedurePaged[USqlProcedure]

Exceptions

CloudError

list_schemas

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the schema.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlSchema

Return type

USqlSchemaPaged[USqlSchema]

Exceptions

CloudError

list_table_fragments

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

list_table_fragments(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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table fragments.

schema_name

str

Required

The name of the schema containing the table fragments.

table_name

str

Required

The name of the table containing the table fragments.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTableFragment

Return type

USqlTableFragmentPaged[USqlTableFragment]

Exceptions

CloudError

list_table_partitions

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the partitions.

schema_name

str

Required

The name of the schema containing the partitions.

table_name

str

Required

The name of the table containing the partitions.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTablePartition

Return type

USqlTablePartitionPaged[USqlTablePartition]

Exceptions

CloudError

list_table_statistics

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the statistics.

schema_name

str

Required

The name of the schema containing the statistics.

table_name

str

Required

The name of the table containing the statistics.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTableStatistics

Return type

USqlTableStatisticsPaged[USqlTableStatistics]

Exceptions

CloudError

list_table_statistics_by_database

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table statistics.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTableStatistics

Return type

USqlTableStatisticsPaged[USqlTableStatistics]

Exceptions

CloudError

list_table_statistics_by_database_and_schema

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the statistics.

schema_name

str

Required

The name of the schema containing the statistics.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTableStatistics

Return type

USqlTableStatisticsPaged[USqlTableStatistics]

Exceptions

CloudError

list_table_types

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table types.

schema_name

str

Required

The name of the schema containing the table types.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTableType

Return type

USqlTableTypePaged[USqlTableType]

Exceptions

CloudError

list_table_valued_functions

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table valued functions.

schema_name

str

Required

The name of the schema containing the table valued functions.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTableValuedFunction

Return type

USqlTableValuedFunctionPaged[USqlTableValuedFunction]

Exceptions

CloudError

list_table_valued_functions_by_database

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table valued functions.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTableValuedFunction

Return type

USqlTableValuedFunctionPaged[USqlTableValuedFunction]

Exceptions

CloudError

list_tables

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the tables.

schema_name

str

Required

The name of the schema containing the tables.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: False

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTable

Return type

USqlTablePaged[USqlTable]

Exceptions

CloudError

list_tables_by_database

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the tables.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: False

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlTable

Return type

USqlTablePaged[USqlTable]

Exceptions

CloudError

list_types

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the types.

schema_name

str

Required

The name of the schema containing the types.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlType

Return type

USqlTypePaged[USqlType]

Exceptions

CloudError

list_views

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the views.

schema_name

str

Required

The name of the schema containing the views.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlView

Return type

USqlViewPaged[USqlView]

Exceptions

CloudError

list_views_by_database

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

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)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the views.

filter

str

default value: None

OData filter. Optional.

top

int

default value: None

The number of items to return. Optional.

skip

int

default value: None

The number of items to skip over before returning elements. Optional.

select

str

default value: None

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

orderby

str

default value: None

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

default value: None

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

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of USqlView

Return type

USqlViewPaged[USqlView]

Exceptions

CloudError

preview_table

Retrieves a preview set of rows in given table.

preview_table(account_name, database_name, schema_name, table_name, max_rows=None, max_columns=None, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the table.

schema_name

str

Required

The name of the schema containing the table.

table_name

str

Required

The name of the table.

max_rows

<xref:long>

default value: None

The maximum number of preview rows to be retrieved. Rows returned may be less than or equal to this number depending on row sizes and number of rows in the table.

max_columns

<xref:long>

default value: None

The maximum number of columns to be retrieved.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlTablePreview or ClientRawResponse if raw=true

Return type

USqlTablePreview,

ClientRawResponse

Exceptions

CloudError

preview_table_partition

Retrieves a preview set of rows in given partition.

preview_table_partition(account_name, database_name, schema_name, table_name, partition_name, max_rows=None, max_columns=None, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the partition.

schema_name

str

Required

The name of the schema containing the partition.

table_name

str

Required

The name of the table containing the partition.

partition_name

str

Required

The name of the table partition.

max_rows

<xref:long>

default value: None

The maximum number of preview rows to be retrieved.Rows returned may be less than or equal to this number depending on row sizes and number of rows in the partition.

max_columns

<xref:long>

default value: None

The maximum number of columns to be retrieved.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

USqlTablePreview or ClientRawResponse if raw=true

Return type

USqlTablePreview,

ClientRawResponse

Exceptions

CloudError

revoke_acl

Revokes an access control list (ACL) entry from the Data Lake Analytics catalog.

revoke_acl(account_name, ace_type, principal_id, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

ace_type

str or AclType

Required

the access control list (ACL) entry type. UserObj and GroupObj denote the owning user and group, respectively. Possible values include: 'UserObj', 'GroupObj', 'Other', 'User', 'Group'

principal_id

str

Required

the Azure AD object ID of the user or group being specified in the access control list (ACL) entry.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

revoke_acl_from_database

Revokes an access control list (ACL) entry for the database from the Data Lake Analytics catalog.

revoke_acl_from_database(account_name, database_name, ace_type, principal_id, custom_headers=None, raw=False, **operation_config)

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database.

ace_type

str or AclType

Required

the access control list (ACL) entry type. UserObj and GroupObj denote the owning user and group, respectively. Possible values include: 'UserObj', 'GroupObj', 'Other', 'User', 'Group'

principal_id

str

Required

the Azure AD object ID of the user or group being specified in the access control list (ACL) entry.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

update_credential

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

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the credential.

credential_name

str

Required

The name of the credential.

parameters

DataLakeAnalyticsCatalogCredentialUpdateParameters

Required

The parameters required to modify the credential (name and password)

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

update_secret

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.

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

Parameters

account_name

str

Required

The Azure Data Lake Analytics account upon which to execute catalog operations.

database_name

str

Required

The name of the database containing the secret.

secret_name

str

Required

The name of the secret.

password

str

Required

the password for the secret to pass in

uri

str

default value: None

the URI identifier for the secret in the format :

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

Attributes

models

models = <module 'azure.mgmt.datalake.analytics.catalog.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datalake\\analytics\\catalog\\models\\__init__.py'>