DatabaseColumnsOperations Class

DatabaseColumnsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

DatabaseColumnsOperations

Constructor

DatabaseColumnsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
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

Name	Description
models	Alias to model classes used in this operation group.

Methods

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

get

Get database column.

get(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) -> _models.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.
server_name Required	str The name of the server.
database_name Required	str The name of the database.
schema_name Required	str The name of the schema.
table_name Required	str The name of the table.
column_name Required	str The name of the column.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> Iterable['_models.DatabaseColumnListResult']

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.
server_name Required	str The name of the server.
database_name Required	str The name of the database.
schema	list[str] Default value: None
table	list[str] Default value: None
column	list[str] Default value: None
order_by	list[str] Default value: None
skiptoken	str An opaque token that identifies a starting point in the collection. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[DatabaseColumnListResult]	An iterator like instance of either DatabaseColumnListResult 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) -> Iterable['_models.DatabaseColumnListResult']

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.
server_name Required	str The name of the server.
database_name Required	str The name of the database.
schema_name Required	str The name of the schema.
table_name Required	str The name of the table.
filter	str An OData filter expression that filters elements in the collection. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>