CosmosClient Class

Reference

Represents a document client.

Provides a client-side logical representation of the Azure Cosmos service. This client is used to configure and execute requests against the service.

The service client encapsulates the endpoint and credentials used to access the Azure Cosmos service.

Inheritance: builtins.object

CosmosClient

Constructor

CosmosClient(url_connection, auth, connection_policy=None, consistency_level='Session')

Parameters

url_connection

auth

connection_policy

default value: None

consistency_level

default value: Session

Methods

Create	Creates a Azure Cosmos resource and returns it.
CreateAttachment	Creates an attachment in a document.
CreateAttachmentAndUploadMedia	Creates an attachment and upload media.
CreateContainer	Creates a collection in a database.
CreateDatabase	Creates a database.
CreateItem	Creates a document in a collection.
CreatePermission	Creates a permission for a user.
CreateStoredProcedure	Creates a stored procedure in a collection.
CreateTrigger	Creates a trigger in a collection.
CreateUser	Creates a user.
CreateUserDefinedFunction	Creates a user defined function in a collection.
DeleteAttachment	Deletes an attachment.
DeleteConflict	Deletes a conflict.
DeleteContainer	Deletes a collection.
DeleteDatabase	Deletes a database.
DeleteItem	Deletes a document.
DeletePermission	Deletes a permission.
DeleteResource	Deletes a Azure Cosmos resource and returns it.
DeleteStoredProcedure	Deletes a stored procedure.
DeleteTrigger	Deletes a trigger.
DeleteUser	Deletes a user.
DeleteUserDefinedFunction	Deletes a user defined function.
ExecuteStoredProcedure	Executes a store procedure.
GetDatabaseAccount	Gets database account info.
GetPartitionResolver	Gets the partition resolver associated with the database link
QueryAttachments	Queries attachments in a document.
QueryConflicts	Queries conflicts in a collection.
QueryContainers	Queries collections in a database.
QueryDatabases	Queries databases.
QueryFeed	Query Feed for Document Collection resource.
QueryItems	Queries documents in a collection.
QueryItemsChangeFeed	Queries documents change feed in a collection.
QueryOffers	Query for all offers.
QueryPermissions	Queries permissions for a user.
QueryStoredProcedures	Queries stored procedures in a collection.
QueryTriggers	Queries triggers in a collection.
QueryUserDefinedFunctions	Queries user defined functions in a collection.
QueryUsers	Queries users in a database.
Read	Reads a Azure Cosmos resource and returns it.
ReadAttachment	Reads an attachment.
ReadAttachments	Reads all attachments in a document.
ReadConflict	Reads a conflict.
ReadConflicts	Reads conflicts.
ReadContainer	Reads a collection.
ReadContainers	Reads all collections in a database.
ReadDatabase	Reads a database.
ReadDatabases	Reads all databases.
ReadItem	Reads a document.
ReadItems	Reads all documents in a collection.
ReadMedia	Reads a media. When self.connection_policy.MediaReadMode == documents.MediaReadMode.Streamed, returns a file-like stream object; otherwise, returns a str.
ReadOffer	Reads an offer.
ReadOffers	Reads all offers.
ReadPermission	Reads a permission.
ReadPermissions	Reads all permissions for a user.
ReadStoredProcedure	Reads a stored procedure.
ReadStoredProcedures	Reads all store procedures in a collection.
ReadTrigger	Reads a trigger.
ReadTriggers	Reads all triggers in a collection.
ReadUser	Reads a user.
ReadUserDefinedFunction	Reads a user defined function.
ReadUserDefinedFunctions	Reads all user defined functions in a collection.
ReadUsers	Reads all users in a database.
RegisterPartitionResolver	Registers the partition resolver associated with the database link
Replace	Replaces a Azure Cosmos resource and returns it.
ReplaceAttachment	Replaces an attachment and returns it.
ReplaceContainer	Replaces a collection and return it.
ReplaceItem	Replaces a document and returns it.
ReplaceOffer	Replaces an offer and returns it.
ReplacePermission	Replaces a permission and return it.
ReplaceStoredProcedure	Replaces a stored procedure and returns it.
ReplaceTrigger	Replaces a trigger and returns it.
ReplaceUser	Replaces a user and return it.
ReplaceUserDefinedFunction	Replaces a user defined function and returns it.
UpdateMedia	Updates a media and returns it.
Upsert	Upserts a Azure Cosmos resource and returns it.
UpsertAttachment	Upserts an attachment in a document.
UpsertAttachmentAndUploadMedia	Upserts an attachment and upload media.
UpsertItem	Upserts a document in a collection.
UpsertPermission	Upserts a permission for a user.
UpsertStoredProcedure	Upserts a stored procedure in a collection.
UpsertTrigger	Upserts a trigger in a collection.
UpsertUser	Upserts a user.
UpsertUserDefinedFunction	Upserts a user defined function in a collection.

