@mongodb-js/mongodb-constants - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

dist/stage-operators.d.ts

@@ -561,4 +561,52 @@ declare const STAGE_OPERATORS: readonly [{
     readonly snippet: "{\n  path: ${1:path},\n  includeArrayIndex: '${2:string}',\n  preserveNullAndEmptyArrays: ${3:boolean}\n}";
+}, {
+    readonly name: "$changeStream";
+    readonly value: "$changeStream";
+    readonly label: "$changeStream";
+    readonly outputStage: false;
+    readonly fullScan: false;
+    readonly firstStage: true;
+    readonly score: 1;
+    readonly env: readonly ["atlas", "on-prem"];
+    readonly meta: "stage";
+    readonly version: "4.2.0";
+    readonly apiVersions: readonly [1];
+    readonly namespaces: readonly ["db"];
+    readonly description: "Returns a Change Stream cursor for the collection.";
+    readonly comment: "/**\n * allChangesForCluster: Optional boolean to include all changes in the cluster.\n * fullDocument: Optional value to request a copy of full document when modified by update operations (Introduced in 6.0).\n * fullDocumentBeforeChange: Value to configure whether to return a full document before the change or not.\n * resumeAfter: Specifies a resume token as the logical starting point for the change stream. Cannot be used with startAfter or startAtOperationTime fields.\n * showExpandedEvents: Specifies whether to include additional change events, such as such as DDL and index operations (Introduced in 6.0).\n * startAfter: Specifies a resume token as the logical starting point for the change stream. Cannot be used with resumeAfter or startAtOperationTime fields.\n * startAtOperationTime: Specifies a time as the logical starting point for the change stream. Cannot be used with resumeAfter or startAfter fields.\n */\n";
+    readonly snippet: "{\n  allChangesForCluster: ${1:boolean},\n  fullDocument: '${2:string}',\n  fullDocumentBeforeChange: '${3:string}',\n  resumeAfter: ${4:resumeToken},\n  showExpandedEvents: ${5:boolean},\n  startAfter: ${6:resumeToken},\n  startAtOperationTime: ${7:time},\n}";
+}, {
+    readonly name: "$currentOp";
+    readonly value: "$currentOp";
+    readonly label: "$currentOp";
+    readonly outputStage: false;
+    readonly fullScan: false;
+    readonly firstStage: true;
+    readonly score: 1;
+    readonly env: readonly ["atlas", "adl", "on-prem"];
+    readonly meta: "stage";
+    readonly version: "3.6.0";
+    readonly apiVersions: readonly [1];
+    readonly namespaces: readonly ["db"];
+    readonly description: "Returns a cursor over information on active and/or dormant operations for the MongoDB deployment as well as inactive sessions that are holding locks as part of a transaction.";
+    readonly comment: "/**\n * allUsers: Optional boolean value to specify whether to return operations for all users or not.\n * idleConnections: Optional boolean value to specify whether to return all operations including idle connections or not.\n * idleCursors: Optional boolean value to specify whether to report on cursors that are idle or not.\n * idleSessions: Optional boolean value to specify whether to report on dormant sessions or not.\n * localOps: Optional boolean value to specify whether to report on operations running locally on targetted mongos or not.\n * backtrace: Optional boolean value to specify whether callstack information is returned as part of the waitingForLatch output field.\n */\n";
+    readonly snippet: "{\n  allUsers: ${1:false},\n  idleConnections: ${2:false},\n  idleCursors: ${3:false},\n  idleSessions: ${4:true},\n  localOps: ${5:false},\n  backtrace: ${6:false},\n}";
+}, {
+    readonly name: "$listLocalSessions";
+    readonly value: "$listLocalSessions";
+    readonly label: "$listLocalSessions";
+    readonly outputStage: false;
+    readonly fullScan: false;
+    readonly firstStage: true;
+    readonly score: 1;
+    readonly env: readonly ["atlas", "on-prem"];
+    readonly meta: "stage";
+    readonly version: "3.6.0";
+    readonly apiVersions: readonly [1];
+    readonly namespaces: readonly ["db"];
+    readonly description: "Lists the sessions cached in memory by the mongod or mongos instance.";
+    readonly comment: "/**\n * users: Optional list of users for which local sessions need to be returned.\n * allUsers: Optional boolean value to specify whether to return local sessions for all users or not.\n */\n";
+    readonly snippet: "{\n  allUsers: ${1:false},\n  users: [\n    { user: '${2:string}', db: '${3:string}' }\n  ]\n}";
 }];
