Official |[Azure Cosmos DB] Delete Document

Operation name

Delete Document

Function overview

Deletes documents stored in Microsoft Azure Cosmos DB collection.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Collection	Required	Available	Select or enter a collection name to be read.
Delete conditions	Required	Available	Enter conditions to identify the document to be deleted.	Enter the where clause of SQL. For example, when targeting documents where the age of person is 21 from the person collection, enter "person.age = 21".

Item name

Required/Optional

Use of variables

Description

Remarks

Destination

Required

Not available

Select a connection resource.

Add: A new connection resource can be added.
Edit list: Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Collection

Required

Available

Select or enter a collection name to be read.

Delete conditions

Required

Available

Enter conditions to identify the document to be deleted.

Enter the where clause of SQL. For example, when targeting documents where the age of person is 21 from the person collection, enter "person.age = 21".

Property actions

Item name	Description	Remarks
Update collection list	Get collections from the specified destination and set them in Collection.
Test execution	Test the execution of the SQL statement with the specified delete conditions.	Disabled when Destination, Collection, or Delete conditions isn't specified.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

None.

Mass data processing

Mass data processing isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of documents deleted is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Azure Cosmos DB connector

Notes

The specifications are subject to change without any prior notification depending on the changes in Azure Cosmos DB specifications.