DocumentdbClient

Attributes

ExecuteStoredProcedureInput module-attribute

ExecuteStoredProcedureInput = str

GetCollectionResponse module-attribute

GetCollectionResponse = List[Dict[str, Any]]

Classes

PostDocumentsResponse dataclass

PostDocumentsResponse(rid: Optional[str] = None, ts: Optional[int] = None, self: Optional[str] = None, etag: Optional[str] = None, attachments: Optional[str] = None, id: Optional[str] = None)

Response for Create or update document

CreateStoredProcedureInput dataclass

CreateStoredProcedureInput(body: Optional[str] = None, id: Optional[str] = None)

Create stored procedure

Attributes

body class-attribute instance-attribute

body: Optional[str] = None

Function that defines the stored procedure, e.g. 'function(params){ ... }'

id class-attribute instance-attribute

id: Optional[str] = None

New id of the stored procedure.

CreateStoredProcedureResponse dataclass

CreateStoredProcedureResponse(etag: Optional[str] = None, rid: Optional[str] = None, self: Optional[str] = None, ts: Optional[int] = None, body: Optional[str] = None, id: Optional[str] = None)

Response for Create stored procedure

Attributes

etag class-attribute instance-attribute

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

_etag

rid class-attribute instance-attribute

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

_rid

self class-attribute instance-attribute

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

_self

ts class-attribute instance-attribute

ts: Optional[int] = field(default=None, metadata={'wire_name': '_ts'})

_ts

body class-attribute instance-attribute

body: Optional[str] = None

body

id class-attribute instance-attribute

id: Optional[str] = None

id

ObjectWithoutType dataclass

ObjectWithoutType(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])

GetDocumentResponse dataclass

GetDocumentResponse(metadata: Optional[List[DataWithSensitivityLabelInfo]] = None)

Response for Get a document

Attributes

metadata class-attribute instance-attribute

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

List of columns along with their Sensitivity Labels

GetDocumentsResponse dataclass

GetDocumentsResponse(rid: Optional[str] = None, documents: Optional[List[Dict[str, Any]]] = None, metadata: Optional[List[DataWithSensitivityLabelInfo]] = None)

Response for Get all documents

Attributes

metadata class-attribute instance-attribute

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

List of columns along with their Sensitivity Labels

GetStoredProceduresResponse dataclass

GetStoredProceduresResponse(count: Optional[int] = None, rid: Optional[str] = None, stored_procedures: Optional[List[Dict[str, Any]]] = None)

Response for Get stored procedures

Attributes

count class-attribute instance-attribute

count: Optional[int] = field(default=None, metadata={'wire_name': '_count'})

_count

rid class-attribute instance-attribute

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

_rid

stored_procedures class-attribute instance-attribute

stored_procedures: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'StoredProcedures'})

StoredProcedures

QueryDocumentsResponse dataclass

QueryDocumentsResponse(value: Optional[List[ObjectWithoutType]] = None, continuation_token: Optional[str] = None, count: Optional[int] = None, request_charge: Optional[float] = None, session_token: Optional[str] = None, activity_id: Optional[str] = None, metadata: Optional[List[DataWithSensitivityLabelInfo]] = None)

Response for Query documents

Attributes

metadata class-attribute instance-attribute

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

List of columns along with their Sensitivity Labels

PutDocumentResponse dataclass

PutDocumentResponse(rid: Optional[str] = None, id: Optional[str] = None)

Response for Replace a document

ReplaceStoredProcedureInput dataclass

ReplaceStoredProcedureInput(body: Optional[str] = None, id: Optional[str] = None)

Replace stored procedure

Attributes

body class-attribute instance-attribute

body: Optional[str] = None

Function that defines the stored procedure, e.g. 'function(params){ ... }'

id class-attribute instance-attribute

id: Optional[str] = None

Id of the existing stored procedure.

CosmosDbAccountList dataclass

CosmosDbAccountList(value: Optional[List[CosmosDbAccount]] = None)

Response for Get Cosmos DB accounts

Attributes

value class-attribute instance-attribute

value: Optional[List[CosmosDbAccount]] = None

List of Azure Cosmos DB account names

GetDatabasesResponse dataclass

GetDatabasesResponse(rid: Optional[str] = None, databases: Optional[List[Dict[str, Any]]] = None, count: Optional[int] = None)

Response for Get all databases

GetCollectionsResponse dataclass

GetCollectionsResponse(rid: Optional[str] = None, document_collections: Optional[List[Dict[str, Any]]] = None, count: Optional[int] = None)

Response for Get all collections

DocumentsQuery dataclass

DocumentsQuery(query_text: Optional[str] = None)

Definition: DocumentsQuery

