SqlClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'GetOnNewItems_V2': {'operation_id': 'GetOnNewItems_V2', 'path': '/{connectionId}/v2/datasets/{server},{database}/tables/{table}/onnewitems', 'method': 'get', 'required_parameters': ['server', 'database', 'table'], 'callback_payload_type': 'SqlItemsList'}, 'GetOnUpdatedItems_V2': {'operation_id': 'GetOnUpdatedItems_V2', 'path': '/{connectionId}/datasets/{server},{database}/tables/{table}/onupdateditems', 'method': 'get', 'required_parameters': ['server', 'database', 'table'], 'callback_payload_type': 'SqlItemsList'}}

Classes

ExecutePassThroughNativeQueryResponse dataclass

ExecutePassThroughNativeQueryResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Execute a SQL query

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ExecuteProcedureInput dataclass

ExecuteProcedureInput(*, additional_properties: Dict[str, Any] = dict())

Execute stored procedure

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ExecuteProcedureResponse dataclass

ExecuteProcedureResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Execute stored procedure

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetItemResponse dataclass

GetItemResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Get row

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetItemsResponse dataclass

GetItemsResponse(*, metadata: Optional[List[DataWithSensitivityLabelInfo | Mapping[str, Any]]] = None, value: Optional[List[SqlItem | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Get rows

Attributes

metadata class-attribute instance-attribute

metadata: Optional[List[DataWithSensitivityLabelInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@metadata'})

List of Sensitivity Labels

value class-attribute instance-attribute

value: Optional[List[SqlItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Columns

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

SqlItemsList dataclass

SqlItemsList(*, value: Optional[List[SqlItem | Mapping[str, Any]]] = None)

Response for When an item is created

Attributes

value class-attribute instance-attribute

value: Optional[List[SqlItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Items

GetTablesResponse dataclass

GetTablesResponse(*, metadata: Optional[List[DataWithSensitivityLabelInfo | Mapping[str, Any]]] = None, value: Optional[List[Table | Mapping[str, Any]]] = None)

Response for Get tables

Attributes

metadata class-attribute instance-attribute

metadata: Optional[List[DataWithSensitivityLabelInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@metadata'})

List of Sensitivity Labels

value class-attribute instance-attribute

value: Optional[List[Table | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Tables

PatchItemInput dataclass

PatchItemInput(*, additional_properties: Dict[str, Any] = dict())

Update row

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PatchItemResponse dataclass

PatchItemResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Update row

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PostItemInput dataclass

PostItemInput(*, additional_properties: Dict[str, Any] = dict())

Insert row

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PostItemResponse dataclass

PostItemResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Insert row

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ODataServersList dataclass

ODataServersList(*, value: Optional[List[Server | Mapping[str, Any]]] = None)

Response for List the servers

Attributes

value class-attribute instance-attribute

value: Optional[List[Server | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of datasets

DatabasesList dataclass

DatabasesList(*, value: Optional[List[Database | Mapping[str, Any]]] = None)

Response for List the databases

Attributes

value class-attribute instance-attribute

value: Optional[List[Database | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of datasets

TablesList dataclass

TablesList(*, value: Optional[List[Table | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for GetTablesForDeleteItem

Attributes

value class-attribute instance-attribute

value: Optional[List[Table | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Tables

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

PassThroughNativeQueryMetadata dataclass

PassThroughNativeQueryMetadata(*, name: Optional[str] = None, title: Optional[str] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get pass-through native SQL query metadata

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Query name

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Query title

ProceduresList dataclass

ProceduresList(*, value: Optional[List[Procedure | Mapping[str, Any]]] = None)

Response for Get stored procedures

Attributes

value class-attribute instance-attribute

value: Optional[List[Procedure | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Procedures

ProcedureMetadata dataclass

ProcedureMetadata(*, name: Optional[str] = None, title: Optional[str] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get metadata of a Procedure

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Procedure name

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Procedure title

TableMetadata dataclass

TableMetadata(*, name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None, referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = None, web_url: Optional[str] = None)

Response for Get metadata of a table

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Table name

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Table title

x_ms_permission class-attribute instance-attribute

x_ms_permission: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'x-ms-permission'})

Table permission

web_url class-attribute instance-attribute

web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'webUrl'})

Url link

BlobDataSetsMetadata dataclass

BlobDataSetsMetadata(*, source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = dataclass_field(default=None, kw_only=True)

Blob dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Blob dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'urlEncoding'})

Blob dataset url encoding

Database dataclass

Database(*, name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None, tables: Optional[List[Table | Mapping[str, Any]]] = None)

Definition: Database

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the database. The name is used at runtime.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name of the database.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DynamicProperties'})

Additional database properties provided by the connector to the clients.

tables class-attribute instance-attribute

tables: Optional[List[Table | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Database items

DataSet dataclass

DataSet(*, name: Optional[str] = None, display_name: Optional[str] = None, query: Optional[List[PassThroughNativeQuery | Mapping[str, Any]]] = None)

Definition: DataSet

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Dataset name

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

Dataset display name

query class-attribute instance-attribute

query: Optional[List[PassThroughNativeQuery | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Pass-through Native Queries

DataSetParameter dataclass

DataSetParameter(*, name: Optional[str] = None, type_: Optional[str] = None, url_encoding: Optional[str] = None, description: Optional[str] = None, required: Optional[bool] = None, x_ms_summary: Optional[str] = None, x_ms_dynamic_values: Optional[DynamicValues | Mapping[str, Any]] = None, x_ms_dynamic_tree: Optional[DynamicTree | Mapping[str, Any]] = None)

Definition: DataSetParameter

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Type

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'urlEncoding'})

Parameter url encoding

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description

required class-attribute instance-attribute

required: Optional[bool] = dataclass_field(default=None, kw_only=True)

Is parameter required

x_ms_summary class-attribute instance-attribute

x_ms_summary: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'x-ms-summary'})

Summary

DataSetsList dataclass

DataSetsList(*, value: Optional[List[DataSet | Mapping[str, Any]]] = None)

Definition: DataSetsList

Attributes

value class-attribute instance-attribute

value: Optional[List[DataSet | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of datasets

DataSetsMetadata dataclass

DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = None, dataset_format: Optional[str] = None, parameters: Optional[List[DataSetParameter | Mapping[str, Any]]] = None, no_natural_key_column_connector: Optional[NoNaturalKeyColumnConnectorMetadata | Mapping[str, Any]] = None)

Definition: DataSetsMetadata

Attributes

dataset_format class-attribute instance-attribute

dataset_format: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'datasetFormat'})

Dataset Format

parameters class-attribute instance-attribute

parameters: Optional[List[DataSetParameter | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Parameters

DataWithSensitivityLabelInfo dataclass

DataWithSensitivityLabelInfo(*, name: Optional[str] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata | Mapping[str, Any]]] = None)

Definition: DataWithSensitivityLabelInfo

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name

sensitivity_label_info class-attribute instance-attribute

sensitivity_label_info: Optional[List[SensitivityLabelMetadata | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sensitivityLabelInfo'})

List of Sensitivity Label Information

DynamicTree dataclass

DynamicTree(*, settings: Optional[DynamicTreeSettings | Mapping[str, Any]] = None, open: Optional[DynamicTreeOpenBrowse | Mapping[str, Any]] = None, browse: Optional[DynamicTreeOpenBrowse | Mapping[str, Any]] = None)

Definition: DynamicTree

DynamicTreeOpenBrowse dataclass

DynamicTreeOpenBrowse(*, path: Optional[str] = None, item_value_path: Optional[str] = None, item_title_path: Optional[str] = None, item_full_title_path: Optional[str] = None, item_is_parent: Optional[str] = None, selectable_filter: Optional[str] = None)

Definition: DynamicTreeOpenBrowse

Attributes

path class-attribute instance-attribute

path: Optional[str] = dataclass_field(default=None, kw_only=True)

Path

item_value_path class-attribute instance-attribute

item_value_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'itemValuePath'})

Item value path

item_title_path class-attribute instance-attribute

item_title_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'itemTitlePath'})

Item title path

item_full_title_path class-attribute instance-attribute

item_full_title_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'itemFullTitlePath'})

Item full title path

item_is_parent class-attribute instance-attribute

item_is_parent: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'itemIsParent'})

Is item parent

selectable_filter class-attribute instance-attribute

selectable_filter: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'selectableFilter'})

Selectable filter

DynamicTreeSettings dataclass

DynamicTreeSettings(*, can_select_parent_nodes: Optional[bool] = None, can_select_leaf_nodes: Optional[bool] = None, selected_item_placeholder: Optional[str] = None)

Definition: DynamicTreeSettings

Attributes

can_select_parent_nodes class-attribute instance-attribute

can_select_parent_nodes: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'canSelectParentNodes'})

Can select parent nodes

can_select_leaf_nodes class-attribute instance-attribute

can_select_leaf_nodes: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'canSelectLeafNodes'})

Can select leaf nodes

selected_item_placeholder class-attribute instance-attribute

selected_item_placeholder: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'selectedItemPlaceholder'})

Selected item placeholder in the path

DynamicValues dataclass

DynamicValues(*, path: Optional[str] = None, value_collection: Optional[str] = None, value_path: Optional[str] = None, value_title: Optional[str] = None)

Definition: DynamicValues

Attributes

path class-attribute instance-attribute

path: Optional[str] = dataclass_field(default=None, kw_only=True)

Path

value_collection class-attribute instance-attribute

value_collection: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'value-collection'})

Value collection

value_path class-attribute instance-attribute

value_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'value-path'})

Value path

value_title class-attribute instance-attribute

value_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'value-title'})

