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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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

GetItemsResponse dataclass

GetItemsResponse(metadata: Optional[List[DataWithSensitivityLabelInfo]] = None, value: Optional[List[SqlItem]] = None)

Response for Get rows

Attributes

metadata class-attribute instance-attribute

metadata: Optional[List[DataWithSensitivityLabelInfo]] = field(default=None, metadata={'wire_name': '@metadata'})

List of Sensitivity Labels

value class-attribute instance-attribute

value: Optional[List[SqlItem]] = None

List of Columns

SqlItemsList dataclass

SqlItemsList(value: Optional[List[SqlItem]] = None)

Response for When an item is created

Attributes

value class-attribute instance-attribute

value: Optional[List[SqlItem]] = None

List of Items

GetTablesResponse dataclass

GetTablesResponse(metadata: Optional[List[DataWithSensitivityLabelInfo]] = None, value: Optional[List[Table]] = None)

Response for Get tables

Attributes

metadata class-attribute instance-attribute

metadata: Optional[List[DataWithSensitivityLabelInfo]] = field(default=None, metadata={'wire_name': '@metadata'})

List of Sensitivity Labels

value class-attribute instance-attribute

value: Optional[List[Table]] = None

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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

ODataServersList dataclass

ODataServersList(value: Optional[List[Server]] = None)

Response for List the servers

Attributes

value class-attribute instance-attribute

value: Optional[List[Server]] = None

List of datasets

DatabasesList dataclass

DatabasesList(value: Optional[List[Database]] = None)

Response for List the databases

Attributes

value class-attribute instance-attribute

value: Optional[List[Database]] = None

List of datasets

TablesList dataclass

TablesList(value: Optional[List[Table]] = None)

Response for GetTablesForDeleteItem

Attributes

value class-attribute instance-attribute

value: Optional[List[Table]] = None

List of Tables

PassThroughNativeQueryMetadata dataclass

PassThroughNativeQueryMetadata(name: Optional[str] = None, title: Optional[str] = None, schema: Optional[ObjectEntity] = None)

Response for Get pass-through native SQL query metadata

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Query name

title class-attribute instance-attribute

title: Optional[str] = None

Query title

ProceduresList dataclass

ProceduresList(value: Optional[List[Procedure]] = None)

Response for Get stored procedures

Attributes

value class-attribute instance-attribute

value: Optional[List[Procedure]] = None

List of Procedures

ProcedureMetadata dataclass

ProcedureMetadata(name: Optional[str] = None, title: Optional[str] = None, schema: Optional[ObjectEntity] = None)

Response for Get metadata of a Procedure

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Procedure name

title class-attribute instance-attribute

title: Optional[str] = None

Procedure title

TableMetadata dataclass

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

Response for Get metadata of a table

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Table name

title class-attribute instance-attribute

title: Optional[str] = None

Table title

x_ms_permission class-attribute instance-attribute

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

Table permission

web_url class-attribute instance-attribute

web_url: Optional[str] = field(default=None, 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] = None

Blob dataset source

display_name class-attribute instance-attribute

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

Blob dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = field(default=None, 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, Any]] = None, tables: Optional[List[Table]] = None)

Definition: Database

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the database.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DynamicProperties'})

Additional database properties provided by the connector to the clients.

tables class-attribute instance-attribute

tables: Optional[List[Table]] = None

Database items

DataSet dataclass

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

Definition: DataSet

Attributes

name class-attribute instance-attribute

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

Dataset name

display_name class-attribute instance-attribute

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

Dataset display name

query class-attribute instance-attribute

query: Optional[List[PassThroughNativeQuery]] = None

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] = None, x_ms_dynamic_tree: Optional[DynamicTree] = None)

Definition: DataSetParameter

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name

type_ class-attribute instance-attribute

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

Type

url_encoding class-attribute instance-attribute

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

Parameter url encoding

description class-attribute instance-attribute

description: Optional[str] = None

Description

required class-attribute instance-attribute

required: Optional[bool] = None

Is parameter required

x_ms_summary class-attribute instance-attribute

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

Summary

DataSetsList dataclass

DataSetsList(value: Optional[List[DataSet]] = None)

Definition: DataSetsList

Attributes

value class-attribute instance-attribute

value: Optional[List[DataSet]] = None

List of datasets

DataSetsMetadata dataclass

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

Definition: DataSetsMetadata

Attributes

dataset_format class-attribute instance-attribute

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

Dataset Format

parameters class-attribute instance-attribute

parameters: Optional[List[DataSetParameter]] = None

Parameters

DataWithSensitivityLabelInfo dataclass

DataWithSensitivityLabelInfo(name: Optional[str] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Definition: DataWithSensitivityLabelInfo

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name

sensitivity_label_info class-attribute instance-attribute

sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field(default=None, metadata={'wire_name': 'sensitivityLabelInfo'})

List of Sensitivity Label Information

DynamicTree dataclass

DynamicTree(settings: Optional[DynamicTreeSettings] = None, open: Optional[DynamicTreeOpenBrowse] = None, browse: Optional[DynamicTreeOpenBrowse] = 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] = None

Path

item_value_path class-attribute instance-attribute

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

Item value path

item_title_path class-attribute instance-attribute

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

Item title path

item_full_title_path class-attribute instance-attribute

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

Item full title path

item_is_parent class-attribute instance-attribute

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

Is item parent

selectable_filter class-attribute instance-attribute

selectable_filter: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'canSelectParentNodes'})

