# tCosmosDBSQLAPIInput Retrieves data from a Cosmos database collection through SQL API. ## tCosmosDBSQLAPIInput Standard properties 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 all Talend products. ## Basic settings | Properties | Description | | --- | --- | | Property type | Either Built-in or Repository.

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

Click Edit
schema to make changes to the schema. If the current schema is of the Repository type, three options are available:



If you want to read all columns as an entire JSON document, put an asterisk (\*)
in the DB column column, without quotation marks
around.

The dynamic schema feature is available only when you have installed the
8.0.1-R2024-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator. | | 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](https://docs.microsoft.com/en-us/azure/cosmos-db/create-cosmosdb-resources-portal) 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](https://docs.microsoft.com/en-us/azure/cosmos-db/create-cosmosdb-resources-portal) 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.

Information noteNote:

| | 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 | Properties | Description | | --- | --- | | 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](https://docs.microsoft.com/en-us/java/api/com.microsoft.azure.cosmosdb.connectionmode?view=azure-java-legacy) 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](https://docs.microsoft.com/en-us/azure/cosmos-db/consistency-levels) for related
information. | ## Global Variables | Variables | Description | | --- | --- | | 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 guidance | Description | | --- | --- | | **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. | | **Cosmos DB limitation for HTTPS proxies with authentication** | HTTP proxies and HTTPS proxies work with the tSetProxy
component, however:



Additional limitation: Proxy configuration is managed through global JVM system
properties, so using multiple, different proxy settings for different
components in the same Job is not recommended, as the configuration will not
work as intended. |