Value title

Item dataclass

Item(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Definition: Item

ItemsList dataclass

ItemsList(*, value: Optional[List[Item | Mapping[str, Any]]] = None)

Definition: ItemsList

Attributes

value class-attribute instance-attribute

value: Optional[List[Item | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Items

NoNaturalKeyColumnConnectorMetadata dataclass

NoNaturalKeyColumnConnectorMetadata(*, create_key_column_path: Optional[str] = None, create_key_column_method: Optional[str] = None, key_column_name_url_encoding: Optional[str] = None)

Definition: NoNaturalKeyColumnConnectorMetadata

Attributes

create_key_column_path class-attribute instance-attribute

create_key_column_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createKeyColumnPath'})

Path to create key column

create_key_column_method class-attribute instance-attribute

create_key_column_method: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createKeyColumnMethod'})

Method to create key column

key_column_name_url_encoding class-attribute instance-attribute

key_column_name_url_encoding: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'keyColumnNameUrlEncoding'})

Key column name url encoding

ObjectEntity dataclass

ObjectEntity(*, additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PassThroughNativeQuery dataclass

PassThroughNativeQuery(*, language: Optional[str] = None)

Definition: PassThroughNativeQuery

Attributes

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Language'})

Query language

PassThroughNativeQueryBody dataclass

PassThroughNativeQueryBody(*, query: Optional[str] = None, formal_parameters: Optional[Dict[str, str]] = None, actual_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Definition: PassThroughNativeQueryBody

Attributes

query class-attribute instance-attribute

query: Optional[str] = dataclass_field(default=None, kw_only=True)

Query Text

formal_parameters class-attribute instance-attribute

formal_parameters: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'formalParameters'})

Formal Parameters

actual_parameters class-attribute instance-attribute

actual_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualParameters'})

Actual parameters

PassThroughNativeQueryResult dataclass

PassThroughNativeQueryResult(*, output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None, result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]]] = None)