Create

Creates a Azure Cosmos resource and returns it.

Create(body, path, type, id, initial_headers, options=None)

Parameters

body: dict

Required

path: str

Required

type: str

Required

id: str

Required

initial_headers: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The created Azure Cosmos resource.

Return type

dict

CreateAttachment

Creates an attachment in a document.

CreateAttachment(document_link, attachment, options=None)

Parameters

document_link: str

Required

The link to the document.

attachment: dict

Required

The Azure Cosmos attachment to create.

options: dict

default value: None

The request options for the request.

Returns

The created Attachment.

Return type

dict

CreateAttachmentAndUploadMedia

Creates an attachment and upload media.

CreateAttachmentAndUploadMedia(document_link, readable_stream, options=None)

Parameters

document_link: str

Required

The link to the document.

stream object) readable_stream: <xref:(<xref:file-like>>

Required

options: dict

default value: None

The request options for the request.

Returns

The created Attachment.

Return type

dict

CreateContainer

Creates a collection in a database.

CreateContainer(database_link, collection, options=None)

Parameters

database_link: str

Required

The link to the database.

collection: dict

Required

The Azure Cosmos collection to create.

options: dict

default value: None

The request options for the request.

Returns

The Collection that was created.

Return type

dict

CreateDatabase

Creates a database.

CreateDatabase(database, options=None)

Parameters

database: dict

Required

The Azure Cosmos database to create.

options: dict

default value: None

The request options for the request.

Returns

The Database that was created.

Return type

dict

CreateItem

Creates a document in a collection.

CreateItem(database_or_Container_link, document, options=None)

Parameters

database_or_Container_link: str

Required

The link to the database when using partitioning, otherwise link to the document collection.

document: dict

Required

The Azure Cosmos document to create.

options: dict

default value: None

The request options for the request.

options['disableAutomaticIdGeneration']: bool

Required

Disables the automatic id generation. If id is missing in the body and this option is true, an error will be returned.

Returns

The created Document.

Return type

dict

CreatePermission

Creates a permission for a user.

CreatePermission(user_link, permission, options=None)

Parameters

user_link: str

Required

The link to the user entity.

permission: dict

Required

The Azure Cosmos user permission to create.

options: dict

default value: None

The request options for the request.

Returns

The created Permission.

Return type

dict

CreateStoredProcedure

Creates a stored procedure in a collection.

CreateStoredProcedure(collection_link, sproc, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

sproc: str

Required

options: dict

default value: None

The request options for the request.

Returns

The created Stored Procedure.

Return type

dict

CreateTrigger

Creates a trigger in a collection.

CreateTrigger(collection_link, trigger, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

trigger: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The created Trigger.

Return type

dict

CreateUser

Creates a user.

CreateUser(database_link, user, options=None)

Parameters

database_link: str

Required

The link to the database.

user: dict

Required

The Azure Cosmos user to create.

options: dict

default value: None

The request options for the request.

Returns

The created User.

Return type

dict

CreateUserDefinedFunction

Creates a user defined function in a collection.

CreateUserDefinedFunction(collection_link, udf, options=None)

Parameters

collection_link: str

Required

The link to the collection.

udf: str

Required

options: dict

default value: None

The request options for the request.

Returns

The created UDF.

Return type

dict

DeleteAttachment

Deletes an attachment.

DeleteAttachment(attachment_link, options=None)

Parameters

attachment_link: str

Required

The link to the attachment.

options: dict

default value: None

The request options for the request.

Returns

The deleted Attachment.

Return type

dict

DeleteConflict

Deletes a conflict.

DeleteConflict(conflict_link, options=None)

Parameters

conflict_link: str

Required

The link to the conflict.

options: dict

default value: None

The request options for the request.

Returns

The deleted Conflict.

Return type

dict

DeleteContainer

Deletes a collection.

DeleteContainer(collection_link, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

options: dict

default value: None

The request options for the request.

Returns

The deleted Collection.

Return type

dict

DeleteDatabase

Deletes a database.

DeleteDatabase(database_link, options=None)

Parameters

database_link: str

Required

The link to the database.

options: dict

default value: None

The request options for the request.

Returns

The deleted Database.

Return type

dict

DeleteItem

Deletes a document.

DeleteItem(document_link, options=None)

Parameters

document_link: str

Required

The link to the document.

options: dict

default value: None

The request options for the request.

Returns

The deleted Document.

Return type

dict

DeletePermission

Deletes a permission.

DeletePermission(permission_link, options=None)

Parameters

permission_link: str

Required

The link to the permission.

options: dict

default value: None

The request options for the request.

Returns

The deleted Permission.

Return type

dict

DeleteResource

Deletes a Azure Cosmos resource and returns it.

DeleteResource(path, type, id, initial_headers, options=None)

Parameters

path: str

Required

type: str

Required

id: str

Required

initial_headers: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The deleted Azure Cosmos resource.

Return type

dict

DeleteStoredProcedure

Deletes a stored procedure.

DeleteStoredProcedure(sproc_link, options=None)

Parameters

sproc_link: str

Required

The link to the stored procedure.

options: dict

default value: None

The request options for the request.

Returns

The deleted Stored Procedure.

Return type

dict

DeleteTrigger

Deletes a trigger.

DeleteTrigger(trigger_link, options=None)

Parameters

trigger_link: str

Required

The link to the trigger.

options: dict

default value: None

The request options for the request.

Returns

The deleted Trigger.

Return type

dict

DeleteUser

Deletes a user.

DeleteUser(user_link, options=None)

Parameters

user_link: str

Required

The link to the user entity.

options: dict

default value: None

The request options for the request.

Returns

The deleted user.

Return type

dict

DeleteUserDefinedFunction

Deletes a user defined function.

DeleteUserDefinedFunction(udf_link, options=None)

Parameters

udf_link: str

Required

The link to the user defined function.

options: dict

default value: None

The request options for the request.

Returns

The deleted UDF.

Return type

dict

ExecuteStoredProcedure

Executes a store procedure.

ExecuteStoredProcedure(sproc_link, params, options=None)

Parameters

sproc_link: str

Required

The link to the stored procedure.

params: dict

Required

List or None

options: dict

default value: None

The request options for the request.

Returns

The Stored Procedure response.

Return type

dict

GetDatabaseAccount

Gets database account info.

GetDatabaseAccount(url_connection=None)

Parameters

url_connection

default value: None

Returns

The Database Account.

Return type

DatabaseAccount

GetPartitionResolver

Gets the partition resolver associated with the database link

GetPartitionResolver(database_link)

Parameters

database_link: str

Required

Database self link or ID based link.

Returns

An instance of PartitionResolver.

Return type

object

QueryAttachments

Queries attachments in a document.

QueryAttachments(document_link, query, options=None)

Parameters

document_link: str

Required

The link to the document.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Attachments.

Return type

QueryIterable

QueryConflicts

Queries conflicts in a collection.

QueryConflicts(collection_link, query, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Conflicts.

Return type

QueryIterable

QueryContainers

Queries collections in a database.

QueryContainers(database_link, query, options=None)

Parameters

database_link: str

Required

The link to the database.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Collections.

Return type

QueryIterable

QueryDatabases

Queries databases.

QueryDatabases(query, options=None)

Parameters

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Databases.

Return type

QueryIterable

QueryFeed

Query Feed for Document Collection resource.

QueryFeed(path, collection_id, query, options, partition_key_range_id=None)

Parameters

path: str

Required

Path to the document collection.

collection_id: str

Required

Id of the document collection.

or dict) query: (str

Required

options: dict

Required

The request options for the request.

partition_key_range_id: str

default value: None

Partition key range id.

Return type

tuple

QueryItems

Queries documents in a collection.

QueryItems(database_or_Container_link, query, options=None, partition_key=None)

Parameters

database_or_Container_link: str

Required

The link to the database when using partitioning, otherwise link to the document collection.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

partition_key: str

default value: None

Partition key for the query(default value None)

Returns

Query Iterable of Documents.

Return type

QueryIterable

QueryItemsChangeFeed

Queries documents change feed in a collection.

QueryItemsChangeFeed(collection_link, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

options: dict

default value: None

The request options for the request. options may also specify partition key range id.

Returns

Query Iterable of Documents.

Return type

QueryIterable

QueryOffers

Query for all offers.

QueryOffers(query, options=None)

Parameters

or dict) query: (str

Required

options: dict

default value: None

The request options for the request

Returns

Query Iterable of Offers.

Return type

QueryIterable

QueryPermissions

Queries permissions for a user.

QueryPermissions(user_link, query, options=None)

Parameters

user_link: str

Required

The link to the user entity.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Permissions.

Return type

QueryIterable

QueryStoredProcedures

Queries stored procedures in a collection.

QueryStoredProcedures(collection_link, query, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Stored Procedures.

Return type

QueryIterable

QueryTriggers

Queries triggers in a collection.

QueryTriggers(collection_link, query, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Triggers.

Return type

QueryIterable

QueryUserDefinedFunctions

Queries user defined functions in a collection.

QueryUserDefinedFunctions(collection_link, query, options=None)

Parameters

collection_link: str

Required

The link to the collection.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of UDFs.

Return type

QueryIterable

QueryUsers

Queries users in a database.

QueryUsers(database_link, query, options=None)

Parameters

database_link: str

Required

The link to the database.

or dict) query: (str

Required

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Users.

Return type

QueryIterable

Read

Reads a Azure Cosmos resource and returns it.

Read(path, type, id, initial_headers, options=None)

Parameters

path: str

Required

type: str

Required

id: str

Required

initial_headers: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The upserted Azure Cosmos resource.

Return type

dict

ReadAttachment

Reads an attachment.

ReadAttachment(attachment_link, options=None)

Parameters

attachment_link: str

Required

The link to the attachment.

options: dict

default value: None

The request options for the request.

Returns

The read Attachment.

Return type

dict

ReadAttachments

Reads all attachments in a document.

ReadAttachments(document_link, options=None)

Parameters

document_link: str

Required

The link to the document.

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Attachments.

Return type

QueryIterable

ReadConflict

Reads a conflict.

ReadConflict(conflict_link, options=None)

Parameters

conflict_link: str

Required

The link to the conflict.

options: dict

default value: None

Returns

The read Conflict.

Return type

dict

ReadConflicts

Reads conflicts.

ReadConflicts(collection_link, feed_options=None)

Parameters

collection_link: str

Required

The link to the document collection.

feed_options: dict

default value: None

Returns

Query Iterable of Conflicts.

Return type

QueryIterable

ReadContainer

Reads a collection.

ReadContainer(collection_link, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

options: dict

default value: None

The request options for the request.

Returns

The read Collection.

Return type

dict

ReadContainers

Reads all collections in a database.

ReadContainers(database_link, options=None)

Parameters

database_link: str

Required

The link to the database.

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Collections.

Return type

QueryIterable

ReadDatabase

Reads a database.

ReadDatabase(database_link, options=None)

Parameters

database_link: str

Required

The link to the database.

options: dict

default value: None

The request options for the request.

Returns

The Database that was read.

Return type

dict

ReadDatabases

Reads all databases.

ReadDatabases(options=None)

Parameters

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Databases.

Return type

QueryIterable

ReadItem

Reads a document.

ReadItem(document_link, options=None)

Parameters

document_link: str

Required

The link to the document.

options: dict

default value: None

The request options for the request.

Returns

The read Document.

Return type

dict

ReadItems

Reads all documents in a collection.

ReadItems(collection_link, feed_options=None)

Parameters

collection_link: str

Required

The link to the document collection.

feed_options: dict

default value: None

Returns

Query Iterable of Documents.

Return type

QueryIterable

ReadMedia

Reads a media.

When self.connection_policy.MediaReadMode == documents.MediaReadMode.Streamed, returns a file-like stream object; otherwise, returns a str.

ReadMedia(media_link)

Parameters

media_link: str

Required

The link to the media.

Returns

The read Media.

Return type

str,

<xref:<xref:file-like stream object>>

ReadOffer

Reads an offer.

ReadOffer(offer_link)

Parameters

offer_link: str

Required

The link to the offer.

Returns

The read Offer.

Return type

dict

ReadOffers

Reads all offers.

ReadOffers(options=None)

Parameters

options: dict

default value: None

The request options for the request

Returns

Query Iterable of Offers.

Return type

QueryIterable

ReadPermission

Reads a permission.

ReadPermission(permission_link, options=None)

Parameters

permission_link: str

Required

The link to the permission.

options: dict

default value: None

The request options for the request.

Returns

The read permission.

Return type

dict

ReadPermissions

Reads all permissions for a user.

ReadPermissions(user_link, options=None)

Parameters

user_link: str

Required

The link to the user entity.

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Permissions.

Return type

QueryIterable

ReadStoredProcedure

Reads a stored procedure.

ReadStoredProcedure(sproc_link, options=None)

Parameters

sproc_link: str

Required

The link to the stored procedure.

options: dict

default value: None

The request options for the request.

Returns

The read Stored Procedure.

Return type

dict

ReadStoredProcedures

Reads all store procedures in a collection.

ReadStoredProcedures(collection_link, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Stored Procedures.

Return type

QueryIterable

ReadTrigger

Reads a trigger.

ReadTrigger(trigger_link, options=None)

Parameters

trigger_link: str

Required

The link to the trigger.

options: dict

default value: None

The request options for the request.

Returns

The read Trigger.

Return type

dict

ReadTriggers

Reads all triggers in a collection.

ReadTriggers(collection_link, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of Triggers.

Return type

QueryIterable

ReadUser

Reads a user.

ReadUser(user_link, options=None)

Parameters

user_link: str

Required

The link to the user entity.

options: dict

default value: None

The request options for the request.

Returns

The read User.

Return type

dict

ReadUserDefinedFunction

Reads a user defined function.

ReadUserDefinedFunction(udf_link, options=None)

Parameters

udf_link: str

Required

The link to the user defined function.

options: dict

default value: None

The request options for the request.

Returns

The read UDF.

Return type

dict

ReadUserDefinedFunctions

Reads all user defined functions in a collection.

ReadUserDefinedFunctions(collection_link, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

options: dict

default value: None

The request options for the request.

Returns

Query Iterable of UDFs.

Return type

QueryIterable

ReadUsers

Reads all users in a database.

ReadUsers(database_link, options=None)

Parameters

database_link

Required

options

default value: None

Returns

Query iterable of Users.

Return type

QueryIterable

RegisterPartitionResolver

Registers the partition resolver associated with the database link

RegisterPartitionResolver(database_link, partition_resolver)

Parameters

database_link: str

Required

Database Self Link or ID based link.

partition_resolver: object

Required

An instance of PartitionResolver.

Replace

Replaces a Azure Cosmos resource and returns it.

Replace(resource, path, type, id, initial_headers, options=None)

Parameters

resource: dict

Required

path: str

Required

type: str

Required

id: str

Required

initial_headers: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The new Azure Cosmos resource.

Return type

dict

ReplaceAttachment

Replaces an attachment and returns it.

ReplaceAttachment(attachment_link, attachment, options=None)

Parameters

attachment_link: str

Required

The link to the attachment.

attachment: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The replaced Attachment

Return type

dict

ReplaceContainer

Replaces a collection and return it.

ReplaceContainer(collection_link, collection, options=None)

Parameters

collection_link: str

Required

The link to the collection entity.

collection: dict

Required

The collection to be used.

options: dict

default value: None

The request options for the request.

Returns

The new Collection.

Return type

dict

ReplaceItem

Replaces a document and returns it.

ReplaceItem(document_link, new_document, options=None)

Parameters

document_link: str

Required

The link to the document.

new_document: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The new Document.

Return type

dict

ReplaceOffer

Replaces an offer and returns it.

ReplaceOffer(offer_link, offer)

Parameters

offer_link: str

Required

The link to the offer.

offer: dict

Required

Returns

The replaced Offer.

Return type

dict

ReplacePermission

Replaces a permission and return it.

ReplacePermission(permission_link, permission, options=None)

Parameters

permission_link: str

Required

The link to the permission.

permission: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The new Permission.

Return type

dict

ReplaceStoredProcedure

Replaces a stored procedure and returns it.

ReplaceStoredProcedure(sproc_link, sproc, options=None)

Parameters

sproc_link: str

Required

The link to the stored procedure.

sproc: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The replaced Stored Procedure.

Return type

dict

ReplaceTrigger

Replaces a trigger and returns it.

ReplaceTrigger(trigger_link, trigger, options=None)

Parameters

trigger_link: str

Required

The link to the trigger.

trigger: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The replaced Trigger.

Return type

dict

ReplaceUser

Replaces a user and return it.

ReplaceUser(user_link, user, options=None)

Parameters

user_link: str

Required

The link to the user entity.

user: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The new User.

Return type

dict

ReplaceUserDefinedFunction

Replaces a user defined function and returns it.

ReplaceUserDefinedFunction(udf_link, udf, options=None)

Parameters

udf_link: str

Required

The link to the user defined function.

udf: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The new UDF.

Return type

dict

UpdateMedia

Updates a media and returns it.

UpdateMedia(media_link, readable_stream, options=None)

Parameters

media_link: str

Required

The link to the media.

stream object) readable_stream: <xref:(<xref:file-like>>

Required

options: dict

default value: None

The request options for the request.

Returns

The updated Media.

Return type

str,

<xref:<xref:file-like stream object>>

Upsert

Upserts a Azure Cosmos resource and returns it.

Upsert(body, path, type, id, initial_headers, options=None)

Parameters

body: dict

Required

path: str

Required

type: str

Required

id: str

Required

initial_headers: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The upserted Azure Cosmos resource.

Return type

dict

UpsertAttachment

Upserts an attachment in a document.

UpsertAttachment(document_link, attachment, options=None)

Parameters

document_link: str

Required

The link to the document.

attachment: dict

Required

The Azure Cosmos attachment to upsert.

options: dict

default value: None

The request options for the request.

Returns

The upserted Attachment.

Return type

dict

UpsertAttachmentAndUploadMedia

Upserts an attachment and upload media.

UpsertAttachmentAndUploadMedia(document_link, readable_stream, options=None)

Parameters

document_link: str

Required

The link to the document.

stream object) readable_stream: <xref:(<xref:file-like>>

Required

options: dict

default value: None

The request options for the request.

Returns

The upserted Attachment.

Return type

dict

UpsertItem

Upserts a document in a collection.

UpsertItem(database_or_Container_link, document, options=None)

Parameters

database_or_Container_link: str

Required

The link to the database when using partitioning, otherwise link to the document collection.

document: dict

Required

The Azure Cosmos document to upsert.

options: dict

default value: None

The request options for the request.

options['disableAutomaticIdGeneration']: bool

Required

Disables the automatic id generation. If id is missing in the body and this option is true, an error will be returned.

Returns

The upserted Document.

Return type

dict

UpsertPermission

Upserts a permission for a user.

UpsertPermission(user_link, permission, options=None)

Parameters

user_link: str

Required

The link to the user entity.

permission: dict

Required

The Azure Cosmos user permission to upsert.

options: dict

default value: None

The request options for the request.

Returns

The upserted permission.

Return type

dict

UpsertStoredProcedure

Upserts a stored procedure in a collection.

UpsertStoredProcedure(collection_link, sproc, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

sproc: str

Required

options: dict

default value: None

The request options for the request.

Returns

The upserted Stored Procedure.

Return type

dict

UpsertTrigger

Upserts a trigger in a collection.

UpsertTrigger(collection_link, trigger, options=None)

Parameters

collection_link: str

Required

The link to the document collection.

trigger: dict

Required

options: dict

default value: None

The request options for the request.

Returns

The upserted Trigger.

Return type

dict

UpsertUser

Upserts a user.

UpsertUser(database_link, user, options=None)

Parameters

database_link: str

Required

The link to the database.

user: dict

Required

The Azure Cosmos user to upsert.

options: dict

default value: None

The request options for the request.

Returns

The upserted User.

Return type

dict

UpsertUserDefinedFunction

Upserts a user defined function in a collection.

UpsertUserDefinedFunction(collection_link, udf, options=None)

Parameters

collection_link: str

Required

The link to the collection.

udf: str

Required

options: dict

default value: None

The request options for the request.

Returns

The upserted UDF.

Return type

dict

Attributes

ReadEndpoint

Gets the curent read endpoint for a geo-replicated database account.

Session

Gets the session object from the client

WriteEndpoint

Gets the curent write endpoint for a geo-replicated database account.

PartitionResolverErrorMessage

PartitionResolverErrorMessage = "Couldn't find any partition resolvers for the database link provided. Ensure that the link you used when registering the partition resolvers matches the link provided or you need to register both types of database link(self link as well as ID based link)."