@webda/mongo 4.0.0-beta.2 → 4.0.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +118 -0
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +1 -1
- package/lib/index.js.map +1 -1
- package/lib/mongodb.service.d.ts +175 -0
- package/lib/mongodb.service.d.ts.map +1 -0
- package/lib/mongodb.service.js +474 -0
- package/lib/mongodb.service.js.map +1 -0
- package/package.json +29 -35
- package/test/config.json +5 -0
- package/webda.module.json +353 -396
- package/lib/mongodb.d.ts +0 -133
- package/lib/mongodb.d.ts.map +0 -1
- package/lib/mongodb.js +0 -359
- package/lib/mongodb.js.map +0 -1
- package/lib/mongodb.spec.d.ts +0 -2
- package/lib/mongodb.spec.d.ts.map +0 -1
- package/lib/mongodb.spec.js +0 -38
- package/lib/mongodb.spec.js.map +0 -1
package/webda.module.json
CHANGED
|
@@ -1,46 +1,369 @@
|
|
|
1
1
|
{
|
|
2
|
+
"$schema": "https://webda.io/schemas/webda.module.v4.json",
|
|
2
3
|
"beans": {},
|
|
3
4
|
"deployers": {},
|
|
4
5
|
"moddas": {
|
|
5
|
-
"Webda/MongoStore":
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
6
|
+
"Webda/MongoStore": {
|
|
7
|
+
"Import": "lib/mongodb.service:MongoStore",
|
|
8
|
+
"Schema": {
|
|
9
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
10
|
+
"additionalProperties": false,
|
|
11
|
+
"definitions": {
|
|
12
|
+
"DbOptions": {
|
|
13
|
+
"additionalProperties": false,
|
|
14
|
+
"properties": {
|
|
15
|
+
"authSource": {
|
|
16
|
+
"description": "If the database authentication is dependent on another databaseName.",
|
|
17
|
+
"type": "string"
|
|
18
|
+
},
|
|
19
|
+
"bsonRegExp": {
|
|
20
|
+
"default": false,
|
|
21
|
+
"defaultValue": "`false`",
|
|
22
|
+
"description": "return BSON regular expressions as BSONRegExp instances.",
|
|
23
|
+
"type": "boolean"
|
|
24
|
+
},
|
|
25
|
+
"checkKeys": {
|
|
26
|
+
"default": false,
|
|
27
|
+
"defaultValue": "`false`",
|
|
28
|
+
"description": "the serializer will check if keys are valid.",
|
|
29
|
+
"type": "boolean"
|
|
30
|
+
},
|
|
31
|
+
"enableUtf8Validation": {
|
|
32
|
+
"default": false,
|
|
33
|
+
"description": "Enable utf8 validation when deserializing BSON documents. Defaults to true.",
|
|
34
|
+
"type": "boolean"
|
|
35
|
+
},
|
|
36
|
+
"fieldsAsRaw": {
|
|
37
|
+
"$ref": "#/definitions/Document",
|
|
38
|
+
"defaultValue": "`null`",
|
|
39
|
+
"description": "allow to specify if there what fields we wish to return as unserialized raw buffer."
|
|
40
|
+
},
|
|
41
|
+
"forceServerObjectId": {
|
|
42
|
+
"default": false,
|
|
43
|
+
"description": "Force server to assign _id values instead of driver.",
|
|
44
|
+
"type": "boolean"
|
|
45
|
+
},
|
|
46
|
+
"ignoreUndefined": {
|
|
47
|
+
"default": false,
|
|
48
|
+
"defaultValue": "`true`",
|
|
49
|
+
"description": "serialize will not emit undefined fields\nnote that the driver sets this to `false`",
|
|
50
|
+
"type": "boolean"
|
|
51
|
+
},
|
|
52
|
+
"pkFactory": {
|
|
53
|
+
"$ref": "#/definitions/PkFactory",
|
|
54
|
+
"description": "A primary key factory object for generation of custom _id keys."
|
|
55
|
+
},
|
|
56
|
+
"promoteBuffers": {
|
|
57
|
+
"default": false,
|
|
58
|
+
"defaultValue": "`false`",
|
|
59
|
+
"description": "when deserializing a Binary will return it as a node.js Buffer instance.",
|
|
60
|
+
"type": "boolean"
|
|
61
|
+
},
|
|
62
|
+
"promoteLongs": {
|
|
63
|
+
"default": false,
|
|
64
|
+
"defaultValue": "`true`",
|
|
65
|
+
"description": "when deserializing a Long will fit it into a Number if it's smaller than 53 bits.",
|
|
66
|
+
"type": "boolean"
|
|
67
|
+
},
|
|
68
|
+
"promoteValues": {
|
|
69
|
+
"default": false,
|
|
70
|
+
"defaultValue": "`true`",
|
|
71
|
+
"description": "when deserializing will promote BSON values to their Node.js closest equivalent types.",
|
|
72
|
+
"type": "boolean"
|
|
73
|
+
},
|
|
74
|
+
"raw": {
|
|
75
|
+
"default": false,
|
|
76
|
+
"description": "Enabling the raw option will return a [Node.js Buffer](https://nodejs.org/api/buffer.html)\nwhich is allocated using [allocUnsafe API](https://nodejs.org/api/buffer.html#static-method-bufferallocunsafesize).\nSee this section from the [Node.js Docs here](https://nodejs.org/api/buffer.html#what-makes-bufferallocunsafe-and-bufferallocunsafeslow-unsafe)\nfor more detail about what \"unsafe\" refers to in this context.\nIf you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate\nyour own buffer and clone the contents:",
|
|
77
|
+
"example": "```ts\nconst raw = await collection.findOne({}, { raw: true });\nconst myBuffer = Buffer.alloc(raw.byteLength);\nmyBuffer.set(raw, 0);\n// Only save and use `myBuffer` beyond this point\n```",
|
|
78
|
+
"remarks": "Please note there is a known limitation where this option cannot be used at the MongoClient level (see [NODE-3946](https://jira.mongodb.org/browse/NODE-3946)).\nIt does correctly work at `Db`, `Collection`, and per operation the same as other BSON options work.",
|
|
79
|
+
"type": "boolean"
|
|
80
|
+
},
|
|
81
|
+
"readConcern": {
|
|
82
|
+
"$ref": "#/definitions/Document",
|
|
83
|
+
"description": "Specify a read concern for the collection. (only MongoDB 3.2 or higher supported)"
|
|
84
|
+
},
|
|
85
|
+
"readPreference": {
|
|
86
|
+
"anyOf": [
|
|
87
|
+
{
|
|
88
|
+
"$ref": "#/definitions/Document"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"const": "primary",
|
|
92
|
+
"type": "string"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"const": "primaryPreferred",
|
|
96
|
+
"type": "string"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"const": "secondary",
|
|
100
|
+
"type": "string"
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"const": "secondaryPreferred",
|
|
104
|
+
"type": "string"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"const": "nearest",
|
|
108
|
+
"type": "string"
|
|
109
|
+
}
|
|
110
|
+
],
|
|
111
|
+
"description": "The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).",
|
|
112
|
+
"public": true
|
|
113
|
+
},
|
|
114
|
+
"retryWrites": {
|
|
115
|
+
"default": false,
|
|
116
|
+
"description": "Should retry failed writes",
|
|
117
|
+
"type": "boolean"
|
|
118
|
+
},
|
|
119
|
+
"serializeFunctions": {
|
|
120
|
+
"default": false,
|
|
121
|
+
"defaultValue": "`false`",
|
|
122
|
+
"description": "serialize the javascript functions",
|
|
123
|
+
"type": "boolean"
|
|
124
|
+
},
|
|
125
|
+
"timeoutMS": {
|
|
126
|
+
"experimental": "Specifies the time an operation will run until it throws a timeout error",
|
|
127
|
+
"type": "number"
|
|
128
|
+
},
|
|
129
|
+
"useBigInt64": {
|
|
130
|
+
"default": false,
|
|
131
|
+
"defaultValue": "`false`",
|
|
132
|
+
"description": "when deserializing a Long return as a BigInt.",
|
|
133
|
+
"type": "boolean"
|
|
134
|
+
},
|
|
135
|
+
"writeConcern": {
|
|
136
|
+
"anyOf": [
|
|
137
|
+
{
|
|
138
|
+
"$ref": "#/definitions/WriteConcern"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"$ref": "#/definitions/WriteConcernSettings"
|
|
142
|
+
}
|
|
143
|
+
],
|
|
144
|
+
"description": "Write Concern as an object"
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
"public": true,
|
|
148
|
+
"type": "object"
|
|
149
|
+
},
|
|
150
|
+
"Document": {
|
|
151
|
+
"additionalProperties": {},
|
|
152
|
+
"public": true,
|
|
153
|
+
"type": "object"
|
|
154
|
+
},
|
|
155
|
+
"PkFactory": {
|
|
156
|
+
"additionalProperties": false,
|
|
157
|
+
"public": true,
|
|
158
|
+
"type": "object"
|
|
159
|
+
},
|
|
160
|
+
"WriteConcern": {
|
|
161
|
+
"additionalProperties": false,
|
|
162
|
+
"description": "A MongoDB WriteConcern, which describes the level of acknowledgement\nrequested from MongoDB for write operations.",
|
|
163
|
+
"properties": {
|
|
164
|
+
"fsync": {
|
|
165
|
+
"deprecated": true,
|
|
166
|
+
"description": "Equivalent to the j option.",
|
|
167
|
+
"enum": [
|
|
168
|
+
false,
|
|
169
|
+
true,
|
|
170
|
+
1
|
|
171
|
+
],
|
|
172
|
+
"type": [
|
|
173
|
+
"boolean",
|
|
174
|
+
"number"
|
|
175
|
+
]
|
|
176
|
+
},
|
|
177
|
+
"j": {
|
|
178
|
+
"default": false,
|
|
179
|
+
"deprecated": true,
|
|
180
|
+
"description": "Request acknowledgment that the write operation has been written to the on-disk journal.",
|
|
181
|
+
"type": "boolean"
|
|
182
|
+
},
|
|
183
|
+
"wtimeout": {
|
|
184
|
+
"deprecated": true,
|
|
185
|
+
"description": "Specify a time limit to prevent write operations from blocking indefinitely.",
|
|
186
|
+
"type": "number"
|
|
187
|
+
}
|
|
188
|
+
},
|
|
189
|
+
"public": true,
|
|
190
|
+
"see": "https://www.mongodb.com/docs/manual/reference/write-concern/",
|
|
191
|
+
"type": "object"
|
|
192
|
+
},
|
|
193
|
+
"WriteConcernSettings": {
|
|
194
|
+
"additionalProperties": false,
|
|
195
|
+
"properties": {
|
|
196
|
+
"fsync": {
|
|
197
|
+
"deprecated": true,
|
|
198
|
+
"description": "The file sync write concern.",
|
|
199
|
+
"enum": [
|
|
200
|
+
false,
|
|
201
|
+
true,
|
|
202
|
+
1
|
|
203
|
+
],
|
|
204
|
+
"type": [
|
|
205
|
+
"boolean",
|
|
206
|
+
"number"
|
|
207
|
+
]
|
|
208
|
+
},
|
|
209
|
+
"j": {
|
|
210
|
+
"default": false,
|
|
211
|
+
"deprecated": true,
|
|
212
|
+
"description": "The journal write concern.",
|
|
213
|
+
"type": "boolean"
|
|
214
|
+
},
|
|
215
|
+
"journal": {
|
|
216
|
+
"default": false,
|
|
217
|
+
"description": "The journal write concern",
|
|
218
|
+
"type": "boolean"
|
|
219
|
+
},
|
|
220
|
+
"w": {
|
|
221
|
+
"anyOf": [
|
|
222
|
+
{
|
|
223
|
+
"type": "number"
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"const": "majority",
|
|
227
|
+
"type": "string"
|
|
228
|
+
}
|
|
229
|
+
],
|
|
230
|
+
"description": "The write concern",
|
|
231
|
+
"public": true
|
|
232
|
+
},
|
|
233
|
+
"wtimeout": {
|
|
234
|
+
"description": "The write concern timeout.",
|
|
235
|
+
"type": "number"
|
|
236
|
+
},
|
|
237
|
+
"wtimeoutMS": {
|
|
238
|
+
"description": "The write concern timeout.",
|
|
239
|
+
"type": "number"
|
|
240
|
+
}
|
|
241
|
+
},
|
|
242
|
+
"public": true,
|
|
243
|
+
"type": "object"
|
|
244
|
+
},
|
|
245
|
+
"modelAliases": {
|
|
246
|
+
"additionalProperties": {
|
|
247
|
+
"type": "string"
|
|
248
|
+
},
|
|
249
|
+
"description": "Model Aliases to allow easier rename of Model",
|
|
250
|
+
"type": "object"
|
|
251
|
+
}
|
|
252
|
+
},
|
|
253
|
+
"description": "MongoDB store parameters",
|
|
254
|
+
"properties": {
|
|
255
|
+
"collection": {
|
|
256
|
+
"description": "Which collection to use\n\nAll the models managed by the store share this collection, the `__type`\nfield is used to differentiate them",
|
|
257
|
+
"type": "string"
|
|
258
|
+
},
|
|
259
|
+
"database": {
|
|
260
|
+
"description": "Database to use, default to the one defined in the URL",
|
|
261
|
+
"type": "string"
|
|
262
|
+
},
|
|
263
|
+
"databaseOptions": {
|
|
264
|
+
"$ref": "#/definitions/DbOptions",
|
|
265
|
+
"description": "Mongo Database Options",
|
|
266
|
+
"see": "https://www.npmjs.com/package/mongodb"
|
|
267
|
+
},
|
|
268
|
+
"defaultModel": {
|
|
269
|
+
"default": true,
|
|
270
|
+
"description": "When __type model not found, use the model\nIf strict is setup this parameter is not used",
|
|
271
|
+
"type": "boolean"
|
|
272
|
+
},
|
|
273
|
+
"forceModel": {
|
|
274
|
+
"default": false,
|
|
275
|
+
"description": "If set, Store will ignore the __type",
|
|
276
|
+
"type": "boolean"
|
|
277
|
+
},
|
|
278
|
+
"modelAliases": {
|
|
279
|
+
"$ref": "#/definitions/modelAliases",
|
|
280
|
+
"description": "Model Aliases to allow easier rename of Model"
|
|
281
|
+
},
|
|
282
|
+
"models": {
|
|
283
|
+
"default": [
|
|
284
|
+
"Webda/RegistryEntry"
|
|
285
|
+
],
|
|
286
|
+
"description": "Models managed by this Store.",
|
|
287
|
+
"items": {
|
|
288
|
+
"type": "string"
|
|
289
|
+
},
|
|
290
|
+
"type": "array"
|
|
291
|
+
},
|
|
292
|
+
"mongoUrl": {
|
|
293
|
+
"description": "Contains the URL to Mongo Server\n\nWill try to use WEBDA_MONGO_URL environment variable if not defined",
|
|
294
|
+
"type": "string"
|
|
295
|
+
},
|
|
296
|
+
"noCache": {
|
|
297
|
+
"default": false,
|
|
298
|
+
"description": "Disable default memory cache",
|
|
299
|
+
"type": "boolean"
|
|
300
|
+
},
|
|
301
|
+
"options": {
|
|
302
|
+
"description": "Additional options for Mongo connetion\n\nShould be typed with MongoClientOptions but not available due to bug in ts-json-schema-generator\nhttps://docs.mongodb.com/manual/reference/connection-string"
|
|
303
|
+
},
|
|
304
|
+
"slowQueryThreshold": {
|
|
305
|
+
"default": 30000,
|
|
306
|
+
"description": "Slow query threshold",
|
|
307
|
+
"type": "number"
|
|
308
|
+
},
|
|
309
|
+
"strict": {
|
|
310
|
+
"default": false,
|
|
311
|
+
"description": "Allow to load object that does not have the type data\n\nIf set to true, then the Store will only managed the defined _model and no\nmodel extending this one",
|
|
312
|
+
"type": "boolean"
|
|
313
|
+
},
|
|
314
|
+
"type": {
|
|
315
|
+
"description": "Type of the service",
|
|
316
|
+
"type": "string"
|
|
317
|
+
},
|
|
318
|
+
"openapi": {
|
|
319
|
+
"type": "object",
|
|
320
|
+
"additionalProperties": true
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
"required": [
|
|
324
|
+
"collection",
|
|
325
|
+
"type"
|
|
326
|
+
],
|
|
327
|
+
"type": "object",
|
|
328
|
+
"title": "MongoStore"
|
|
329
|
+
},
|
|
330
|
+
"Configuration": "lib/mongodb.service:MongoParameters"
|
|
331
|
+
}
|
|
13
332
|
},
|
|
333
|
+
"models": {},
|
|
14
334
|
"schemas": {
|
|
15
335
|
"Webda/BinaryFile": {
|
|
16
|
-
"
|
|
336
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
337
|
+
"WebdaSchema": true,
|
|
338
|
+
"additionalProperties": false,
|
|
339
|
+
"description": "Represent a file to store",
|
|
17
340
|
"properties": {
|
|
18
|
-
"hash": {
|
|
19
|
-
"type": "string",
|
|
20
|
-
"description": "Will be computed by the service\n\nhash of the content"
|
|
21
|
-
},
|
|
22
341
|
"challenge": {
|
|
23
|
-
"
|
|
24
|
-
"
|
|
342
|
+
"description": "Will be computed by the service\n\nhash of the content prefixed by 'WEBDA'",
|
|
343
|
+
"type": "string"
|
|
25
344
|
},
|
|
26
|
-
"
|
|
27
|
-
"
|
|
28
|
-
"
|
|
345
|
+
"hash": {
|
|
346
|
+
"description": "Will be computed by the service\n\nhash of the content",
|
|
347
|
+
"type": "string"
|
|
29
348
|
},
|
|
30
|
-
"
|
|
31
|
-
"
|
|
32
|
-
"description": "Current name"
|
|
349
|
+
"metadata": {
|
|
350
|
+
"description": "Metadatas stored along with the binary"
|
|
33
351
|
},
|
|
34
352
|
"mimetype": {
|
|
35
|
-
"
|
|
36
|
-
"
|
|
353
|
+
"description": "Mimetype of the binary",
|
|
354
|
+
"type": "string"
|
|
37
355
|
},
|
|
38
|
-
"
|
|
39
|
-
"description": "
|
|
356
|
+
"name": {
|
|
357
|
+
"description": "Current name",
|
|
358
|
+
"type": "string"
|
|
40
359
|
},
|
|
41
360
|
"originalname": {
|
|
42
|
-
"
|
|
43
|
-
"
|
|
361
|
+
"description": "Original name",
|
|
362
|
+
"type": "string"
|
|
363
|
+
},
|
|
364
|
+
"size": {
|
|
365
|
+
"description": "Size of the binary",
|
|
366
|
+
"type": "number"
|
|
44
367
|
}
|
|
45
368
|
},
|
|
46
369
|
"required": [
|
|
@@ -48,375 +371,9 @@
|
|
|
48
371
|
"name",
|
|
49
372
|
"size"
|
|
50
373
|
],
|
|
51
|
-
"description": "Represent a file to store",
|
|
52
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
53
|
-
"title": "BinaryFile"
|
|
54
|
-
},
|
|
55
|
-
"Webda/MongoStore": {
|
|
56
374
|
"type": "object",
|
|
57
|
-
"
|
|
58
|
-
"type": {
|
|
59
|
-
"type": "string",
|
|
60
|
-
"description": "Type of the service"
|
|
61
|
-
},
|
|
62
|
-
"url": {
|
|
63
|
-
"type": "string",
|
|
64
|
-
"description": "URL on which to serve the content"
|
|
65
|
-
},
|
|
66
|
-
"model": {
|
|
67
|
-
"type": "string",
|
|
68
|
-
"description": "Webda model to use within the Store",
|
|
69
|
-
"default": "Webda/CoreModel"
|
|
70
|
-
},
|
|
71
|
-
"additionalModels": {
|
|
72
|
-
"type": "array",
|
|
73
|
-
"items": {
|
|
74
|
-
"type": "string"
|
|
75
|
-
},
|
|
76
|
-
"description": "Additional models\n\nAllow this store to manage other models",
|
|
77
|
-
"default": []
|
|
78
|
-
},
|
|
79
|
-
"strict": {
|
|
80
|
-
"type": "boolean",
|
|
81
|
-
"description": "Allow to load object that does not have the type data\n\nIf set to true, then the Store will only managed the defined _model and no model extending this one",
|
|
82
|
-
"default": false
|
|
83
|
-
},
|
|
84
|
-
"defaultModel": {
|
|
85
|
-
"type": "boolean",
|
|
86
|
-
"description": "When __type model not found, use the model If strict is setup this parameter is not used",
|
|
87
|
-
"default": true
|
|
88
|
-
},
|
|
89
|
-
"forceModel": {
|
|
90
|
-
"type": "boolean",
|
|
91
|
-
"description": "If set, Store will ignore the __type",
|
|
92
|
-
"default": false
|
|
93
|
-
},
|
|
94
|
-
"slowQueryThreshold": {
|
|
95
|
-
"type": "number",
|
|
96
|
-
"description": "Slow query threshold",
|
|
97
|
-
"default": 30000
|
|
98
|
-
},
|
|
99
|
-
"modelAliases": {
|
|
100
|
-
"type": "object",
|
|
101
|
-
"additionalProperties": {
|
|
102
|
-
"type": "string"
|
|
103
|
-
},
|
|
104
|
-
"description": "Model Aliases to allow easier rename of Model"
|
|
105
|
-
},
|
|
106
|
-
"noCache": {
|
|
107
|
-
"type": "boolean",
|
|
108
|
-
"description": "Disable default memory cache"
|
|
109
|
-
},
|
|
110
|
-
"mongoUrl": {
|
|
111
|
-
"type": "string",
|
|
112
|
-
"description": "Contains the URL to Mongo Server\n\nWill try to use WEBDA_MONDO_URL environment variable if not defined"
|
|
113
|
-
},
|
|
114
|
-
"options": {
|
|
115
|
-
"description": "Additional options for Mongo connetion\n\nShould be typed with MongoClientOptions but not available due to bug in ts-json-schema-generator https://docs.mongodb.com/manual/reference/connection-string"
|
|
116
|
-
},
|
|
117
|
-
"collection": {
|
|
118
|
-
"type": "string",
|
|
119
|
-
"description": "Which collection to use"
|
|
120
|
-
},
|
|
121
|
-
"database": {
|
|
122
|
-
"type": "string"
|
|
123
|
-
},
|
|
124
|
-
"databaseOptions": {
|
|
125
|
-
"type": "object",
|
|
126
|
-
"properties": {
|
|
127
|
-
"writeConcern": {
|
|
128
|
-
"anyOf": [
|
|
129
|
-
{
|
|
130
|
-
"type": "object",
|
|
131
|
-
"properties": {
|
|
132
|
-
"w": {
|
|
133
|
-
"$ref": "#/definitions/W",
|
|
134
|
-
"description": "Request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags."
|
|
135
|
-
},
|
|
136
|
-
"journal": {
|
|
137
|
-
"type": "boolean",
|
|
138
|
-
"description": "Request acknowledgment that the write operation has been written to the on-disk journal"
|
|
139
|
-
},
|
|
140
|
-
"wtimeoutMS": {
|
|
141
|
-
"type": "number",
|
|
142
|
-
"description": "Specify a time limit to prevent write operations from blocking indefinitely"
|
|
143
|
-
},
|
|
144
|
-
"wtimeout": {
|
|
145
|
-
"type": "number",
|
|
146
|
-
"description": "Specify a time limit to prevent write operations from blocking indefinitely.",
|
|
147
|
-
"deprecated": "Will be removed in the next major version. Please use wtimeoutMS."
|
|
148
|
-
},
|
|
149
|
-
"j": {
|
|
150
|
-
"type": "boolean",
|
|
151
|
-
"description": "Request acknowledgment that the write operation has been written to the on-disk journal.",
|
|
152
|
-
"deprecated": "Will be removed in the next major version. Please use journal."
|
|
153
|
-
},
|
|
154
|
-
"fsync": {
|
|
155
|
-
"anyOf": [
|
|
156
|
-
{
|
|
157
|
-
"type": "boolean"
|
|
158
|
-
},
|
|
159
|
-
{
|
|
160
|
-
"type": "number",
|
|
161
|
-
"const": 1
|
|
162
|
-
}
|
|
163
|
-
],
|
|
164
|
-
"description": "Equivalent to the j option.",
|
|
165
|
-
"deprecated": "Will be removed in the next major version. Please use journal."
|
|
166
|
-
}
|
|
167
|
-
},
|
|
168
|
-
"description": "A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations."
|
|
169
|
-
},
|
|
170
|
-
{
|
|
171
|
-
"type": "object",
|
|
172
|
-
"properties": {
|
|
173
|
-
"w": {
|
|
174
|
-
"$ref": "#/definitions/W",
|
|
175
|
-
"description": "The write concern"
|
|
176
|
-
},
|
|
177
|
-
"wtimeoutMS": {
|
|
178
|
-
"type": "number",
|
|
179
|
-
"description": "The write concern timeout"
|
|
180
|
-
},
|
|
181
|
-
"journal": {
|
|
182
|
-
"type": "boolean",
|
|
183
|
-
"description": "The journal write concern"
|
|
184
|
-
},
|
|
185
|
-
"j": {
|
|
186
|
-
"type": "boolean",
|
|
187
|
-
"description": "The journal write concern.",
|
|
188
|
-
"deprecated": "Will be removed in the next major version. Please use the journal option."
|
|
189
|
-
},
|
|
190
|
-
"wtimeout": {
|
|
191
|
-
"type": "number",
|
|
192
|
-
"description": "The write concern timeout.",
|
|
193
|
-
"deprecated": "Will be removed in the next major version. Please use the wtimeoutMS option."
|
|
194
|
-
},
|
|
195
|
-
"fsync": {
|
|
196
|
-
"anyOf": [
|
|
197
|
-
{
|
|
198
|
-
"type": "boolean"
|
|
199
|
-
},
|
|
200
|
-
{
|
|
201
|
-
"type": "number",
|
|
202
|
-
"const": 1
|
|
203
|
-
}
|
|
204
|
-
],
|
|
205
|
-
"description": "The file sync write concern.",
|
|
206
|
-
"deprecated": "Will be removed in the next major version. Please use the journal option."
|
|
207
|
-
}
|
|
208
|
-
}
|
|
209
|
-
}
|
|
210
|
-
],
|
|
211
|
-
"description": "Write Concern as an object"
|
|
212
|
-
},
|
|
213
|
-
"useBigInt64": {
|
|
214
|
-
"type": "boolean",
|
|
215
|
-
"description": "when deserializing a Long return as a BigInt."
|
|
216
|
-
},
|
|
217
|
-
"promoteLongs": {
|
|
218
|
-
"type": "boolean",
|
|
219
|
-
"description": "when deserializing a Long will fit it into a Number if it's smaller than 53 bits."
|
|
220
|
-
},
|
|
221
|
-
"promoteBuffers": {
|
|
222
|
-
"type": "boolean",
|
|
223
|
-
"description": "when deserializing a Binary will return it as a node.js Buffer instance."
|
|
224
|
-
},
|
|
225
|
-
"promoteValues": {
|
|
226
|
-
"type": "boolean",
|
|
227
|
-
"description": "when deserializing will promote BSON values to their Node.js closest equivalent types."
|
|
228
|
-
},
|
|
229
|
-
"fieldsAsRaw": {
|
|
230
|
-
"type": "object",
|
|
231
|
-
"description": "allow to specify if there what fields we wish to return as unserialized raw buffer."
|
|
232
|
-
},
|
|
233
|
-
"bsonRegExp": {
|
|
234
|
-
"type": "boolean",
|
|
235
|
-
"description": "return BSON regular expressions as BSONRegExp instances."
|
|
236
|
-
},
|
|
237
|
-
"raw": {
|
|
238
|
-
"type": "boolean",
|
|
239
|
-
"description": "Enabling the raw option will return a [Node.js Buffer](https://nodejs.org/api/buffer.html) which is allocated using [allocUnsafe API](https://nodejs.org/api/buffer.html#static-method-bufferallocunsafesize). See this section from the [Node.js Docs here](https://nodejs.org/api/buffer.html#what-makes-bufferallocunsafe-and-bufferallocunsafeslow-unsafe) for more detail about what \"unsafe\" refers to in this context. If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:"
|
|
240
|
-
},
|
|
241
|
-
"checkKeys": {
|
|
242
|
-
"type": "boolean",
|
|
243
|
-
"description": "the serializer will check if keys are valid."
|
|
244
|
-
},
|
|
245
|
-
"serializeFunctions": {
|
|
246
|
-
"type": "boolean",
|
|
247
|
-
"description": "serialize the javascript functions"
|
|
248
|
-
},
|
|
249
|
-
"ignoreUndefined": {
|
|
250
|
-
"type": "boolean",
|
|
251
|
-
"description": "serialize will not emit undefined fields note that the driver sets this to `false`"
|
|
252
|
-
},
|
|
253
|
-
"enableUtf8Validation": {
|
|
254
|
-
"type": "boolean",
|
|
255
|
-
"description": "Enable utf8 validation when deserializing BSON documents. Defaults to true."
|
|
256
|
-
},
|
|
257
|
-
"authSource": {
|
|
258
|
-
"type": "string",
|
|
259
|
-
"description": "If the database authentication is dependent on another databaseName."
|
|
260
|
-
},
|
|
261
|
-
"forceServerObjectId": {
|
|
262
|
-
"type": "boolean",
|
|
263
|
-
"description": "Force server to assign _id values instead of driver."
|
|
264
|
-
},
|
|
265
|
-
"readPreference": {
|
|
266
|
-
"$ref": "#/definitions/ReadPreferenceLike",
|
|
267
|
-
"description": "The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST)."
|
|
268
|
-
},
|
|
269
|
-
"pkFactory": {
|
|
270
|
-
"type": "object",
|
|
271
|
-
"description": "A primary key factory object for generation of custom _id keys."
|
|
272
|
-
},
|
|
273
|
-
"readConcern": {
|
|
274
|
-
"type": "object",
|
|
275
|
-
"properties": {
|
|
276
|
-
"level": {
|
|
277
|
-
"anyOf": [
|
|
278
|
-
{
|
|
279
|
-
"$ref": "#/definitions/ReadConcernLevel"
|
|
280
|
-
},
|
|
281
|
-
{
|
|
282
|
-
"type": "string"
|
|
283
|
-
}
|
|
284
|
-
]
|
|
285
|
-
}
|
|
286
|
-
},
|
|
287
|
-
"required": [
|
|
288
|
-
"level"
|
|
289
|
-
],
|
|
290
|
-
"description": "Specify a read concern for the collection. (only MongoDB 3.2 or higher supported)"
|
|
291
|
-
},
|
|
292
|
-
"retryWrites": {
|
|
293
|
-
"type": "boolean",
|
|
294
|
-
"description": "Should retry failed writes"
|
|
295
|
-
}
|
|
296
|
-
},
|
|
297
|
-
"description": "Mongo Database Options"
|
|
298
|
-
},
|
|
299
|
-
"openapi": {
|
|
300
|
-
"type": "object",
|
|
301
|
-
"additionalProperties": true
|
|
302
|
-
}
|
|
303
|
-
},
|
|
304
|
-
"required": [
|
|
305
|
-
"collection",
|
|
306
|
-
"slowQueryThreshold",
|
|
307
|
-
"type"
|
|
308
|
-
],
|
|
309
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
310
|
-
"definitions": {
|
|
311
|
-
"W": {
|
|
312
|
-
"anyOf": [
|
|
313
|
-
{
|
|
314
|
-
"type": "number"
|
|
315
|
-
},
|
|
316
|
-
{
|
|
317
|
-
"type": "string",
|
|
318
|
-
"const": "majority"
|
|
319
|
-
}
|
|
320
|
-
]
|
|
321
|
-
},
|
|
322
|
-
"ReadPreferenceLike": {
|
|
323
|
-
"anyOf": [
|
|
324
|
-
{
|
|
325
|
-
"type": "object",
|
|
326
|
-
"properties": {
|
|
327
|
-
"mode": {
|
|
328
|
-
"$ref": "#/definitions/ReadPreferenceMode"
|
|
329
|
-
},
|
|
330
|
-
"tags": {
|
|
331
|
-
"type": "array",
|
|
332
|
-
"items": {
|
|
333
|
-
"$ref": "#/definitions/TagSet"
|
|
334
|
-
}
|
|
335
|
-
},
|
|
336
|
-
"hedge": {
|
|
337
|
-
"type": "object",
|
|
338
|
-
"properties": {
|
|
339
|
-
"enabled": {
|
|
340
|
-
"type": "boolean",
|
|
341
|
-
"description": "Explicitly enable or disable hedged reads."
|
|
342
|
-
}
|
|
343
|
-
}
|
|
344
|
-
},
|
|
345
|
-
"maxStalenessSeconds": {
|
|
346
|
-
"type": "number"
|
|
347
|
-
},
|
|
348
|
-
"minWireVersion": {
|
|
349
|
-
"type": "number"
|
|
350
|
-
}
|
|
351
|
-
},
|
|
352
|
-
"required": [
|
|
353
|
-
"mode"
|
|
354
|
-
],
|
|
355
|
-
"description": "The **ReadPreference** class is a class that represents a MongoDB ReadPreference and is used to construct connections."
|
|
356
|
-
},
|
|
357
|
-
{
|
|
358
|
-
"$ref": "#/definitions/ReadPreferenceMode"
|
|
359
|
-
}
|
|
360
|
-
]
|
|
361
|
-
},
|
|
362
|
-
"ReadPreferenceMode": {
|
|
363
|
-
"anyOf": [
|
|
364
|
-
{
|
|
365
|
-
"type": "string",
|
|
366
|
-
"const": "primary"
|
|
367
|
-
},
|
|
368
|
-
{
|
|
369
|
-
"type": "string",
|
|
370
|
-
"const": "primaryPreferred"
|
|
371
|
-
},
|
|
372
|
-
{
|
|
373
|
-
"type": "string",
|
|
374
|
-
"const": "secondary"
|
|
375
|
-
},
|
|
376
|
-
{
|
|
377
|
-
"type": "string",
|
|
378
|
-
"const": "secondaryPreferred"
|
|
379
|
-
},
|
|
380
|
-
{
|
|
381
|
-
"type": "string",
|
|
382
|
-
"const": "nearest"
|
|
383
|
-
},
|
|
384
|
-
{}
|
|
385
|
-
]
|
|
386
|
-
},
|
|
387
|
-
"TagSet": {
|
|
388
|
-
"type": "object",
|
|
389
|
-
"additionalProperties": {
|
|
390
|
-
"type": "string"
|
|
391
|
-
}
|
|
392
|
-
},
|
|
393
|
-
"ReadConcernLevel": {
|
|
394
|
-
"anyOf": [
|
|
395
|
-
{
|
|
396
|
-
"type": "string",
|
|
397
|
-
"const": "local"
|
|
398
|
-
},
|
|
399
|
-
{
|
|
400
|
-
"type": "string",
|
|
401
|
-
"const": "majority"
|
|
402
|
-
},
|
|
403
|
-
{
|
|
404
|
-
"type": "string",
|
|
405
|
-
"const": "linearizable"
|
|
406
|
-
},
|
|
407
|
-
{
|
|
408
|
-
"type": "string",
|
|
409
|
-
"const": "available"
|
|
410
|
-
},
|
|
411
|
-
{
|
|
412
|
-
"type": "string",
|
|
413
|
-
"const": "snapshot"
|
|
414
|
-
},
|
|
415
|
-
{}
|
|
416
|
-
]
|
|
417
|
-
}
|
|
418
|
-
},
|
|
419
|
-
"title": "MongoStore"
|
|
375
|
+
"title": "BinaryFile"
|
|
420
376
|
}
|
|
421
|
-
}
|
|
377
|
+
},
|
|
378
|
+
"behaviors": {}
|
|
422
379
|
}
|