Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space FUNCTDEV and version SVC2023.2

...

Scroll Table Layout
widths30%,70%

Hosts

Comma-separated list specifying the host(s) and port(s) of the MongoDB server(s) to query. If empty, the default value will be used. Default is localhost:27017.

Example:

host1:27017,host2:27018,host3:27019

Use SSLSpecifies whether SSL should be used when connecting to the MongoDB server. If empty, the default value will be used. Default is false.
Read Preference

Specifies the preference in which the tool reads operations to the members of a replica set. See the MongoDB documentation for additional information about read preference options. Default is primary.

Authentication Settings

Scroll Table Layout
widths30%,70%

Authentication Mechanism

Specifies the authentication mechanism used to connect to the MongoDB server. The following values are acceptable:

none: Use this value if no authentication mechanism is required.

server-defined: Use this setting to use the default authentication method configured on the mongoDB server (SCRAM-SHA-1 or MONGODB-CR).

LDAP: Use this setting to authenticate using an LDAP service, such as Active Directory or OpenLDAP.

UsernameSpecifies the username with which to authenticate to a MongoDB database that uses authentication.
PasswordSpecifies the password with which to authenticate to a MongoDB database that uses authentication.
Authentication DatabaseSpecifies the authentication database to use. If empty, the default value will be used. This setting is ignored when the authentication mechanism is set to LDAP. Default is admin.

Query Settings

Scroll Table Layout
widths30%,70%

DatabaseSpecifies the name of the MongoDB database to query.
CollectionSpecifies the name of the MongoDB collection to query.
QuerySpecifies the query in the strict mode of the MongoDB Extended JSON language (see the MongoDB Documentation for details). If empty, the default value will be used. Default is all documents.
ProjectionSpecifies the projection in the strict mode of the MongoDB Extended JSON language (see the MongoDB Documentation for details). If empty, the default value will be used. Default is all fields.
SortSpecifies the sort order in which the query returns matching documents in the strict mode of the MongoDB Extended JSON language (see the MongoDB Documentation for details). Only applicable when Operation is set to find. If empty, the default value will be used. Default is unsorted.
LimitSpecifies the maximum number of documents should returned by the query. Only applicable when Operation is set to find. If empty, the default value will be used. Default is 0 (no limit).
SkipSpecifies how may documents, starting from the first, that should be skipped before returning the result of the query. Only applicable when Operation is set to find. If empty, the default value will be used. Default is 0 (nothing skipped).

Update Settings
Anchor
UpdateSettings
UpdateSettings

Scroll Table Layout
widths30%,70%

Operation

Specifies a document handling operation. Options are:

  • find: Enter to find documents in the collection that match the query and return the projection fields.
  • insert: Enter to insert a new document from the Input tab results and return the inserted document.
  • update: Enter to update one or more documents in the collection that match the query with those from the Input tab results, then return counts of how many matched the query and how many were modified. Works in conjunction with Upsert and Multi settings described below.
  • delete: Enter to delete documents that match the query from the collection and return a count of how many were deleted. Works in conjunction with Multi setting described below.

If empty, the default value will be used. Default is Find.

Upsert

Applies only when the Operation setting described above is set to update. Enter True to insert a new document from the Input tab results when no documents match the query. When set to False, will only update existing documents and take no action when no documents match the query. If empty, the default value will be used. Default is False.

Multi

Applies only when the Operation setting described above is set to update or delete. Enter True to update or delete all documents that match the query. When set to False, will update or delete the first document that matches the query only. If empty, the default value will be used. Default is True.

Input Tab
Anchor
InputTab
InputTab

...