tMongoDBOutput Standard properties
These properties are used to configure tMongoDBOutput running in the Standard Job framework.
The Standard tMongoDBOutput component belongs to the Big Data and the Databases NoSQL families.
The component in this framework is available in all Talend products with Big Data and in Talend Data Fabric.
Basic settings
Use existing connection |
Select this check box and in the Component List drop-down list, select the desired connection component to reuse the connection details you already defined. |
DB Version |
List of the database versions. Available when the Use existing connection check box is not selected. |
Use replica set address |
Select this check box to show the Replica address table. In the Replica address table, you can define multiple MongoDB database servers for failover. Available when the Use existing connection check box is not selected. |
Server and Port |
IP address and listening port of the database server. Available when the Use existing connection or Use replica set address check box is not selected. |
Database |
Name of the database. |
Use SSL connection |
Select this check box to enable the SSL or TLS encrypted connection. Then you need to use the tSetKeystore component in the same Job to specify the encryption information. Note that the SSL connection is available only for the version 2.4 + of MongoDB. |
Set write concern |
Select this check box to set the level of acknowledgement requested from for write operations. Then you need to select the level of this operation. For further information, see the related MongoDB documentation on http://docs.mongodb.org/manual/core/write-concern/. |
Bulk write |
Select this check box to insert, update or remove data in bulk. Note this feature is available only when the version of MongoDB you are using is 2.6+. Then you need to select Ordered or Unordered to define how the MongoDB database processes the data
sent by the Studio.
In the Bulk write size field, enter the size of each query group to be processed by MongoDB. In the documentation of MongoDB, some restrictions and expected behaviors as to this size are explained. You can find the details on http://docs.mongodb.org/manual/core/bulk-write-operations/. |
Required authentication |
Select this check box to enable the database authentication. Among the mechanisms listed on the Authentication mechanism drop-down list, the NEGOTIATE one is recommended if you are not using Kerberos, because it automatically select the authentication mechanism the most adapted to the MongoDB version you are using. Because the SCRAM-SHA-256 authentication mechanism is only supported by
MongoDB 4.x and later versions, SCRAM-SHA-256 SASL option is available
only when MongoDB 4.4.X and later is selected from the DB
Version drop-down list.
Information noteNote: The SCRAM-SHA-256 SASL
option is available only when you have installed the R2021-08 Studio Monthly update or a
later one delivered by Talend. For more information, check with your
administrator.
For details about the other mechanisms in this list, see MongoDB Authentication from the MongoDB documentation. |
Set Authentication database |
If the username to be used to connect to MongoDB has been created in a specific Authentication database of MongoDB, select this check box to enter the name of this Authentication database in the Authentication database field that is displayed. For further information about the MongoDB Authentication database, see User Authentication database. |
Username and Password |
DB user authentication data. To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings. Available when the Required authentication check box is selected. If the security system you have selected from the Authentication mechanism drop-down list is Kerberos, you need to enter the User principal, the Realm and the KDC server fields instead of the Username and the Password fields. |
Collection |
Name of the collection in the MongoDB database. |
Drop collection if exist |
Select this check box to drop the collection if it already exists. |
Action on data |
The following operations are available:
|
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. Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:
Click Sync columns to retrieve the schema from the previous component connected in the Job. |
|
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. When the schema to be reused has default values that are integers or functions, ensure that these default values are not enclosed within quotation marks. If they are, you must remove the quotation marks manually. For more information, see the related description of retrieving table schemas in Talend Studio User Guide. |
Mapping |
Each column of the schema defined for this component represents a field of the documents to be read. In this table, you need to specify the parent nodes of these fields, if any. For example, in the document reading as
follows
{ _id: ObjectId("5099803df3f4948bd2f98391"), person: { first: "Joe", last: "Walker" } }The first and the last fields have person as their parent node but the _id field does not have any parent node. So once completed, this Mapping table should read as follows: Column Parent node path _id first "person" last "person" Updatable and Insertable: As the name applies, specify whether or not a field can be updated and inserted. These two columns appear when Upser with set is selected from the Action on data drop-down list. Information noteNote: The Updatable and Insertable columns are available only when you
have installed installed the R2020-08 Studio Monthly update or a later one
delivered by Talend. For more information, check with your
administrator.
Not available when the Generate JSON Document check box is selected in Advanced settings. |
Die on error |
This check box is cleared by default, meaning to skip the row on error and to complete the process for error-free rows. |
Advanced settings
Generate JSON Document |
Select this check box for JSON configuration:
Configure JSON Tree:
click the [...] button
to open the interface for JSON tree configuration. For more information, see
Configuring a JSON Tree.
Information noteNote: You can adapt the
JSON objects into BSON objects by adding __DOLLAR__ before
the object (for example, $oid and $date
become respectively __DOLLAR__oid and
__DOLLAR__date). The MongoDB specific objects can then
be read and not considered as character string.
Create empty element if needed: If the Related Column in the XML tree editor has null values, or if no column is associated with the XML node, this option creates an open/close tag in the expected place. This check box is selected by default. Ignore service attributes for empty elements: Select this option to prevent the component from generating a node if the input node is null but has service attributes (such as @type, @class, and @array). This option is available when the Create empty element if needed option is not selected. Information noteNote: The
Create empty element if needed and
Ignore service attributes for empty elements options are available only if you have installed the R2020-04
Studio Monthly update or a later one delivered by Talend. For more
information, check with your administrator.
Group by: click the [+] button to add lines and choose the input columns for grouping the records. Remove root node: select this check box to remove the root node. Data node and Query node (available for update and upsert actions): type in the name of data node and query node configured on the JSON tree. Information noteWarning:
These nodes are mandatory for update and upsert actions. They are intended to enable the update and upsert actions though will not be stored in the database. |
No query timeout |
Select this check box to prevent MongoDB servers from stopping idle cursors at the end of 10-minute inactivity of these cursors. In this situation, an idle cursor will stay open until either the results of this cursor are exhausted or you manually close it using the cursor.close() method. A cursor for MongoDB is a pointer to the result set of a query. By default, that is to say, with this check box being clear, a MongoDB server automatically stops idle cursors after a given inactivity period to avoid excess memory use. For further information about MongoDB cursors, see https://docs.mongodb.org/manual/core/cursors/. |
tStatCatcher Statistics |
Select this check box to collect the log data at the component level. |
Global Variables
Global Variables |
NB_LINE: the number of rows read by an input component or transferred to an output component. This is an After variable and it returns an integer. ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box. A Flow variable functions during the execution of a component while an After variable functions after the execution of the component. To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it. For further information about variables, see Talend Studio User Guide. |
Usage
Usage rule |
tMongoDBOutput executes the action defined on the collection in the MongoDB database based on the flow incoming from the preceding component in the Job. |
Limitation |
Information noteNote:
|