|
Use existing connection
|
Select this check box and in the Component
List click the relevant connection component to reuse the connection
details you already defined.
|
|
API
|
Select the database API to be used. Then the corresponding parameters to be defined are displayed in the Component view.
In the current version of this component, only the MongoDB API is supported. For this reason, MongoDB database is often mentioned in the documentation of the CosmosDB components.
|
|
Use replica set address or multiple query routers
|
Select this check box to show the Server
addresses table.
In the Server addresses
table, define the sharded MongoDB databases or the MongoDB replica sets
you want to connect to.
|
|
Server and Port
|
Enter the IP address and listening port of the database
server.
Available when the Use replica set
address or multiple query routers check box is not
selected.
|
|
Database
|
Enter the name of the MongoDB database to be connected to.
|
|
Authentication mechanism
|
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.
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 Use 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.
|
|
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. The schema is either Built-In or stored remotely in the Repository.
Click Edit schema to make changes to the schema.
If the current schema is of the Repository type, three
options are available:
-
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.
Click Sync columns to retrieve the schema from
the previous component connected in the Job.
|
|
Execute command
|
Select this check box to enter MongoDB commands in the Command field for execution.
-
Command: in this field,
enter the command to be executed, if this command contains
one single variable.
For example, if you need to construct the
command
You
need simply enter isMaster within quotation marks.
-
Construct command from keys and
values: if the command to be executed
contains multiple variables, select this check box and in
the Command keys and values
table, add the variables and their respective values to be
used.
For example, if you need to construct the following
command
|
|
{ renameCollection : "<source_namespace>" , to : "<target_namespace>" , dropTarget : < true | false > } |
You
need to add three rows to the Command
keys and values table and enter one
variable-value pair to each row within quotation
marks:
|
|
"renameCollection" "old_name" "to" "new_name" "dropTarget" "false" |
-
Construct command from a JSON
string: if you want to directly enter the
command to be used, select this check box and enter this
command in the JSON string
command field that is displayed. Only one
command is allowed per tCosmosDBRow.
For
example:
|
|
"{createIndexes: 'restaurants', indexes : [{key : {restaurant_id: 1}, name: 'id_index_2', unique: true}]}" |
Note that you must use single quotation marks to surround
the string values used in the command and double quotation
marks to surround the command itself.
For further information about the MongoDB commands you can
use in this field, see https://docs.mongodb.org/manual/reference/command/.
|
|
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.
|