-declare const STAGE_OPERATOR_NAMES: ("$count" | "$addFields" | "$bucket" | "$bucketAuto" | "$collStats" | "$densify" | "$documents" | "$facet" | "$fill" | "$geoNear" | "$graphLookup" | "$group" | "$indexStats" | "$limit" | "$lookup" | "$match" | "$merge" | "$out" | "$project" | "$redact" | "$replaceWith" | "$replaceRoot" | "$sample" | "$search" | "$searchMeta" | "$set" | "$setWindowFields" | "$skip" | "$sort" | "$sortByCount" | "$unionWith" | "$unset" | "$unwind")[];
+declare const STAGE_OPERATOR_NAMES: ("$count" | "$addFields" | "$bucket" | "$bucketAuto" | "$collStats" | "$densify" | "$documents" | "$facet" | "$fill" | "$geoNear" | "$graphLookup" | "$group" | "$indexStats" | "$limit" | "$lookup" | "$match" | "$merge" | "$out" | "$project" | "$redact" | "$replaceWith" | "$replaceRoot" | "$sample" | "$search" | "$searchMeta" | "$set" | "$setWindowFields" | "$skip" | "$sort" | "$sortByCount" | "$unionWith" | "$unset" | "$unwind" | "$changeStream" | "$currentOp" | "$listLocalSessions")[];
 declare const OUT_STAGES: ({
@@ -710,4 +758,52 @@ readonly name: "$merge";
     readonly snippet: "{}";
+} | {
+    readonly name: "$changeStream";
+    readonly value: "$changeStream";
+    readonly label: "$changeStream";
+    readonly outputStage: false;
+    readonly fullScan: false;
+    readonly firstStage: true;
+    readonly score: 1;
+    readonly env: readonly ["atlas", "on-prem"];
+    readonly meta: "stage";
+    readonly version: "4.2.0";
+    readonly apiVersions: readonly [1];
+    readonly namespaces: readonly ["db"];
+    readonly description: "Returns a Change Stream cursor for the collection.";
+    readonly comment: "/**\n * allChangesForCluster: Optional boolean to include all changes in the cluster.\n * fullDocument: Optional value to request a copy of full document when modified by update operations (Introduced in 6.0).\n * fullDocumentBeforeChange: Value to configure whether to return a full document before the change or not.\n * resumeAfter: Specifies a resume token as the logical starting point for the change stream. Cannot be used with startAfter or startAtOperationTime fields.\n * showExpandedEvents: Specifies whether to include additional change events, such as such as DDL and index operations (Introduced in 6.0).\n * startAfter: Specifies a resume token as the logical starting point for the change stream. Cannot be used with resumeAfter or startAtOperationTime fields.\n * startAtOperationTime: Specifies a time as the logical starting point for the change stream. Cannot be used with resumeAfter or startAfter fields.\n */\n";
+    readonly snippet: "{\n  allChangesForCluster: ${1:boolean},\n  fullDocument: '${2:string}',\n  fullDocumentBeforeChange: '${3:string}',\n  resumeAfter: ${4:resumeToken},\n  showExpandedEvents: ${5:boolean},\n  startAfter: ${6:resumeToken},\n  startAtOperationTime: ${7:time},\n}";
+} | {
+    readonly name: "$currentOp";
+    readonly value: "$currentOp";
+    readonly label: "$currentOp";
+    readonly outputStage: false;
+    readonly fullScan: false;
+    readonly firstStage: true;
+    readonly score: 1;
+    readonly env: readonly ["atlas", "adl", "on-prem"];
+    readonly meta: "stage";
+    readonly version: "3.6.0";
+    readonly apiVersions: readonly [1];
+    readonly namespaces: readonly ["db"];
+    readonly description: "Returns a cursor over information on active and/or dormant operations for the MongoDB deployment as well as inactive sessions that are holding locks as part of a transaction.";
+    readonly comment: "/**\n * allUsers: Optional boolean value to specify whether to return operations for all users or not.\n * idleConnections: Optional boolean value to specify whether to return all operations including idle connections or not.\n * idleCursors: Optional boolean value to specify whether to report on cursors that are idle or not.\n * idleSessions: Optional boolean value to specify whether to report on dormant sessions or not.\n * localOps: Optional boolean value to specify whether to report on operations running locally on targetted mongos or not.\n * backtrace: Optional boolean value to specify whether callstack information is returned as part of the waitingForLatch output field.\n */\n";
+    readonly snippet: "{\n  allUsers: ${1:false},\n  idleConnections: ${2:false},\n  idleCursors: ${3:false},\n  idleSessions: ${4:true},\n  localOps: ${5:false},\n  backtrace: ${6:false},\n}";
+} | {
+    readonly name: "$listLocalSessions";
+    readonly value: "$listLocalSessions";
+    readonly label: "$listLocalSessions";
+    readonly outputStage: false;
+    readonly fullScan: false;
+    readonly firstStage: true;
+    readonly score: 1;
+    readonly env: readonly ["atlas", "on-prem"];
+    readonly meta: "stage";
+    readonly version: "3.6.0";
+    readonly apiVersions: readonly [1];
+    readonly namespaces: readonly ["db"];
+    readonly description: "Lists the sessions cached in memory by the mongod or mongos instance.";
+    readonly comment: "/**\n * users: Optional list of users for which local sessions need to be returned.\n * allUsers: Optional boolean value to specify whether to return local sessions for all users or not.\n */\n";
+    readonly snippet: "{\n  allUsers: ${1:false},\n  users: [\n    { user: '${2:string}', db: '${3:string}' }\n  ]\n}";
 })[];
 export { STAGE_OPERATORS, STAGE_OPERATOR_NAMES, OUT_STAGES, FULL_SCAN_STAGES, REQUIRED_AS_FIRST_STAGE, };
 //# sourceMappingURL=stage-operators.d.ts.map