Definition: PassThroughNativeQueryResult

Attributes

output_parameters class-attribute instance-attribute

output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OutputParameters'})

Output parameter values

result_sets class-attribute instance-attribute

result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultSets'})

Collection of all result sets

Procedure dataclass

Procedure(*, name: Optional[str] = None, display_name: Optional[str] = None)

Definition: Procedure

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Procedure name

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

Procedure display name

ProcedureResult dataclass

ProcedureResult(*, output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None, return_code: Optional[int] = None, result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]]] = None)

Definition: ProcedureResult

Attributes

output_parameters class-attribute instance-attribute

output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OutputParameters'})

Output parameter values. The schema is dynamic based on the procedure.

return_code class-attribute instance-attribute

return_code: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReturnCode'})

Return code of a procedure.

result_sets class-attribute instance-attribute

result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultSets'})

Result sets returned by a procedure. The schema is dynamic based on the procedure.

SensitivityLabelMetadata dataclass

SensitivityLabelMetadata(*, sensitivity_label_id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, tooltip: Optional[str] = None, priority: Optional[int] = None, color: Optional[str] = None, is_encrypted: Optional[bool] = None, is_enabled: Optional[bool] = None, is_parent: Optional[bool] = None, parent_sensitivity_label_id: Optional[str] = None)

