arangojs 10.2.2 → 10.3.0
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/CHANGELOG.md +46 -0
- package/cjs/connection.js +1 -1
- package/cjs/databases.d.ts.map +1 -1
- package/cjs/databases.js +11 -1
- package/cjs/databases.js.map +1 -1
- package/cjs/indexes.d.ts +26 -0
- package/cjs/indexes.d.ts.map +1 -1
- package/cjs/indexes.js.map +1 -1
- package/cjs/queries.d.ts +71 -1
- package/cjs/queries.d.ts.map +1 -1
- package/cjs/queries.js.map +1 -1
- package/databases.d.ts.map +1 -1
- package/esm/connection.js +1 -1
- package/esm/databases.d.ts.map +1 -1
- package/esm/databases.js +11 -1
- package/esm/databases.js.map +1 -1
- package/esm/indexes.d.ts +26 -0
- package/esm/indexes.d.ts.map +1 -1
- package/esm/indexes.js.map +1 -1
- package/esm/queries.d.ts +71 -1
- package/esm/queries.d.ts.map +1 -1
- package/esm/queries.js.map +1 -1
- package/indexes.d.ts +26 -0
- package/indexes.d.ts.map +1 -1
- package/package.json +1 -1
- package/queries.d.ts +71 -1
- package/queries.d.ts.map +1 -1
package/queries.d.ts
CHANGED
|
@@ -119,7 +119,7 @@ export type QueryOptions = {
|
|
|
119
119
|
/**
|
|
120
120
|
* Limits the maximum number of warnings a query will return.
|
|
121
121
|
*/
|
|
122
|
-
|
|
122
|
+
maxWarningCount?: number;
|
|
123
123
|
/**
|
|
124
124
|
* If set to `true` and the query has a `LIMIT` clause, the total number of
|
|
125
125
|
* values matched before the last top-level `LIMIT` in the query was applied
|
|
@@ -144,8 +144,17 @@ export type QueryOptions = {
|
|
|
144
144
|
/**
|
|
145
145
|
* Limits the maximum number of plans that will be created by the AQL query
|
|
146
146
|
* optimizer.
|
|
147
|
+
*
|
|
148
|
+
* @deprecated Use `maxNumberOfPlans` instead. `maxPlans` will be removed in a
|
|
149
|
+
* future major version. Both are currently supported; when both are provided,
|
|
150
|
+
* `maxNumberOfPlans` takes precedence.
|
|
147
151
|
*/
|
|
148
152
|
maxPlans?: number;
|
|
153
|
+
/**
|
|
154
|
+
* Limits the maximum number of plans that will be created by the AQL query
|
|
155
|
+
* optimizer.
|
|
156
|
+
*/
|
|
157
|
+
maxNumberOfPlans?: number;
|
|
149
158
|
/**
|
|
150
159
|
* Controls after how many execution nodes in a query a stack split should be
|
|
151
160
|
* performed.
|
|
@@ -210,6 +219,48 @@ export type ExplainOptions = {
|
|
|
210
219
|
* Default: `false`
|
|
211
220
|
*/
|
|
212
221
|
allPlans?: boolean;
|
|
222
|
+
/**
|
|
223
|
+
* Whether to calculate the total number of documents matching the filter
|
|
224
|
+
* conditions as if the query's final top-level `LIMIT` operation were not
|
|
225
|
+
* applied. This option generally leads to different execution plans.
|
|
226
|
+
*
|
|
227
|
+
* Default: `false`
|
|
228
|
+
*/
|
|
229
|
+
fullCount?: boolean;
|
|
230
|
+
/**
|
|
231
|
+
* Whether to include additional query profiling information.
|
|
232
|
+
* If set to `2`, the response includes the time it took to process each
|
|
233
|
+
* optimizer rule under `stats.rules`.
|
|
234
|
+
*
|
|
235
|
+
* Default: `0`
|
|
236
|
+
*/
|
|
237
|
+
profile?: number;
|
|
238
|
+
/**
|
|
239
|
+
* The number of execution nodes in the query plan after that stack splitting
|
|
240
|
+
* is performed to avoid a potential stack overflow.
|
|
241
|
+
*
|
|
242
|
+
* This option is only useful for testing and debugging and normally does not
|
|
243
|
+
* need any adjustment.
|
|
244
|
+
*
|
|
245
|
+
* Default: Controlled by the `--query.max-nodes-per-callstack` startup option.
|
|
246
|
+
*/
|
|
247
|
+
maxNodesPerCallstack?: number;
|
|
248
|
+
/**
|
|
249
|
+
* Limits the number of warnings a query can return.
|
|
250
|
+
* You can increase or decrease the number with this option.
|
|
251
|
+
*
|
|
252
|
+
* Default: `10`
|
|
253
|
+
*/
|
|
254
|
+
maxWarningCount?: number;
|
|
255
|
+
/**
|
|
256
|
+
* If set to `true`, the query throws an exception and aborts instead of
|
|
257
|
+
* producing a warning. You should use this option during development to catch
|
|
258
|
+
* potential issues early. When the attribute is set to `false`, warnings are
|
|
259
|
+
* not propagated to exceptions and are returned with the query result.
|
|
260
|
+
*
|
|
261
|
+
* Default: Controlled by the `--query.fail-on-warning` startup option.
|
|
262
|
+
*/
|
|
263
|
+
failOnWarning?: boolean;
|
|
213
264
|
};
|
|
214
265
|
/**
|
|
215
266
|
* Options for query tracking.
|
|
@@ -234,6 +285,11 @@ export type QueryTrackingOptions = {
|
|
|
234
285
|
* considered slow.
|
|
235
286
|
*/
|
|
236
287
|
slowQueryThreshold?: number;
|
|
288
|
+
/**
|
|
289
|
+
* Threshold in seconds for treating a streaming query as slow
|
|
290
|
+
* (the `stream` option is `true` for the query).
|
|
291
|
+
*/
|
|
292
|
+
slowStreamingQueryThreshold?: number;
|
|
237
293
|
/**
|
|
238
294
|
* If set to `true`, bind parameters will be tracked along with queries.
|
|
239
295
|
*/
|
|
@@ -456,6 +512,11 @@ export type QueryTrackingInfo = {
|
|
|
456
512
|
* considered slow.
|
|
457
513
|
*/
|
|
458
514
|
slowQueryThreshold: number;
|
|
515
|
+
/**
|
|
516
|
+
* Threshold in seconds for treating a streaming query as slow
|
|
517
|
+
* (the `stream` option is `true` for the query).
|
|
518
|
+
*/
|
|
519
|
+
slowStreamingQueryThreshold: number;
|
|
459
520
|
/**
|
|
460
521
|
* Whether bind parameters are being tracked along with queries.
|
|
461
522
|
*/
|
|
@@ -580,6 +641,15 @@ export type QueryDescription = {
|
|
|
580
641
|
* Whether the query uses a streaming cursor.
|
|
581
642
|
*/
|
|
582
643
|
stream: boolean;
|
|
644
|
+
/**
|
|
645
|
+
* Whether the query writes data (`true`) or only reads (`false`).
|
|
646
|
+
*/
|
|
647
|
+
modificationQuery: boolean;
|
|
648
|
+
/**
|
|
649
|
+
* An error code (`errorNum`) that indicates why the query failed, or `0` on success.
|
|
650
|
+
* Only present in slow queries (finished queries), not in running queries.
|
|
651
|
+
*/
|
|
652
|
+
exitCode?: number;
|
|
583
653
|
};
|
|
584
654
|
/**
|
|
585
655
|
* Definition of an AQL User Function.
|
package/queries.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,8CAA8C;AAG9C;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,
|
|
1
|
+
{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,8CAA8C;AAG9C;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,SAAS,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAChC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;OAKG;IACH,SAAS,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAChC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,GAAG,QAAQ,CAAC;CAChC,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC9C;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC9C;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,MAAM,CAAC;QACX,YAAY,EAAE,MAAM,EAAE,CAAC;QACvB,aAAa,EAAE,MAAM,CAAC;QACtB,gBAAgB,EAAE,MAAM,CAAC;KAC1B,EAAE,CAAC;IACJ;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,EAAE,CAAC;IACJ;;OAEG;IACH,SAAS,EAAE;QACT,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;IACJ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;OAEG;IACH,GAAG,EAAE,OAAO,EAAE,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,MAAM,EAAE,OAAO,CAAC;QAChB,WAAW,EAAE,OAAO,CAAC;QACrB,aAAa,EAAE,OAAO,CAAC;QACvB,wBAAwB,EAAE,OAAO,CAAC;QAClC,iBAAiB,EAAE,OAAO,CAAC;QAC3B,cAAc,EAAE,OAAO,CAAC;KACzB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,KAAK,GAAG,IAAI,GAAG,QAAQ,CAAC;CAC/B,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,QAAQ,CAAC;IAC3C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC"}
|