Official |[Azure Cosmos DB] Read Document

Operation name

Read Document

Function overview

Gets documents stored in Microsoft Azure Cosmos DB collection.

Data model

The data model of this component is table model type.

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.
Schema definition	Required	-	Specify item list for the collection specified in Collection. Added rows will be the target items to read. Each target item can be operated with the following buttons: Up Move the selected item upwards by one row. Down Move the selected item downwards by one row. Add Add a target item. Delete Delete the target item.
Schema definition/Item name	Required	Available	Enter an item name of the collection specified in Collection.	Specified item name will be displayed in Mapper schema.
Schema definition/Type	Required	Not available	Select the type of Item name.	The data types available for selection are the data types used internally. For details, refer to Internal data types. For more details on the supported types, refer to Messages and limitations of the Azure Cosmos DB connector.

Property actions

Item name	Description	Remarks
Update collection list	Get collections from the specified destination and set them in Collection.
Update schema definition	Get type information from the document registered in the specified collection and set it to Schema definition.	Get the latest 100 items from the collection specified in Collection and extract item names and types. One or more documents must be registered in collection. If item type information can't be determined or if the type isn't supported, the item type will be blank. Disabled when Destination or Collection isn't specified.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

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

The number of columns varies depending on the Attribute list settings.

= Remarks =

For schema structure, refer to Table model type .

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Parallel Stream Processing

PSP is supported.

= Remarks =

For details on PSP, refer to Parallel Stream Processing.

Available component variables

Component variable name	Description	Remarks
count	The number of gotten documents is stored.	The default value is null. Note Value isn't stored when using PSP.
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.