dist/stage-operators.js

@@ -971,2 +971,94 @@ "use strict";
     },
+    {
+        name: '$changeStream',
+        value: '$changeStream',
+        label: '$changeStream',
+        outputStage: false,
+        fullScan: false,
+        firstStage: true,
+        score: 1,
+        env: [env_1.ATLAS, env_1.ON_PREM],
+        meta: 'stage',
+        version: '4.2.0',
+        apiVersions: [1],
+        namespaces: [ns_1.DATABASE],
+        description: 'Returns a Change Stream cursor for the collection.',
+        comment: `/**
+ * allChangesForCluster: Optional boolean to include all changes in the cluster.
+ * fullDocument: Optional value to request a copy of full document when modified by update operations (Introduced in 6.0).
+ * fullDocumentBeforeChange: Value to configure whether to return a full document before the change or not.
+ * resumeAfter: Specifies a resume token as the logical starting point for the change stream. Cannot be used with startAfter or startAtOperationTime fields.
+ * showExpandedEvents: Specifies whether to include additional change events, such as such as DDL and index operations (Introduced in 6.0).
+ * startAfter: Specifies a resume token as the logical starting point for the change stream. Cannot be used with resumeAfter or startAtOperationTime fields.
+ * startAtOperationTime: Specifies a time as the logical starting point for the change stream. Cannot be used with resumeAfter or startAfter fields.
+ */
+`,
+        snippet: `{
+  allChangesForCluster: \${1:boolean},
+  fullDocument: '\${2:string}',
+  fullDocumentBeforeChange: '\${3:string}',
+  resumeAfter: \${4:resumeToken},
+  showExpandedEvents: \${5:boolean},
+  startAfter: \${6:resumeToken},
+  startAtOperationTime: \${7:time},
+}`,
+    },
+    {
+        name: '$currentOp',
+        value: '$currentOp',
+        label: '$currentOp',
+        outputStage: false,
+        fullScan: false,
+        firstStage: true,
+        score: 1,
+        env: [env_1.ATLAS, env_1.ADL, env_1.ON_PREM],
+        meta: 'stage',
+        version: '3.6.0',
+        apiVersions: [1],
+        namespaces: [ns_1.DATABASE],
+        description: 'Returns a cursor over information on active and/or dormant operations for the MongoDB deployment as well as inactive sessions that are holding locks as part of a transaction.',
+        comment: `/**
+ * allUsers: Optional boolean value to specify whether to return operations for all users or not.
+ * idleConnections: Optional boolean value to specify whether to return all operations including idle connections or not.
+ * idleCursors: Optional boolean value to specify whether to report on cursors that are idle or not.
+ * idleSessions: Optional boolean value to specify whether to report on dormant sessions or not.
+ * localOps: Optional boolean value to specify whether to report on operations running locally on targetted mongos or not.
+ * backtrace: Optional boolean value to specify whether callstack information is returned as part of the waitingForLatch output field.
+ */
+`,
+        snippet: `{
+  allUsers: \${1:false},
+  idleConnections: \${2:false},
+  idleCursors: \${3:false},
+  idleSessions: \${4:true},
+  localOps: \${5:false},
+  backtrace: \${6:false},
+}`,
+    },
+    {
+        name: '$listLocalSessions',
+        value: '$listLocalSessions',
+        label: '$listLocalSessions',
+        outputStage: false,
+        fullScan: false,
+        firstStage: true,
+        score: 1,
+        env: [env_1.ATLAS, env_1.ON_PREM],
+        meta: 'stage',
+        version: '3.6.0',
+        apiVersions: [1],
+        namespaces: [ns_1.DATABASE],
+        description: 'Lists the sessions cached in memory by the mongod or mongos instance.',
+        comment: `/**
+ * users: Optional list of users for which local sessions need to be returned.
+ * allUsers: Optional boolean value to specify whether to return local sessions for all users or not.
+ */
+`,
+        snippet: `{
+  allUsers: \${1:false},
+  users: [
+    { user: '\${2:string}', db: '\${3:string}' }
+  ]
+}`,
+    },
 ];
@@ -973,0 +1065,0 @@ exports.STAGE_OPERATORS = STAGE_OPERATORS;

package.json

@@ -16,3 +16,3 @@ {
   "homepage": "https://github.com/mongodb-js/devtools-shared",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "repository": {
@@ -68,3 +68,3 @@ "type": "git",
   },
-  "gitHead": "991b944559ecfd36207a30d284bfb15641b2438c"
+  "gitHead": "a1abff10511dcae7f9869e0e354757424c1937d9"
 }

No alert changes

Improved metrics

Total package byte prevSize

238407

increased by6.01%

Lines of code

5555

increased by3.73%

No dependency changes