@lowdefy/connection-mongodb 0.0.0-experimental-20251010122007 → 0.0.0-experimental-20251015143743

package/dist/connections/MongoDBCollection/MongoDBBulkWrite/documentation.md

@@ -1,359 +0,0 @@
-<TITLE>
-MongoDBBulkWrite
-</TITLE>
-
-<DESCRIPTION>
-
-The `MongoDBBulkWrite` request executes [bulkWrite operations](https://www.mongodb.com/docs/manual/reference/method/db.collection.bulkWrite/#write-operations) in the collection specified in the connectionId.
-
-### Properties
-
-- `operations: object[]`: __Required__ - Array containing all the bulkWrite operations for the execution.
-  - `insertOne: object`:
-    - `document: object`: The document to be inserted.
-  - `deleteOne: object`:
-    - `filter: object`: __Required__ - The filter used to select the document to delete.
-    - `collation: object`: Specify collation settings for update operation.
-  - `deleteMany: object`:
-    - `filter: object`: __Required__ - The filter used to select the documents to delete.
-    - `collation: object`: Specify collation settings for update operation.
-  - `updateOne: object`:
-    - `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.
-    - `upsert: object`: Insert document if no match is found.
-    - `arrayFilters: string[]`: Array filters for the [`$[<identifier>]`](https://docs.mongodb.com/manual/reference/operator/update/positional-filtered/) array update operator.
-    - `collation: object`: Specify collation settings for update operation.
-    - `hint: object | string`: 'An optional hint for query optimization.'
-  - `updateMany: object`:
-    - `filter: object`: __Required__ - The filter used to select the documents to update.
-    - `update: object | object[]`: __Required__ - The update operations to be applied to the documents.
-    - `upsert: object`: Insert document if no match is found.
-    - `arrayFilters: string[]`: Array filters for the [`$[<identifier>]`](https://docs.mongodb.com/manual/reference/operator/update/positional-filtered/) array update operator.
-    - `collation: object`: Specify collation settings for update operation.
-    - `hint: object | string`: An optional hint for query optimization.
-  - `replaceOne: object`:
-    - `filter: object`: __Required__ - The filter used to select the document to replace.
-    - `replacement: object`: __Required__ - The document to be inserted.
-    - `upsert: object`: Insert document if no match is found.
-    - `collation: object`: Specify collation settings for update operation.
-    - `hint: object | string`: An optional hint for query optimization.
-- `options: object`: Optional settings. See the [driver documentation](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#aggregate) for more information. Supported settings are:
-  - `ordered: boolean`: Default: `true` - A boolean specifying whether the mongod instance should perform an ordered or unordered operation execution.
-  - `writeConcern: object`: An object that expresses the write concern to use.
-
-</DESCRIPTION>
-
-<CONNECTION>
-MongoDBCollection
-</CONNECTION>
-
-<SCHEMA>
-
-```js
-export default {
-  $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Lowdefy Request Schema - MongoDBBulkWrite',
-  type: 'object',
-  required: ['operations'],
-  errorMessage: {
-    type: 'MongoDBBulkWrite request properties should be an object.',
-    required: 'MongoDBBulkWrite request should have required property "operations".',
-  },
-  properties: {
-    operations: {
-      type: 'array',
-      description: 'Array containing all the write operations for the execution.',
-      errorMessage: {
-        type: 'MongoDBBulkWrite request property "operations" should be an array.',
-      },
-      items: {
-        type: 'object',
-        errorMessage: {
-          type: 'MongoDBBulkWrite request property "operations" should be an array of write operation objects.',
-          additionalProperties: 'MongoDBBulkWrite operation should be a write operation.',
-          maxProperties: 'MongoDBBulkWrite operation should be a write operation.',
-        },
-        additionalProperties: false,
-        maxProperties: 1,
-        properties: {
-          insertOne: {
-            type: 'object',
-            required: ['document'],
-            errorMessage: {
-              type: 'insertOne operation should be an object.',
-              required: 'insertOne operation should have required property "document".',
-            },
-            properties: {
-              document: {
-                type: 'object',
-                description: 'The document to be inserted.',
-                errorMessage: {
-                  type: 'insertOne operation property "document" should be an object.',
-                },
-              },
-            },
-          },
-          updateOne: {
-            type: 'object',
-            required: ['filter', 'update'],
-            errorMessage: {
-              type: 'updateOne operation should be an object.',
-              required: {
-                filter: 'updateOne operation should have required property "filter".',
-                update: 'updateOne operation should have required property "update".',
-              },
-            },
-            properties: {
-              filter: {
-                type: 'object',
-                description: 'The filter used to select the document to update.',
-                errorMessage: {
-                  type: 'updateOne operation property "filter" should be an object.',
-                },
-              },
-              update: {
-                type: ['object', 'array'],
-                description: 'The update operations to be applied to the document.',
-                errorMessage: {
-                  type: 'updateOne operation property "update" should be an object or an array.',
-                },
-              },
-              upsert: {
-                type: 'boolean',
-                description: 'Insert document if no match is found.',
-                errorMessage: {
-                  type: 'updateOne operation property "upsert" should be a boolean.',
-                },
-              },
-              arrayFilters: {
-                type: 'array',
-                description: 'Array filters for the `$[<identifier>]` array update operator.',
-                errorMessage: {
-                  type: 'updateOne operation property "arrayFilters" should be an array.',
-                },
-              },
-              collation: {
-                type: 'object',
-                description: 'Specify collation settings for update operation.',
-                errorMessage: {
-                  type: 'updateOne operation property "collation" should be an object.',
-                },
-              },
-              hint: {
-                type: ['object', 'string'],
-                description: 'An optional hint for query optimization.',
-                errorMessage: {
-                  type: 'updateOne operation property "hint" should be an object or a string.',
-                },
-              },
-            },
-          },
-          updateMany: {
-            type: 'object',
-            required: ['filter', 'update'],
-            errorMessage: {
-              type: 'updateMany operation should be an object.',
-              required: {
-                filter: 'updateMany operation should have required property "filter".',
-                update: 'updateMany operation should have required property "update".',
-              },
-            },
-            properties: {
-              filter: {
-                type: 'object',
-                description: 'The filter used to select the documents to update.',
-                errorMessage: {
-                  type: 'updateMany operation property "filter" should be an object.',
-                },
-              },
-              update: {
-                type: ['object', 'array'],
-                description: 'The update operations to be applied to the document.',
-                errorMessage: {
-                  type: 'updateMany operation property "update" should be an object or an array.',
-                },
-              },
-              upsert: {
-                type: 'boolean',
-                description: 'Insert document if no match is found.',
-                errorMessage: {
-                  type: 'updateMany operation property "upsert" should be a boolean.',
-                },
-              },
-              arrayFilters: {
-                type: 'array',
-                description: 'Array filters for the `$[<identifier>]` array update operator.',
-                errorMessage: {
-                  type: 'updateMany operation property "arrayFilters" should be an array.',
-                },
-              },
-              collation: {
-                type: 'object',
-                description: 'Specify collation settings for update operation.',
-                errorMessage: {
-                  type: 'updateMany operation property "collation" should be an object.',
-                },
-              },
-              hint: {
-                type: ['object', 'string'],
-                description: 'An optional hint for query optimization.',
-                errorMessage: {
-                  type: 'updateMany operation property "hint" should be an object or a string.',
-                },
-              },
-            },
-          },
-          deleteOne: {
-            type: 'object',
-            required: ['filter'],
-            errorMessage: {
-              type: 'deleteOne operation should be an object.',
-              required: 'deleteOne operation should have required property "filter".',
-            },
-            properties: {
-              filter: {
-                type: 'object',
-                description: 'The filter used to select the document to update.',
-                errorMessage: {
-                  type: 'deleteOne operation property "filter" should be an object.',
-                },
-              },
-              collation: {
-                type: 'object',
-                description: 'Specify collation settings for update operation.',
-                errorMessage: {
-                  type: 'deleteOne operation property "collation" should be an object.',
-                },
-              },
-            },
-          },
-          deleteMany: {
-            type: 'object',
-            required: ['filter'],
-            errorMessage: {
-              type: 'deleteMany operation should be an object.',
-              required: 'deleteMany operation should have required property "filter".',
-            },
-            properties: {
-              filter: {
-                type: 'object',
-                description: 'The filter used to select the documents to delete.',
-                errorMessage: {
-                  type: 'deleteMany operation property "filter" should be an object.',
-                },
-              },
-              collation: {
-                type: 'object',
-                description: 'Specify collation settings for update operation.',
-                errorMessage: {
-                  type: 'deleteMany operation property "collation" should be an object.',
-                },
-              },
-            },
-          },
-          replaceOne: {
-            type: 'object',
-            required: ['filter', 'replacement'],
-            errorMessage: {
-              type: 'replaceOne operation should be an object.',
-              required: {
-                filter: 'replaceOne operation should have required property "filter".',
-                replacement: 'replaceOne operation should have required property "replacement".',
-              },
-            },
-            properties: {
-              filter: {
-                type: 'object',
-                description: 'The filter used to select the documents to update.',
-                errorMessage: {
-                  type: 'replaceOne operation property "filter" should be an object.',
-                },
-              },
-              replacement: {
-                type: 'object',
-                description: 'The document to be inserted.',
-                errorMessage: {
-                  type: 'replaceOne operation property "replacement" should be an object.',
-                },
-              },
-              upsert: {
-                type: 'boolean',
-                description: 'Insert document if no match is found.',
-                errorMessage: {
-                  type: 'replaceOne operation property "upsert" should be a boolean.',
-                },
-              },
-              collation: {
-                type: 'object',
-                description: 'Specify collation settings for update operation.',
-                errorMessage: {
-                  type: 'replaceOne operation property "collation" should be an object.',
-                },
-              },
-              hint: {
-                type: ['object', 'string'],
-                description: 'An optional hint for query optimization.',
-                errorMessage: {
-                  type: 'replaceOne operation property "hint" should be an object or a string.',
-                },
-              },
-            },
-          },
-        },
-      },
-    },
-    options: {
-      type: 'object',
-      description: 'Optional settings.',
-      errorMessage: {
-        type: 'MongoDBBulkWrite request property "options" should be an object.',
-      },
-    },
-  },
-};
-```
-
-</SCHEMA>
-
-<EXAMPLES>
-
-### Update pizzas
-
-```yaml
-requests:
-  - id: update_pizzas
-    type: MongoDBBulkWrite
-    connectionId: my_mongodb_collection_id
-    properties:
-      operations:
-        - insertOne:
-            document:
-              _id: 3
-              type: "beef"
-              size: "medium"
-              price: 6
-        - insertOne:
-            document:
-              _id: 4
-              type: "sausage"
-              size: "large"
-              price: 10
-        - updateOne:
-            filter:
-              type: "cheese"
-              update:
-                $set:
-                  price: 8
-        - deleteOne:
-            filter:
-              type: "pepperoni"
-        - replaceOne:
-            filter:
-              type: "vegan"
-            replacement:
-              type: "tofu"
-              size: "small"
-              price: 4
-```
-
-</EXAMPLES>

package/dist/connections/MongoDBCollection/MongoDBDeleteMany/documentation.md

@@ -1,89 +0,0 @@
-<TITLE>
-MongoDBDeleteMany
-</TITLE>
-
-<DESCRIPTION>
-
-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 documentation](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.
-
-</DESCRIPTION>
-
-<CONNECTION>
-MongoDBCollection
-</CONNECTION>
-
-<SCHEMA>
-
-```js
-export default {
-  $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Lowdefy Request Schema - MongoDBDeleteMany',
-  type: 'object',
-  required: ['filter'],
-  properties: {
-    filter: {
-      type: 'object',
-      description: 'The filter used to select the document to update.',
-      errorMessage: {
-        type: 'MongoDBDeleteMany request property "filter" should be an object.',
-      },
-    },
-    options: {
-      type: 'object',
-      description: 'Optional settings.',
-      errorMessage: {
-        type: 'MongoDBDeleteMany request property "options" should be an object.',
-      },
-    },
-  },
-  errorMessage: {
-    type: 'MongoDBDeleteMany request properties should be an object.',
-    required: 'MongoDBDeleteMany request should have required property "filter".',
-  },
-};
-```
-
-</SCHEMA>
-
-<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
-```
-
-</EXAMPLES>

package/dist/connections/MongoDBCollection/MongoDBDeleteOne/documentation.md

@@ -1,92 +0,0 @@
-<TITLE>
-MongoDBDeleteOne
-</TITLE>
-
-<DESCRIPTION>
-
-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.
-> MongoDBDeleteOne response differs when the connection has a log collection. When a log collection is set on the connection, a findOneAndDelete operation is performed compared to the standard deleteOne operation.
-
-### Properties
-
-- `filter: object`: __Required__ - The filter used to select the document to update.
-- `options: object`: Optional settings. See the [driver documentation](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.
-
-</DESCRIPTION>
-
-<CONNECTION>
-MongoDBCollection
-</CONNECTION>
-
-<SCHEMA>
-
-```js
-export default {
-  $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Lowdefy Request Schema - MongoDBDeleteOne',
-  type: 'object',
-  required: ['filter'],
-  properties: {
-    filter: {
-      type: 'object',
-      description: 'The filter used to select the document to update.',
-      errorMessage: {
-        type: 'MongoDBDeleteOne request property "filter" should be an object.',
-      },
-    },
-    options: {
-      type: 'object',
-      description: 'Optional settings.',
-      errorMessage: {
-        type: 'MongoDBDeleteOne request property "options" should be an object.',
-      },
-    },
-  },
-  errorMessage: {
-    type: 'MongoDBDeleteOne request properties should be an object.',
-    required: 'MongoDBDeleteOne request should have required property "filter".',
-  },
-};
-```
-
-</SCHEMA>
-
-<EXAMPLES>
-
-### Delete a document by _id
-
-```yaml
-requests:
-  - id: delete_selected_document
-    type:  MongoDBDeleteOne
-    connectionId: my_mongodb_collection_id
-    payload:
-      selected_id
-        _state: selected_id
-    properties:
-      filter:
-        _id:
-          _payload: selected_id
-```
-
-</EXAMPLES>

package/dist/connections/MongoDBCollection/MongoDBFind/documentation.md

@@ -1,114 +0,0 @@
-<TITLE>
-MongoDBFind
-</TITLE>
-
-<DESCRIPTION>
-
-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 documentation](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.
-
-</DESCRIPTION>
-
-<CONNECTION>
-MongoDBCollection
-</CONNECTION>
-
-<SCHEMA>
-
-```js
-export default {
-  $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Lowdefy Request Schema - MongoDBFind',
-  type: 'object',
-  required: ['query'],
-  properties: {
-    query: {
-      type: 'object',
-      description: 'A MongoDB query object',
-      errorMessage: {
-        type: 'MongoDBFind request property "query" should be an object.',
-      },
-    },
-    options: {
-      type: 'object',
-      description: 'Optional settings.',
-      errorMessage: {
-        type: 'MongoDBFind request property "options" should be an object.',
-      },
-    },
-  },
-  errorMessage: {
-    type: 'MongoDBFind request properties should be an object.',
-    required: 'MongoDBFind request should have required property "query".',
-  },
-};
-```
-
-</SCHEMA>
-
-<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
-```
-
-</EXAMPLES>