Can select parent nodes

can_select_leaf_nodes class-attribute instance-attribute

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

Can select leaf nodes

selected_item_placeholder class-attribute instance-attribute

selected_item_placeholder: Optional[str] = field(default=None, 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] = None

Path

value_collection class-attribute instance-attribute

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

Value collection

value_path class-attribute instance-attribute

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

Value path

value_title class-attribute instance-attribute

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

Value title

Item dataclass

Item(dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: Item

ItemsList dataclass

ItemsList(value: Optional[List[Item]] = None)

Definition: ItemsList

Attributes

value class-attribute instance-attribute

value: Optional[List[Item]] = None

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] = field(default=None, metadata={'wire_name': 'createKeyColumnPath'})

Path to create key column

create_key_column_method class-attribute instance-attribute

create_key_column_method: Optional[str] = field(default=None, 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] = field(default=None, 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] = field(default_factory=dict)

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] = field(default=None, metadata={'wire_name': 'Language'})

Query language

PassThroughNativeQueryBody dataclass

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

Definition: PassThroughNativeQueryBody

Attributes

query class-attribute instance-attribute

query: Optional[str] = None

Query Text

formal_parameters class-attribute instance-attribute

formal_parameters: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'formalParameters'})

Formal Parameters

actual_parameters class-attribute instance-attribute

actual_parameters: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'actualParameters'})

Actual parameters

PassThroughNativeQueryResult dataclass

PassThroughNativeQueryResult(output_parameters: Optional[Dict[str, Any]] = None, result_sets: Optional[Dict[str, Any]] = None)

Definition: PassThroughNativeQueryResult

Attributes

output_parameters class-attribute instance-attribute

output_parameters: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'OutputParameters'})

Output parameter values

result_sets class-attribute instance-attribute

result_sets: Optional[Dict[str, Any]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'Name'})

Procedure name

display_name class-attribute instance-attribute

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

Procedure display name

ProcedureResult dataclass

ProcedureResult(output_parameters: Optional[Dict[str, Any]] = None, return_code: Optional[int] = None, result_sets: Optional[Dict[str, Any]] = None)

Definition: ProcedureResult

Attributes

output_parameters class-attribute instance-attribute

output_parameters: Optional[Dict[str, Any]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'ReturnCode'})

Return code of a procedure.

result_sets class-attribute instance-attribute

result_sets: Optional[Dict[str, Any]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute

name: Optional[str] = None

SensitivityLabel name.

display_name class-attribute instance-attribute

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

SensitivityLabel displayName info

tooltip class-attribute instance-attribute

tooltip: Optional[str] = None

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute

priority: Optional[int] = None

SensitivityLabel priority.

color class-attribute instance-attribute

color: Optional[str] = None

SensitivityLabel color.

is_encrypted class-attribute instance-attribute

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

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute

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

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute

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

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute

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

Parent SensitivityLabel Id.

Server dataclass

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

Definition: Server

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the server.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DynamicProperties'})

Additional server properties provided by the connector to the clients.

databases class-attribute instance-attribute

databases: Optional[List[Database]] = None

Table items

SqlItem dataclass

SqlItem(dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: SqlItem

SqlPassThroughNativeQueryBody dataclass

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

Definition: SqlPassThroughNativeQueryBody

Attributes

actual_parameters class-attribute instance-attribute

actual_parameters: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'actualParameters'})

Actual parameters

query class-attribute instance-attribute

query: Optional[str] = None

Query Text

formal_parameters class-attribute instance-attribute

formal_parameters: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'formalParameters'})

Formal Parameters

SqlPassThroughNativeQueryResult dataclass

SqlPassThroughNativeQueryResult(output_parameters: Optional[Dict[str, Any]] = None, result_sets: Optional[Dict[str, Any]] = None)

Definition: SqlPassThroughNativeQueryResult

Attributes

output_parameters class-attribute instance-attribute

output_parameters: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'OutputParameters'})

Output parameter values

result_sets class-attribute instance-attribute

result_sets: Optional[Dict[str, Any]] = field(default=None, 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, Any]] = None)

Definition: Table

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(sort_restrictions: Optional[TableSortRestrictionsMetadata] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata] = None, count_restrictions: Optional[TableCountRestrictionsMetadata] = 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] = field(default=None, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute

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

List of supported filter capabilities

server_paging_options class-attribute instance-attribute

server_paging_options: Optional[List[str]] = field(default=None, 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] = None

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

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

List of non filterable properties

required_properties class-attribute instance-attribute

required_properties: Optional[List[str]] = field(default=None, 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] = None

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] = None

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] = None

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

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

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

