DatabaseColumnsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:database_columns> attribute.

Constructor

DatabaseColumnsOperations(*args, **kwargs)

Methods

get	Get database column.
list_by_database	List database columns.
list_by_table	List database columns.

get

Get database column.

async get(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) -> DatabaseColumn

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
schema_name Required	str The name of the schema. Required.
table_name Required	str The name of the table. Required.
column_name Required	str The name of the column. Required.

Returns

Type	Description
DatabaseColumn	DatabaseColumn or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_database

List database columns.

list_by_database(resource_group_name: str, server_name: str, database_name: str, schema: list[str] | None = None, table: list[str] | None = None, column: list[str] | None = None, order_by: list[str] | None = None, skiptoken: str | None = None, **kwargs: Any) -> AsyncItemPaged[DatabaseColumn]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
schema	list[str] Default value is None. Default value: None
table	list[str] Default value is None. Default value: None
column	list[str] Default value is None. Default value: None
order_by	list[str] Default value is None. Default value: None
skiptoken	str An opaque token that identifies a starting point in the collection. Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[DatabaseColumn]	An iterator like instance of either DatabaseColumn or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_table

List database columns.

list_by_table(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, filter: str | None = None, **kwargs: Any) -> AsyncItemPaged[DatabaseColumn]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
schema_name Required	str The name of the schema. Required.
table_name Required	str The name of the table. Required.
filter	str An OData filter expression that filters elements in the collection. Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[DatabaseColumn]	An iterator like instance of either DatabaseColumn or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>