tCosmosDBSQLAPIInput Standard properties - Cloud

These properties are used to configure tCosmosDBSQLAPIInput running in the Standard Job framework.

The Standard tCosmosDBSQLAPIInput component belongs to the Databases NoSQL family.

The component in this framework is available in Talend Open Studio for Big Data and all subscription-based Talend products.

Basic settings

Property type	Either Built-in or Repository. Built-in: No property data is stored centrally. Repository: Select the repository file in which the properties are stored. The fields that follow are completed automatically using the data retrieved.
Schema and Edit schema	A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word `line` when naming the fields. Built-In: You create and store the schema locally for this component only. Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs. Click Edit schema to make changes to the schema. If you make changes, the schema automatically becomes built-in. View schema: choose this option to view the schema only. Change to built-in property: choose this option to change the schema to Built-in for local changes. Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.
Guess schema	Click this button to retrieve the schema from the document.
URI	Enter the URI of your Cosmos user account. As the field prompts, the URI of a Cosmos DB user account is in the format of `https://{your_account}.document.azure.com:443`. You can obtain the URI on the Keys pane of Azure portal. Click Create an Azure Cosmos DB account for related information.
Primary key	Enter the primary key of your CosmosDB user account. You can obtain the primary key on the Keys pane of Azure portal. Click Create an Azure Cosmos DB account for related information. To enter the primary key, click the [...] button next to the Primary key field to bring out the Enter a new password dialog box, enter the primary key in the text field, and click OK. Note that you can enter the primary key either in a JSON string in the pure password mode or as a Java expression in the Java mode. You can toggle between the two modes by clicking switch to Java mode or switch to pure password mode on the top of the text field. Note: The two password modes are available only when you have installed the 8.0.1-R2022-05 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator. If the 8.0.1-R2022-05 Talend Studio Monthly update or a later one delivered by Talend is not installed, you can enter primary keys in the Java mode only.
Database ID	Enter the database name.
Collection ID	Enter the collection name.
Use query	Select this option to retrieve data using query statements. You can enter the query statement in the Query field.

Advanced settings

tStatCatcher Statistics	Select this check box to collect the log data at the component level.
Connection mode	Specify the connection mode to be used. Two options are available: `Gateway` and `DirectHttps`. Click ConnectionMode for related information.
Max connection pool size	Set the maximum connection pool size. The default is 1000.
Consistency level	Set the consistency level. Click Consistency levels for related information.

Global Variables

ERROR_MESSAGE	The error message generated by the component when an error occurs. This is an After variable and it returns a string.
NB_LINE	The number of rows processed. This is an After variable and it returns an integer.

Usage

Usage rule	As a start component, tCosmosDBSQLAPIInput allows you to retrieve data from a collection in a Cosmos database through SQL API and transfer the data to the following component for display or storage.