ascending_only_properties: Optional[List[str]] = field(default=None, 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] = None

Dataset source

display_name class-attribute instance-attribute

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

Dataset display name

url_encoding class-attribute instance-attribute

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

Dataset url encoding

table_display_name class-attribute instance-attribute

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

Table display name

table_plural_name class-attribute instance-attribute

table_plural_name: Optional[str] = field(default=None, 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] = None

Query Text

PQMetadata dataclass

PQMetadata(value: Optional[PQMetadataValue] = None, result_type: Optional[str] = None)

Definition: PQMetadata

Attributes

result_type class-attribute instance-attribute

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

Result Type

PQMetadataValue dataclass

PQMetadataValue(name: Optional[str] = None, title: Optional[str] = None, schema: Optional[ObjectEntity] = None)

Definition: PQMetadataValue

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Query name

title class-attribute instance-attribute

title: Optional[str] = None

Query title

PassThroughPQResult dataclass

PassThroughPQResult(value: Optional[PQRows] = 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] = field(default_factory=dict)

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

SqlClient

SqlClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

delete_item_async async

delete_item_async(server: str, database: str, table: str, id: str) -> None

Delete row

This operation deletes a row from a table.

execute_pass_through_native_query_async async

execute_pass_through_native_query_async(input: SqlPassThroughNativeQueryBody, server: str, database: str) -> dict[str, Any] | None

Execute a SQL query

Execute a SQL query

execute_procedure_async async

execute_procedure_async(input: ExecuteProcedureInput, server: str, database: str, procedure: str) -> dict[str, Any] | None

Execute stored procedure

This operation runs a stored procedure.

get_item_async async

get_item_async(server: str, database: str, table: str, id: str) -> dict[str, Any] | None

Get row

This operation gets a row from a table.

get_items_async async

get_items_async(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) -> dict[str, Any] | None

Get rows

This operation gets rows from a table.

get_tables_async async

get_tables_async(server: str, database: str, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None) -> dict[str, Any] | None

Get tables

This operation gets tables from a database.

patch_item_async async

patch_item_async(input: PatchItemInput, server: str, database: str, table: str, id: str) -> dict[str, Any] | None

Update row

This operation updates an existing row in a table.

post_item_async async

post_item_async(input: PostItemInput, server: str, database: str, table: str) -> dict[str, Any] | None

Insert row

This operation inserts a new row into a table.

get_servers_async async

get_servers_async() -> dict[str, Any] | None

List the servers

List the servers

get_databases_async async

get_databases_async(server: str) -> dict[str, Any] | None

List the databases

List the databases

get_tables_for_delete_item_async async

get_tables_for_delete_item_async(server: str, database: str) -> dict[str, Any] | None

GetTablesForDeleteItem

GetTablesForDeleteItem

get_pass_through_native_query_metadata_async async

get_pass_through_native_query_metadata_async(input: SqlPassThroughNativeQueryBody, server: str, database: str) -> dict[str, Any] | None

Get pass-through native SQL query metadata

Retrieves metadata for a pass-through native SQL query.

get_procedures_v2_async async

get_procedures_v2_async(server: str, database: str) -> dict[str, Any] | None

Get stored procedures

This operation gets stored procedures for a database.

get_procedure_v2_async async

get_procedure_v2_async(server: str, database: str, procedure: str) -> dict[str, Any] | None

Get metadata of a Procedure

Get metadata of a Procedure.

get_tables_for_get_item_async async

get_tables_for_get_item_async(server: str, database: str) -> dict[str, Any] | None

GetTablesForGetItem

GetTablesForGetItem

get_table_async async

get_table_async(server: str, database: str, table: str, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None) -> dict[str, Any] | None

Get metadata of a table

Get metadata of a table.

get_tables_for_get_on_new_items_async async

get_tables_for_get_on_new_items_async(server: str, database: str) -> dict[str, Any] | None

GetTablesForOnItemCreated

GetTablesForOnItemCreated

get_tables_for_get_on_updated_items_async async

get_tables_for_get_on_updated_items_async(server: str, database: str) -> dict[str, Any] | None

GetTablesForOnItemUpdated

GetTablesForOnItemUpdated

get_tables_for_patch_item_async async

get_tables_for_patch_item_async(server: str, database: str) -> dict[str, Any] | None

GetTablesForPatchItem

GetTablesForPatchItem

get_table_for_patch_async async

get_table_for_patch_async(server: str, database: str, table: str) -> dict[str, Any] | None

Get metadata of a table for Patch operation

Get metadata of a table for Patch operation.

get_tables_for_post_item_async async

get_tables_for_post_item_async(server: str, database: str) -> dict[str, Any] | None

GetTablesForPostItem

GetTablesForPostItem

get_procedure_async async

get_procedure_async(procedure: str) -> dict[str, Any] | None

Get procedure metadata

This operation gets metadata for a stored procedure.

get_procedures_async async

get_procedures_async() -> dict[str, Any] | None

Get stored procedures

This operation gets stored procedures for a database.