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] = dataclass_field(default=None, kw_only=True)

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

id class-attribute instance-attribute

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

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_etag'})

_etag

rid class-attribute instance-attribute

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

_rid

self class-attribute instance-attribute

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

_self

ts class-attribute instance-attribute

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

_ts

body class-attribute instance-attribute

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

body

id class-attribute instance-attribute

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

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] = dataclass_field(default_factory=dict, kw_only=True)

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

GetDocumentResponse dataclass

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

Response for Get a document

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 columns along with their Sensitivity Labels

GetDocumentsResponse dataclass

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

Response for Get all documents

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 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_count'})

_count

rid class-attribute instance-attribute

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

_rid

stored_procedures class-attribute instance-attribute

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

StoredProcedures

QueryDocumentsResponse dataclass

QueryDocumentsResponse(*, value: Optional[List[ObjectWithoutType | Mapping[str, Any]]] = 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 | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Query documents

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 columns along with their Sensitivity Labels

next_link class-attribute instance-attribute

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

The URL to retrieve the next page.

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] = dataclass_field(default=None, kw_only=True)

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

id class-attribute instance-attribute

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

Id of the existing stored procedure.

CosmosDbAccountList dataclass

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

Response for Get Cosmos DB accounts

Attributes

value class-attribute instance-attribute

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

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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default_factory=dict, kw_only=True)

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

DocumentsCollection dataclass

DocumentsCollection(*, value: Optional[List[ObjectWithoutType | Mapping[str, Any]]] = 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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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

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.

CosmosDbAccount dataclass

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

Definition: CosmosDbAccount

Attributes

name class-attribute instance-attribute

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

The name of the Azure Cosmos DB account.

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 Azure Cosmos DB account.

DocumentdbClient

DocumentdbClient(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 documentdb connector.

Initialize a DocumentdbClient.

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:

create_document async

create_document(input: PostDocumentsRequest | Mapping[str, Any], cosmos_db_account_name: str, database_id: str, collection_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

Create or update document

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

Swagger operation ID: CreateDocument_V3.

Parameters:

Name	Type	Description	Default
input	PostDocumentsRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	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.

create_stored_procedure async

create_stored_procedure(input: CreateStoredProcedureInput | Mapping[str, Any], cosmos_db_account_name: str, database_id: str, collection_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

Create stored procedure

Create stored procedure.

Swagger operation ID: CreateStoredProcedure_V2.

Parameters:

Name	Type	Description	Default
input	CreateStoredProcedureInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	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.

delete_document async

delete_document(cosmos_db_account_name: str, database_id: str, collection_id: str, document_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 a document

Delete a document.

Swagger operation ID: DeleteDocument_V2.

Parameters:

Name	Type	Description	Default
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	required
document_id	str	The identifier of the document.	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.

delete_stored_procedure async

delete_stored_procedure(cosmos_db_account_name: str, database_id: str, collection_id: str, sproc_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

Delete stored procedure

Delete stored procedure.

Swagger operation ID: DeleteStoredProcedure_V2.

Parameters:

Name	Type	Description	Default
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	required
sproc_id	str	The name of the 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.

execute_stored_procedure async

execute_stored_procedure(input: ExecuteStoredProcedureInput, cosmos_db_account_name: str, database_id: str, collection_id: str, sproc_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

Execute stored procedure

Execute stored procedure in specified collection.

Swagger operation ID: ExecuteStoredProcedure_V2.

Parameters:

Name	Type	Description	Default
input	ExecuteStoredProcedureInput	The request body.	required
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	required
sproc_id	str	The name of the 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_document

list_document(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, 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 a document

Get a document.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDocument_V2.

Parameters:

Name	Type	Description	Default
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	required
document_id	str	The identifier for the document.	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.

list_documents

list_documents(cosmos_db_account_name: str, database_id: str, collection_id: 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 all documents

Get all documents.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDocuments_V3.

Parameters:

Name	Type	Description	Default
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	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.

get_stored_procedures async

get_stored_procedures(cosmos_db_account_name: str, database_id: str, collection_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 stored procedures

Get stored procedures in the specified collection.

Swagger operation ID: GetStoredProcedures_V2.

Parameters:

Name	Type	Description	Default
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	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_query_documents

list_query_documents(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, consistency_level: Optional[str] = None, session_token: Optional[str] = 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]]

Query documents

Query documents.

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

Swagger operation ID: QueryDocuments_V5.

Parameters:

Name	Type	Description	Default
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
container_id	str	The name of the container.	required
query_text	Optional[str]	SQL query. If empty, will return all documents.	None
partition_key	Optional[str]	Value must be provided according to its type ("string", 42, 0.5). If empty, all partitions will be used to search for documents.	None
max_item_count	Optional[int]	An integer indicating the maximum number of items to be returned per page.	None
consistency_level	Optional[str]	Consistency level required for the feed (query/read feed) operation.	None
session_token	Optional[str]	The session token for use with session consistency.	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.

replace_document async

replace_document(input: PutDocumentRequest | Mapping[str, Any], cosmos_db_account_name: str, database_id: str, collection_id: str, document_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

Replace a document

Replace a document.

Swagger operation ID: ReplaceDocument_V2.

Parameters:

Name	Type	Description	Default
input	PutDocumentRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	required
document_id	str	The identifier of the document.	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.

replace_stored_procedure async

replace_stored_procedure(input: ReplaceStoredProcedureInput | Mapping[str, Any], cosmos_db_account_name: str, database_id: str, collection_id: str, sproc_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

Replace stored procedure

Replace stored procedure.

Swagger operation ID: ReplaceStoredProcedure_V2.

Parameters:

Name	Type	Description	Default
input	ReplaceStoredProcedureInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	required
collection_id	str	The name of the collection.	required
sproc_id	str	The name of the 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_cosmos_db_accounts

list_cosmos_db_accounts(*, 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 Cosmos DB accounts

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

Returns a single-page Azure Core async collection.

Swagger operation ID: GetCosmosDbAccounts.

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.

get_databases async

get_databases(cosmos_db_account_name: 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 all databases

Get all databases.

Swagger operation ID: GetDatabases_V2.

Parameters:

Name	Type	Description	Default
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	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_collections async

get_collections(cosmos_db_account_name: str, database_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 all collections

Get all collections.

Swagger operation ID: GetCollections_V2.

Parameters:

Name	Type	Description	Default
cosmos_db_account_name	str	The Azure Cosmos DB account name (without documents.azure.com).	required
database_id	str	The name of the database.	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.