@lowdefy/docs 4.0.0-alpha.7 → 4.0.0-alpha.8

package/connections/MongoDB.yaml

@@ -1,581 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: MongoDB
-    pageTitle: MongoDB
-    section: Connections
-    filePath: connections/MongoDB.yaml
-    content:
-      - id: markdown
-        type: MarkdownWithCode
-        properties:
-          content: |
-            MongoDB is a NoSQL database that stores JSON-like documents. These documents are stored in collections, which are like database tables. The fields inside these document can differ from document to document, but generally they are all more or less the same. However documents with different schemas can be stored in the same collection.
-
-            ##### ObjectIds
-
-            MongoDB uses the _id field as the id for a document. This has to be unique for every document in the collection. If no _id is provided when the document is created, a MongoDB [ObjectId](https://docs.mongodb.com/manual/reference/method/ObjectId/) is created for that document. This id includes a timestamp, a random element and an incrementing counter, to ensure it is unique even if multiple ids are created at the same time.
-
-            The _id is often represented as:
-
-            ```js
-            {
-              _id: ObjectId("507f1f77bcf86cd799439011")
-            }
-            ```
-
-            To be able to transmit these ids over JSON network connections, and to use them in Lowdefy apps, Lowdefy serializes these ids as (in YAML):
-            ```yaml
-            _id:
-              _oid: 507f1f77bcf86cd799439011
-            ```
-
-            Ids specified in this way will be treated as ObjectIds by MongoDB requests and mutations.
-
-
-            ## Connections
-
-            Connection types:
-              - MongoDBCollection
-
-            ### MongoDBCollection
-
-            The `MongoDBCollection` connection sets up a connection to a MongoDB deployment. A [connection URI](https://docs.mongodb.com/manual/reference/connection-string/index.html) with authentication credentials (username and password) is required. The URI can be in the standard or dns seedlist (srv) formats. Connections are defined on a collection level, since this allows for read/write access control on a per collection level. Access control can also be managed using the roles in the database.
-
-            >Since the connection URI contains authentication secrets, it should be stored using the [`_secret`](operators/secret.md) operator.
-
-            #### Properties
-            - `databaseUri: string`: __Required__ - Connection uri string for the MongoDb deployment. Should be stored using the [_secret](operators/secret.md) operator.
-            - `databaseName: string`: Default: Database specified in connection string - The name of the database in the MongoDB deployment.
-            - `collection: string`: __Required__ -  The name of the MongoDB collection.
-            - `read: boolean`: Default: `true` - Allow read operations like find on the collection.
-            - `write: boolean`: Default: `false` - Allow write operations like update on the collection.
-            - `options: object`: See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/interfaces/mongoclientoptions.html) for more information.
-
-            #### Examples
-
-            ###### MongoDB collection with reads and writes:
-            ```yaml
-            connections:
-              - id: my_collection
-                type: MongoDBCollection
-                properties:
-                  databaseUri:
-                    _secret: MONGODB_URI
-                  collection: my_collection_name
-                  write: true
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_MONGODB_URI = mongodb+srv://username:password@server.example.com/database
-            ```
-
-            ## Requests
-
-            Request types:
-              - MongoDBAggregation
-              - MongoDBDeleteMany
-              - MongoDBDeleteOne
-              - MongoDBFind
-              - MongoDBFindOne
-              - MongoDBInsertMany
-              - MongoDBInsertOne
-              - MongoDBUpdateMany
-              - MongoDBUpdateOne
-
-
-            ### MongoDBAggregation
-
-            The `MongoDBAggregation` request executes an [aggregation pipeline](https://docs.mongodb.com/manual/core/aggregation-pipeline/) in the collection specified in the connectionId. It returns the array of documents returned by the aggregation. Aggregation pipelines are MongoDB's data processing and aggregation framework. They are based on a series of stages, each of which apply a transformation to the data passed through them, like sorting, grouping or calculating additional fields.
-
-            >Cursors are not supported. The request will return the whole body of the response as an array.
-
-            #### Properties
-            - `pipeline: object[]`: __Required__ - Array containing all the aggregation framework commands for the execution.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#aggregate) for more information. Supported settings are:
-              - `allowDiskUse: boolean`: Default: `false` - Allow disk use on the MongoDB server to store temporary results for the aggregation.
-              - `authdb: string`: Specifies the authentication information to be used.
-              - `batchSize: number`: The number of documents to return per batch.
-              - `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
-              - `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher.
-              - `checkKeys: boolean`: The serializer will check if keys are valid.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `comment: string`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the aggregation. These comments are visible in the MongoDB profile log, making them easier to interpret.
-              - `dbName: string`: The database name.
-              - `explain: boolean`: Specifies to return the information on the processing of the pipeline.
-              - `fullResponse: boolean`: Return the full server response for the command.
-              - `hint: string | object`: Add an index selection hint to an aggregation command.
-              - `ignoreUndefined: boolean`: Default: `true` - Serialize will not emit undefined fields.
-              - `let: object`: Specifies an object with a list of variables. This allows you to improve command readability by separating the variables from the query text.
-              - `maxAwaitTimeMS: number`: The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
-              - `maxTimeMS: number`: Specifies a cumulative time limit in milliseconds for processing operations on the cursor.
-              - `noResponse: boolean`: Admin command option.
-              - `readConcern: object`: Specifies the level of isolation for read operations.
-              - `readPreference: string | object`: The read preference.
-              - `retryWrites: boolean`: Should retry failed writes.
-              - `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
-              - `willRetryWrites: boolean`: Option whether to retry writes.
-              - `writeConcern: object`: An object that expresses the write concern to use with the $out or $merge stage.
-
-            #### Examples
-
-            ###### Calculate average score by region:
-            ```yaml
-            requests:
-              - id: avg_spend_by_region
-                type:  MongoDBAggregation
-                connectionId: my_mongodb_collection_id
-                properties:
-                  pipeline:
-                    - $group:
-                        _id: $region
-                        score:
-                          $avg: $score
-                    - $project:
-                        _id: 0
-                        region: $_id
-                        score: 1
-                    - $sort:
-                        score: 1
-            ```
-
-            ### MongoDBDeleteMany
-
-            The `MongoDBDeleteMany` request deletes multiple documents in the collection specified in the connectionId. It requires a filter, which is written in the query syntax, to select a documents to delete.
-
-            #### Properties
-            - `filter: object`: __Required__ - The filter used to select the document to update.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#deletemany) for more information. Supported settings are:
-              - `authdb: string`: Specifies the authentication information to be used.
-              - `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
-              - `checkKeys: boolean`: Default: `false` - If true, will throw if bson documents start with $ or include a . in any key value.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `comment: string`: A user-provided comment to attach to this command.
-              - `dbName: string`: The database name.
-              - `explain: boolean`: Specifies the verbosity mode for the explain output.
-              - `fullResponse: boolean`: Return the full server response for the command.
-              - `hint: string | object`: An optional hint for query optimization.
-              - `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
-              - `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
-              - `maxTimeMS: number`: Specifies a cumulative time limit in milliseconds for processing operations on the cursor.
-              - `noResponse: boolean`: Admin command option.
-              - `ordered: boolean`: If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails.
-              - `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
-              - `readPreference: string | object`: The read preference.
-              - `retryWrites: boolean`: Should retry failed writes.
-              - `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
-              - `willRetryWrites: boolean`: Option whether to retry writes.
-              - `writeConcern: object`: An object that expresses the write concern.
-
-            #### Examples
-
-            ###### Delete all documents older than a specific date:
-            ```yaml
-            requests:
-              - id: delete_old_documents
-                type:  MongoDBDeleteMany
-                connectionId: my_mongodb_collection_id
-                properties:
-                  filter:
-                    created_date:
-                      $lt:
-                        _date: 2020-01-01
-            ```
-
-            ### MongoDBDeleteOne
-
-            The `MongoDBDeleteOne` request deletes a single document in the collection specified in the connectionId. It requires a filter, which is written in the query syntax, to select a document to delete. It will delete the first document that matches the filter.
-
-            #### Properties
-            - `filter: object`: __Required__ - The filter used to select the document to update.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#deleteone) for more information. Supported settings are:
-              - `authdb: string`: Specifies the authentication information to be used.
-              - `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
-              - `checkKeys: boolean`: Default: `false` - If true, will throw if bson documents start with $ or include a . in any key value.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `comment: string`: A user-provided comment to attach to this command.
-              - `dbName: string`: The database name.
-              - `explain: boolean`: Specifies the verbosity mode for the explain output.
-              - `fullResponse: boolean`: Return the full server response for the command.
-              - `hint: string | object`: An optional hint for query optimization.
-              - `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
-              - `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
-              - `maxTimeMS: number`: Specifies a cumulative time limit in milliseconds for processing operations on the cursor.
-              - `noResponse: boolean`: Admin command option.
-              - `ordered: boolean`: If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails.
-              - `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
-              - `readPreference: string | object`: The read preference.
-              - `retryWrites: boolean`: Should retry failed writes.
-              - `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
-              - `willRetryWrites: boolean`: Option whether to retry writes.
-              - `writeConcern: object`: An object that expresses the write concern.
-
-            #### Examples
-
-            ###### Delete a document by _id:
-            ```yaml
-            requests:
-              - id: delete_selected_document
-                type:  MongoDBUpdateMany
-                connectionId: my_mongodb_collection_id
-                properties:
-                  filter:
-                    _id:
-                      _state: selected_id
-            ```
-
-            ### MongoDBFind
-
-            The `MongoDBFind` request executes a MongoDB [query](https://docs.mongodb.com/manual/tutorial/query-documents/) on the collection specified in the connectionId. It returns the array of documents returned by the query.
-
-            >Cursors are not supported. The request will return the whole body of the response as an array.
-
-            #### Properties
-            - `query: object`: __Required__ - A MongoDB query object.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#find) for more information. Supported settings are:
-              - `allowDiskUse: boolean`: Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
-              - `allowPartialResults: boolean`: For queries against a sharded collection, allows the command (or subsequent getMore commands) to return partial results, rather than an error, if one or more queried shards are available.
-              - `authdb: string`: Specifies the authentication information to be used.
-              - `awaitData: boolean`: Specify if the cursor is a tailable-await cursor. Requires `tailable` to be true.
-              - `batchSize: number`: Set the batchSize for the getMoreCommand when iterating over the query results.
-              - `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
-              - `checkKeys: boolean`: The serializer will check if keys are valid.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `comment: string | object`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
-              - `dbName: string`: The database name.
-              - `explain: boolean`: Specifies the verbosity mode for the explain output.
-              - `fullResponse: boolean`: Return the full server response for the command.
-              - `hint: string | object`: Tell the query to use specific indexes in the query. Object of indexes to use, `{'_id':1}`.
-              - `ignoreUndefined: boolean`: Default: `true` - Serialize will not emit undefined fields.
-              - `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
-              - `limit: number`: Sets the limit of documents returned in the query.
-              - `max: object`: The exclusive upper bound for a specific index.
-              - `maxAwaitTimeMS: number`: The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Requires `tailable` and `awaitData` to be true.
-              - `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
-              - `min: object`: The inclusive lower bound for a specific index.
-              - `noCursorTimeout: boolean`: The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
-              - `noResponse: boolean`: Admin command option.
-              - `projection: object`: The fields to return in the query. Object of fields to either include or exclude (one of, not both), `{'a':1, 'b': 1}` or `{'a': 0, 'b': 0}`.
-              - `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
-              - `readPreference: string | object`: The preferred read preference.
-              - `retryWrites: boolean`: Should retry failed writes.
-              - `returnKey: boolean`: If true, returns only the index keys in the resulting documents.
-              - `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
-              - `showRecordId: boolean`: Determine whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
-              - `singleBatch: boolean`: Default: `false` - Determines whether to close the cursor after the first batch.
-              - `skip: number`: Set to skip N documents ahead in your query (useful for pagination).
-              - `sort: array | object`: Set to sort the documents coming back from the query.
-              - `tailable: boolean`: Specify if the cursor is tailable.
-              - `timeout: boolean`: Specify if the cursor can timeout.
-              - `willRetryWrites: boolean`: Option whether to retry writes.
-              - `writeConcern: object`: An object that expresses the write concern.
-
-            #### Examples
-
-            ###### Find top ten scores above 90:
-            ```yaml
-            requests:
-              - id: scores_top_ten_scores_above_90
-                type:  MongoDBFind
-                connectionId: my_mongodb_collection_id
-                properties:
-                  query:
-                    score:
-                      $gt: 90
-                  options:
-                    sort:
-                      - - score
-                        - -1
-                    limit: 10
-                    projection:
-                      score: 1
-                      name: 1
-            ```
-
-            ### MongoDBFindOne
-
-            The `MongoDBFindOne` request executes a MongoDB [query](https://docs.mongodb.com/manual/tutorial/query-documents/) on the collection specified in the connectionId. It returns the first document that matches the specified query.
-
-            >Cursors are not supported. The request will return the whole body of the response as an array.
-
-            #### Properties
-            - `query: object`: __Required__ - A MongoDB query object.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#findone) for more information. Supported settings are:
-              - `allowDiskUse: boolean`: Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
-              - `allowPartialResults: boolean`: For queries against a sharded collection, allows the command (or subsequent getMore commands) to return partial results, rather than an error, if one or more queried shards are available.
-              - `authdb: string`: Specifies the authentication information to be used.
-              - `awaitData: boolean`: Specify if the cursor is a tailable-await cursor. Requires `tailable` to be true.
-              - `batchSize: number`: Set the batchSize for the getMoreCommand when iterating over the query results.
-              - `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
-              - `checkKeys: boolean`: The serializer will check if keys are valid.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `comment: string | object`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
-              - `dbName: string`: The database name.
-              - `explain: boolean`: Specifies the verbosity mode for the explain output.
-              - `fullResponse: boolean`: Return the full server response for the command.
-              - `hint: string | object`: Tell the query to use specific indexes in the query. Object of indexes to use, `{'_id':1}`.
-              - `ignoreUndefined: boolean`: Default: `true` - Serialize will not emit undefined fields.
-              - `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
-              - `limit: number`: Sets the limit of documents returned in the query.
-              - `max: object`: The exclusive upper bound for a specific index.
-              - `maxAwaitTimeMS: number`: The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Requires `tailable` and `awaitData` to be true.
-              - `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
-              - `min: object`: The inclusive lower bound for a specific index.
-              - `noCursorTimeout: boolean`: The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
-              - `noResponse: boolean`: Admin command option.
-              - `projection: object`: The fields to return in the query. Object of fields to either include or exclude (one of, not both), `{'a':1, 'b': 1}` or `{'a': 0, 'b': 0}`.
-              - `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
-              - `readPreference: string | object`: The preferred read preference.
-              - `retryWrites: boolean`: Should retry failed writes.
-              - `returnKey: boolean`: If true, returns only the index keys in the resulting documents.
-              - `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
-              - `showRecordId: boolean`: Determine whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents.
-              - `singleBatch: boolean`: Default: `false` - Determines whether to close the cursor after the first batch.
-              - `skip: number`: Set to skip N documents ahead in your query (useful for pagination).
-              - `sort: array | object`: Set to sort the documents coming back from the query.
-              - `tailable: boolean`: Specify if the cursor is tailable.
-              - `timeout: boolean`: Specify if the cursor can timeout.
-              - `willRetryWrites: boolean`: Option whether to retry writes.
-              - `writeConcern: object`: An object that expresses the write concern.
-
-            #### Examples
-
-            ###### Find a document by id:
-            ```yaml
-            requests:
-              - id: find_by_id
-                type:  MongoDBFindOne
-                connectionId: my_mongodb_collection_id
-                properties:
-                  query:
-                    _id:
-                      _input: _id
-            ```
-
-            ### MongoDBInsertMany
-
-            The `MongoDBInsertMany` request inserts an array of documents into the collection specified in the connectionId. If a `_id` field is not specified on a document, a MongoDB `ObjectID` will be generated.
-
-            #### Properties
-            - `docs: object[]`: __Required__ - The array of documents to be inserted.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#insertmany) for more information. Supported settings are:
-              - `authdb: string`: Specifies the authentication information to be used.
-              - `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
-              - `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher
-              - `checkKeys: boolean`: Default: `true` - If true, will throw if bson documents start with $ or include a . in any key value.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `comment: string | object`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
-              - `dbName: string`: The database name.
-              - `explain: object`: Specifies the verbosity mode for the explain output.
-              - `forcesServerObjectId: boolean`: Default: `false` - Force server to assign _id values instead of driver.
-              - `fullResponse: boolean`: Return the full server response for the command.
-              - `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
-              - `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
-              - `noResponse: boolean`: Admin command option.
-              - `ordered: boolean`: If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails.
-              - `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
-              - `readPreference: object`: The preferred read preference.
-              - `retryWrites: boolean`: Should retry failed writes.
-              - `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
-              - `willRetryWrites: boolean`: Option whether to retry writes.
-              - `writeConcern: object`: An object that expresses the write concern.
-
-            #### Examples
-
-            ###### Insert a set of documents:
-            ```yaml
-            requests:
-              - id: insert_documents
-                type:  MongoDBInsertMany
-                connectionId: my_mongodb_collection_id
-                properties:
-                  docs:
-                    - _id: 1
-                      value: 4
-                    - _id: 2
-                      value: 1
-                    - _id: 3
-                      value: 7
-
-            ```
-
-            ### MongoDBInsertOne
-
-            The `MongoDBInsertOne` request inserts a document into the collection specified in the connectionId. If a `_id` field is not specified, a MongoDB `ObjectID` will be generated.
-
-            #### Properties
-            - `doc: object`: __Required__ - The document to be inserted.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#insertone) for more information. Supported settings are:
-              - `authdb: string`: Specifies the authentication information to be used.
-              - `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
-              - `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher
-              - `checkKeys: boolean`: Default: `true` - If true, will throw if bson documents start with $ or include a . in any key value.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `comment: string | object`: Add a [comment](https://docs.mongodb.com/manual/reference/operator/query/comment/index.html) to the query. These comments are visible in the MongoDB profile log, making them easier to interpret.
-              - `dbName: string`: The database name.
-              - `explain: object`: Specifies the verbosity mode for the explain output.
-              - `forcesServerObjectId: boolean`: Default: `false` - Force server to assign _id values instead of driver.
-              - `fullResponse: boolean`: Return the full server response for the command.
-              - `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
-              - `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
-              - `noResponse: boolean`: Admin command option.
-              - `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
-              - `readPreference: object`: The preferred read preference.
-              - `retryWrites: boolean`: Should retry failed writes.
-              - `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
-              - `willRetryWrites: boolean`: Option whether to retry writes.
-              - `writeConcern: object`: An object that expresses the write concern.
-
-            #### Examples
-
-            ###### Insert a document:
-            ```yaml
-            requests:
-              - id: insert_new_comment
-                type:  MongoDBInsertOne
-                connectionId: my_mongodb_collection_id
-                properties:
-                  doc:
-                    comment:
-                      _state: comment_input
-                    user_id:
-                      _user: id
-                    timestamp:
-                      _date: now
-            ```
-
-            ### MongoDBUpdateMany
-
-            The `MongoDBUpdateMany` request updates multiple documents that match a certain criteria in the collection specified in the connectionId. It requires a filter, which is written in the query syntax, to select the documents to update.
-
-            #### Properties
-            - `filter: object`: __Required__ - The filter used to select the document to update.
-            - `update: object | object[]`: __Required__ - The update operations to be applied to the document.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/3.3/api/Collection.html#updateOne) for more information. Supported settings are:
-              - `arrayFilters: string[]`: Array filters for the [`$[<identifier>]`](https://docs.mongodb.com/manual/reference/operator/update/positional-filtered/) array update operator.
-              - `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher.
-              - `checkKeys: boolean`: Default: `false` - If true, will throw if bson documents start with $ or include a . in any key value.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `forceServerObjectId: boolean`: Force server to assign _id values instead of driver.
-              - `hint: object`: An optional hint for query optimization.
-              - `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
-              - `j: boolean`: Specify a journal write concern.
-              - `upsert: boolean`: Default: `false` - Insert document if no match is found.
-              - `w: number | string`: The write concern.
-              - `wtimeout: number`: The write concern timeout.
-
-            #### Examples
-
-            ###### Set a list of documents as resolved:
-            ```yaml
-            requests:
-              - id: set_resolved
-                type:  MongoDBUpdateMany
-                connectionId: my_mongodb_collection_id
-                properties:
-                  # Select all documents where the _id is in selected_issues_list in state
-                  filter:
-                    _id:
-                      $in:
-                        _state: selected_issues_list
-                  update:
-                    $set:
-                      resolved: true
-            ```
-
-            ###### Mark all documents with score less than 6 as urgent:
-            ```yaml
-            requests:
-              - id: set_resolved
-                type:  MongoDBUpdateMany
-                properties:
-                  filter:
-                    score:
-                      $lt: 6
-                  update:
-                    $set:
-                      status: urgent
-            ```
-
-            ### MongoDBUpdateOne
-
-            The `MongoDBUpdateOne` request updates a single document in the collection specified in the connectionId. It requires a filter, which is written in the query syntax, to select a document to update. It will update the first document that matches the filter. If the `upsert` option is set to true, it will insert a new document if no document is found to update.
-
-            #### Properties
-            - `filter: object`: __Required__ - The filter used to select the document to update.
-            - `update: object | object[]`: __Required__ - The update operations to be applied to the document.
-            - `options: object`: Optional settings. See the [driver docs](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#updateone) for more information. Supported settings are:
-              - `arrayFilters: object[]`: _Array_ - Array filters for the [`$[<identifier>]`](https://docs.mongodb.com/manual/reference/operator/update/positional-filtered/) array update operator.
-              - `authdb: string`: Specifies the authentication information to be used.
-              - `bsonRegExp: boolean`: Return the BSON regular expressions as BSONRegExp instances.
-              - `bypassDocumentValidation: boolean`: Default: `false` - Allow driver to bypass schema validation in MongoDB 3.2 or higher.
-              - `checkKeys: boolean`: Default: `false` - If true, will throw if bson documents start with $ or include a . in any key value.
-              - `collation: object`: Specify collation (MongoDB 3.4 or higher) settings for update operation.
-              - `comment: string | object`: A user-provided comment to attach to this command.
-              - `dbName: string`: The database name.
-              - `explain: object`: Specifies the verbosity mode for the explain output.
-              - `fullResponse: boolean`: Return the full server response for the command.
-              - `hint: string | object`: An optional hint for query optimization.
-              - `ignoreUndefined: boolean`: Default: `false` - Specify if the BSON serializer should ignore undefined fields.
-              - `let: object`: Map of parameter names and values that can be accessed using `$$var` (requires MongoDB 5.0).
-              - `maxTimeMS: number`: Number of milliseconds to wait before aborting the command.
-              - `noResponse: boolean`: Admin command option.
-              - `readConcern: object`: Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported).
-              - `readPreference: object`: The preferred read preference.
-              - `retryWrites: boolean`: Should retry failed writes.
-              - `serializeFunctions: boolean`: Default: `false` - Serialize the javascript functions.
-              - `upsert: boolean`: Default: `false` - Insert document if no match is found.
-              - `willRetryWrites: boolean`: Option whether to retry writes.
-              - `writeConcern: object`: An object that expresses the write concern.
-
-            #### Examples
-
-            ###### Update a document:
-            ```yaml
-            requests:
-              - id: update
-                type:  MongoDBUpdateOne
-                connectionId: my_mongodb_collection_id
-                properties:
-                  filter:
-                    _id:
-                      _state: _id
-                  update:
-                    $set:
-                      _state: true
-            ```
-
-            Like a comment:
-            ```yaml
-            requests:
-              - id: like_comment
-                type:  MongoDBUpdateOne
-                connectionId: my_mongodb_collection_id
-                properties:
-                  filter:
-                    _id:
-                      _state: comments.$_id
-                  update:
-                    $inc:
-                      likes: 1
-                    $push:
-                      liked_by:
-                        _user.id:
-                    $set:
-                      last_liked:
-                        _date: now
-            ```