Definition: SensitivityLabelMetadata

Attributes

sensitivity_label_id class-attribute instance-attribute

sensitivity_label_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel name.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

SensitivityLabel displayName info

tooltip class-attribute instance-attribute

tooltip: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute

priority: Optional[int] = dataclass_field(default=None, kw_only=True)

SensitivityLabel priority.

color class-attribute instance-attribute

color: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel color.

is_encrypted class-attribute instance-attribute

is_encrypted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEncrypted'})

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute

is_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEnabled'})

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute

is_parent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isParent'})

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute

parent_sensitivity_label_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentSensitivityLabelId'})

Parent SensitivityLabel Id.

Server dataclass

Server(*, name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None, databases: Optional[List[Database | Mapping[str, Any]]] = None)

Definition: Server

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the server. The name is used at runtime.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name of the server.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DynamicProperties'})

Additional server properties provided by the connector to the clients.

databases class-attribute instance-attribute

databases: Optional[List[Database | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Table items

SqlItem dataclass

SqlItem(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Definition: SqlItem

SqlPassThroughNativeQueryBody dataclass

SqlPassThroughNativeQueryBody(*, actual_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None, query: Optional[str] = None, formal_parameters: Optional[Dict[str, str]] = None)

Definition: SqlPassThroughNativeQueryBody

Attributes

actual_parameters class-attribute instance-attribute

actual_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualParameters'})

Actual parameters

query class-attribute instance-attribute

query: Optional[str] = dataclass_field(default=None, kw_only=True)

Query Text

formal_parameters class-attribute instance-attribute

formal_parameters: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'formalParameters'})

Formal Parameters

SqlPassThroughNativeQueryResult dataclass

SqlPassThroughNativeQueryResult(*, output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None, result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]]] = None)

Definition: SqlPassThroughNativeQueryResult

Attributes

output_parameters class-attribute instance-attribute

output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OutputParameters'})

Output parameter values

result_sets class-attribute instance-attribute

result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultSets'})

Collection of all result sets

Table dataclass

Table(*, name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Definition: Table

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the table. The name is used at runtime.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(*, sort_restrictions: Optional[TableSortRestrictionsMetadata | Mapping[str, Any]] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata | Mapping[str, Any]] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata | Mapping[str, Any]] = None, count_restrictions: Optional[TableCountRestrictionsMetadata | Mapping[str, Any]] = None, is_only_server_pagable: Optional[bool] = None, filter_function_support: Optional[List[str]] = None, server_paging_options: Optional[List[str]] = None)

Definition: TableCapabilitiesMetadata

Attributes

is_only_server_pagable class-attribute instance-attribute

is_only_server_pagable: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute

filter_function_support: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'filterFunctionSupport'})

List of supported filter capabilities

server_paging_options class-attribute instance-attribute

server_paging_options: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'serverPagingOptions'})

List of supported server-driven paging capabilities

TableFilterRestrictionsMetadata dataclass

TableFilterRestrictionsMetadata(*, filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)