Attributes

query_text class-attribute instance-attribute

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

SQL Syntax Query over documents

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

DocumentsCollection dataclass

DocumentsCollection(value: Optional[List[ObjectWithoutType]] = None, continuation_token: Optional[str] = None, count: Optional[int] = None, request_charge: Optional[float] = None, session_token: Optional[str] = None, activity_id: Optional[str] = None)

Definition: DocumentsCollection

GetAccountResponse dataclass

GetAccountResponse(self: Optional[str] = None, rid: Optional[str] = None, id: Optional[str] = None)

Definition: getAccountResponse

GetDatabaseResponse dataclass

GetDatabaseResponse(id: Optional[str] = None, rid: Optional[str] = None, self: Optional[str] = None, etag: Optional[str] = None, colls: Optional[str] = None, users: Optional[str] = None, ts: Optional[int] = None)

Definition: getDatabaseResponse

PostDocumentsRequest dataclass

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

Definition: postDocumentsRequest

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

PutDocumentRequest dataclass

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

Definition: putDocumentRequest

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

QueryRequest dataclass

QueryRequest(query: Optional[str] = None)

Definition: queryRequest

QueryResponse dataclass

QueryResponse(rid: Optional[str] = None, count: Optional[float] = None, documents: Optional[List[Any]] = None)

Definition: queryResponse

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

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.

CosmosDbAccount dataclass

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

Definition: CosmosDbAccount

Attributes

name class-attribute instance-attribute

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

The name of the Azure Cosmos DB account.

display_name class-attribute instance-attribute

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

The display name of the Azure Cosmos DB account.

DocumentdbClient

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

Bases: ConnectorClientBase

Typed client for documentdb connector.

Initialize a DocumentdbClient.

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:

create_document_async async

create_document_async(input: PostDocumentsRequest, cosmos_db_account_name: str, database_id: str, collection_id: str) -> dict[str, Any] | None

Create or update document

Create or update document. When creating a document in DocumentDB, the body must include an id property.

create_stored_procedure_async async

create_stored_procedure_async(input: CreateStoredProcedureInput, cosmos_db_account_name: str, database_id: str, collection_id: str) -> dict[str, Any] | None

Create stored procedure

Create stored procedure.

delete_document_async async

delete_document_async(cosmos_db_account_name: str, database_id: str, collection_id: str, document_id: str) -> None

Delete a document

Delete a document.

delete_stored_procedure_async async

delete_stored_procedure_async(cosmos_db_account_name: str, database_id: str, collection_id: str, sproc_id: str) -> dict[str, Any] | None

Delete stored procedure

Delete stored procedure.

execute_stored_procedure_async async

execute_stored_procedure_async(input: ExecuteStoredProcedureInput, cosmos_db_account_name: str, database_id: str, collection_id: str, sproc_id: str) -> dict[str, Any] | None

Execute stored procedure

Execute stored procedure in specified collection.

get_document_async async

get_document_async(cosmos_db_account_name: str, database_id: str, collection_id: str, document_id: str, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None) -> dict[str, Any] | None

Get a document

Get a document.

get_documents_async async

get_documents_async(cosmos_db_account_name: str, database_id: str, collection_id: str, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None) -> dict[str, Any] | None

Get all documents

Get all documents.

get_stored_procedures_async async

get_stored_procedures_async(cosmos_db_account_name: str, database_id: str, collection_id: str) -> dict[str, Any] | None

Get stored procedures

Get stored procedures in the specified collection.

query_documents_async async

query_documents_async(cosmos_db_account_name: str, database_id: str, container_id: str, query_text: Optional[str] = None, partition_key: Optional[str] = None, max_item_count: Optional[int] = None, continuation_token: Optional[str] = None, consistency_level: Optional[str] = None, session_token: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None) -> dict[str, Any] | None

Query documents

Query documents.

replace_document_async async

replace_document_async(input: PutDocumentRequest, cosmos_db_account_name: str, database_id: str, collection_id: str, document_id: str) -> dict[str, Any] | None

Replace a document

Replace a document.

replace_stored_procedure_async async

replace_stored_procedure_async(input: ReplaceStoredProcedureInput, cosmos_db_account_name: str, database_id: str, collection_id: str, sproc_id: str) -> dict[str, Any] | None

Replace stored procedure

Replace stored procedure.

get_cosmos_db_accounts_async async

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

Get Cosmos DB accounts

This operation list the user's Azure Cosmos DB accounts.

get_databases_async async

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

Get all databases

Get all databases.

get_collections_async async

get_collections_async(cosmos_db_account_name: str, database_id: str) -> dict[str, Any] | None

Get all collections

Get all collections.