Definition: TableFilterRestrictionsMetadata

Attributes

filterable class-attribute instance-attribute

filterable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

non_filterable_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute

required_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'requiredProperties'})

List of required properties

TableSelectRestrictionsMetadata dataclass

TableSelectRestrictionsMetadata(*, selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute

selectable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has selectable columns

TableCountRestrictionsMetadata dataclass

TableCountRestrictionsMetadata(*, countable: Optional[bool] = None)

Definition: TableCountRestrictionsMetadata

Attributes

countable class-attribute instance-attribute

countable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has countable columns

TableSortRestrictionsMetadata dataclass

TableSortRestrictionsMetadata(*, sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute

sortable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

unsortable_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

ascending_only_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ascendingOnlyProperties'})

List of properties which support ascending order only

TabularDataSetsMetadata dataclass

TabularDataSetsMetadata(*, source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = dataclass_field(default=None, kw_only=True)

Dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'urlEncoding'})

Dataset url encoding

table_display_name class-attribute instance-attribute

table_display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tableDisplayName'})

Table display name

table_plural_name class-attribute instance-attribute

table_plural_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tablePluralName'})

Table plural display name

PassThroughPQBody dataclass

PassThroughPQBody(*, query: Optional[str] = None)

Definition: PassThroughPQBody

Attributes

query class-attribute instance-attribute

query: Optional[str] = dataclass_field(default=None, kw_only=True)

Query Text

PQMetadata dataclass

PQMetadata(*, value: Optional[PQMetadataValue | Mapping[str, Any]] = None, result_type: Optional[str] = None)

Definition: PQMetadata

Attributes

result_type class-attribute instance-attribute

result_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resultType'})

Result Type

PQMetadataValue dataclass

PQMetadataValue(*, name: Optional[str] = None, title: Optional[str] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: PQMetadataValue

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Query name

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Query title

PassThroughPQResult dataclass

PassThroughPQResult(*, value: Optional[PQRows | Mapping[str, Any]] = None)

Definition: PassThroughPQResult

PQRows dataclass

PQRows(*, additional_properties: Dict[str, Any] = dict())

Definition: PQRows

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SqlClient

SqlClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for sql connector.

Initialize a SqlClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

delete_item async

delete_item(server: str, database: str, table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete row

This operation deletes a row from a table.

Swagger operation ID: DeleteItem_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
table	str	Name of table.	required
id	str	Unique identifier of the row to delete.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

execute_pass_through_native_query async

execute_pass_through_native_query(input: SqlPassThroughNativeQueryBody | Mapping[str, Any], server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Execute a SQL query

Execute a SQL query

Swagger operation ID: ExecutePassThroughNativeQuery_V2.

Parameters:

Name	Type	Description	Default
input	SqlPassThroughNativeQueryBody | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

execute_procedure async

execute_procedure(input: ExecuteProcedureInput | Mapping[str, Any], server: str, database: str, procedure: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Execute stored procedure

This operation runs a stored procedure.

Swagger operation ID: ExecuteProcedure_V2.

Parameters:

Name	Type	Description	Default
input	ExecuteProcedureInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
server	str	Name of SQL server.	required
database	str	Database name.	required
procedure	str	Name of stored procedure.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_item async

get_item(server: str, database: str, table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get row

This operation gets a row from a table.

Swagger operation ID: GetItem_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
table	str	Name of SQL table.	required
id	str	Unique identifier of the row to retrieve.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items

list_items(server: str, database: str, table: str, *, apply: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, select: Optional[str] = None, count: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get rows

This operation gets rows from a table.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
table	str	Name of SQL table.	required
apply	Optional[str]	A sequence of OData aggregation transformations.	None
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
skip	Optional[int]	The number of entries to skip (default = 0).	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
count	Optional[bool]	Option to specify if only total entity count should be returned in the query (default = false).	None
extract_sensitivity_label	Optional[bool]	Specify whether to extract MIP labels.	None
purview_account_name	Optional[str]	Default collection will be queried unless specified.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables

list_tables(server: str, database: str, *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get tables

This operation gets tables from a database.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTables_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
extract_sensitivity_label	Optional[bool]	Specify whether to extract MIP labels.	None
purview_account_name	Optional[str]	Default collection will be queried unless specified.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

patch_item async

patch_item(input: PatchItemInput | Mapping[str, Any], server: str, database: str, table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update row

This operation updates an existing row in a table.

Swagger operation ID: PatchItem_V2.

Parameters:

Name	Type	Description	Default
input	PatchItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
server	str	Name of SQL server.	required
database	str	Database name.	required
table	str	Name of table.	required
id	str	Unique identifier of the row to update.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

post_item async

post_item(input: PostItemInput | Mapping[str, Any], server: str, database: str, table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Insert row

This operation inserts a new row into a table.

Swagger operation ID: PostItem_V2.

Parameters:

Name	Type	Description	Default
input	PostItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
server	str	Name of SQL server.	required
database	str	Database name.	required
table	str	Name of table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_servers

list_servers(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List the servers

List the servers

Returns a single-page Azure Core async collection.

Swagger operation ID: GetServers.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_databases

list_databases(server: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List the databases

List the databases

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDatabases.

Parameters:

Name	Type	Description	Default
server	str	Server name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables_for_delete_item

list_tables_for_delete_item(server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

GetTablesForDeleteItem

GetTablesForDeleteItem

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetTablesForDeleteItem_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_pass_through_native_query_metadata async

get_pass_through_native_query_metadata(input: SqlPassThroughNativeQueryBody | Mapping[str, Any], server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get pass-through native SQL query metadata

Retrieves metadata for a pass-through native SQL query.

Swagger operation ID: GetPassThroughNativeQueryMetadata_V2.

Parameters:

Name	Type	Description	Default
input	SqlPassThroughNativeQueryBody | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_procedures_v2

list_procedures_v2(server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get stored procedures

This operation gets stored procedures for a database.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetProcedures_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_procedure_v2 async

get_procedure_v2(server: str, database: str, procedure: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get metadata of a Procedure

Get metadata of a Procedure.

Swagger operation ID: GetProcedure_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
procedure	str	Procedure name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables_for_get_item

list_tables_for_get_item(server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

GetTablesForGetItem

GetTablesForGetItem

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetTablesForGetItem_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_table async

get_table(server: str, database: str, table: str, *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get metadata of a table

Get metadata of a table.

Swagger operation ID: GetTable_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
table	str	table name.	required
extract_sensitivity_label	Optional[bool]	Specify whether to extract MIP labels.	None
purview_account_name	Optional[str]	Default collection will be queried unless specified.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables_for_get_on_new_items

list_tables_for_get_on_new_items(server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

GetTablesForOnItemCreated

GetTablesForOnItemCreated

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetTablesForGetOnNewItems_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables_for_get_on_updated_items

list_tables_for_get_on_updated_items(server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

GetTablesForOnItemUpdated

GetTablesForOnItemUpdated

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetTablesForGetOnUpdatedItems_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables_for_patch_item

list_tables_for_patch_item(server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

GetTablesForPatchItem

GetTablesForPatchItem

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetTablesForPatchItem_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_table_for_patch async

get_table_for_patch(server: str, database: str, table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get metadata of a table for Patch operation

Get metadata of a table for Patch operation.

Swagger operation ID: GetTableForPatch_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
table	str	table name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables_for_post_item

list_tables_for_post_item(server: str, database: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

GetTablesForPostItem

GetTablesForPostItem

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetTablesForPostItem_V2.

Parameters:

Name	Type	Description	Default
server	str	Name of SQL server.	required
database	str	Database name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_procedure async

get_procedure(procedure: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get procedure metadata

This operation gets metadata for a stored procedure.

Swagger operation ID: GetProcedure.

Parameters:

Name	Type	Description	Default
procedure	str	Name of stored procedure.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_procedures

list_procedures(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get stored procedures

This operation gets stored procedures for a database.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetProcedures.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.