Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@mongodb-js/mongodb-constants
Advanced tools
@mongodb-js/mongodb-constants - npm Package Compare versions
Comparing version 0.8.6 to 0.8.7
@@ -50,2 +50,18 @@ declare const STAGE_OPERATORS: readonly [{ | ||
| }, { | ||
| 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: "$collStats"; | ||
@@ -83,2 +99,18 @@ readonly value: "$collStats"; | ||
| }, { | ||
| 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: "$densify"; | ||
@@ -228,2 +260,18 @@ readonly value: "$densify"; | ||
| }, { | ||
| 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}"; | ||
| }, { | ||
| readonly name: "$lookup"; | ||
@@ -357,5 +405,5 @@ readonly value: "$lookup"; | ||
| }, { | ||
| readonly name: "$replaceWith"; | ||
| readonly value: "$replaceWith"; | ||
| readonly label: "$replaceWith"; | ||
| readonly name: "$replaceRoot"; | ||
| readonly value: "$replaceRoot"; | ||
| readonly label: "$replaceRoot"; | ||
| readonly outputStage: false; | ||
@@ -367,3 +415,3 @@ readonly fullScan: false; | ||
| readonly meta: "stage"; | ||
| readonly version: "4.2.0"; | ||
| readonly version: "3.4.0"; | ||
| readonly apiVersions: readonly [1]; | ||
@@ -373,7 +421,7 @@ readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; | ||
| readonly comment: "/**\n * replacementDocument: A document or string.\n */\n"; | ||
| readonly snippet: "{\n newWith: ${1:replacementDocument}\n}"; | ||
| readonly snippet: "{\n newRoot: ${1:replacementDocument}\n}"; | ||
| }, { | ||
| readonly name: "$replaceRoot"; | ||
| readonly value: "$replaceRoot"; | ||
| readonly label: "$replaceRoot"; | ||
| readonly name: "$replaceWith"; | ||
| readonly value: "$replaceWith"; | ||
| readonly label: "$replaceWith"; | ||
| readonly outputStage: false; | ||
@@ -385,3 +433,3 @@ readonly fullScan: false; | ||
| readonly meta: "stage"; | ||
| readonly version: "3.4.0"; | ||
| readonly version: "4.2.0"; | ||
| readonly apiVersions: readonly [1]; | ||
@@ -391,3 +439,3 @@ readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; | ||
| readonly comment: "/**\n * replacementDocument: A document or string.\n */\n"; | ||
| readonly snippet: "{\n newRoot: ${1:replacementDocument}\n}"; | ||
| readonly snippet: "{\n newWith: ${1:replacementDocument}\n}"; | ||
| }, { | ||
@@ -442,18 +490,2 @@ readonly name: "$sample"; | ||
| }, { | ||
| readonly name: "$vectorSearch"; | ||
| readonly value: "$vectorSearch"; | ||
| readonly label: "$vectorSearch"; | ||
| readonly outputStage: false; | ||
| readonly fullScan: false; | ||
| readonly firstStage: true; | ||
| readonly score: 1; | ||
| readonly env: readonly ["atlas"]; | ||
| readonly meta: "stage"; | ||
| readonly version: ">=6.0.10 <7.0.0 || >=7.0.2"; | ||
| readonly apiVersions: readonly []; | ||
| readonly namespaces: readonly ["coll"]; | ||
| readonly description: "Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`."; | ||
| readonly comment: "/**\n * queryVector: Array of numbers of BSON types `int` or `double` that represent the query vector. The array size must match the number of vector dimensions specified in the index for the field. (Required)\n * path: The field to search. (Required)\n * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (`limit`) to increase accuracy. (Required)\n * index: Name of the Atlas Search index to use. (Required)\n * limit: Number (of type `int` only) of documents to return in the results. (Required)\n * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional)\n */\n"; | ||
| readonly snippet: "{\n queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n path: ${3:string},\n numCandidates: ${4:numCandidates},\n index: ${5:string},\n limit: ${6:limit},\n filter: {${7:expression}}\n}"; | ||
| }, { | ||
| readonly name: "$set"; | ||
@@ -587,5 +619,5 @@ readonly value: "$set"; | ||
| }, { | ||
| readonly name: "$changeStream"; | ||
| readonly value: "$changeStream"; | ||
| readonly label: "$changeStream"; | ||
| readonly name: "$vectorSearch"; | ||
| readonly value: "$vectorSearch"; | ||
| readonly label: "$vectorSearch"; | ||
| readonly outputStage: false; | ||
@@ -595,44 +627,12 @@ readonly fullScan: false; | ||
| readonly score: 1; | ||
| readonly env: readonly ["atlas", "on-prem"]; | ||
| readonly env: readonly ["atlas"]; | ||
| 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}"; | ||
| readonly version: ">=6.0.10 <7.0.0 || >=7.0.2"; | ||
| readonly apiVersions: readonly []; | ||
| readonly namespaces: readonly ["coll"]; | ||
| readonly description: "Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`."; | ||
| readonly comment: "/**\n * queryVector: Array of numbers of BSON types `int` or `double` that represent the query vector. The array size must match the number of vector dimensions specified in the index for the field. (Required)\n * path: The field to search. (Required)\n * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (`limit`) to increase accuracy. (Required)\n * index: Name of the Atlas Search index to use. (Required)\n * limit: Number (of type `int` only) of documents to return in the results. (Required)\n * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional)\n */\n"; | ||
| readonly snippet: "{\n queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n path: ${3:string},\n numCandidates: ${4:numCandidates},\n index: ${5:string},\n limit: ${6:limit},\n filter: {${7:expression}}\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" | "$vectorSearch" | "$set" | "$setWindowFields" | "$skip" | "$sort" | "$sortByCount" | "$unionWith" | "$unset" | "$unwind" | "$changeStream" | "$currentOp" | "$listLocalSessions")[]; | ||
| declare const STAGE_OPERATOR_NAMES: ("$count" | "$addFields" | "$bucket" | "$bucketAuto" | "$changeStream" | "$collStats" | "$currentOp" | "$densify" | "$documents" | "$facet" | "$fill" | "$geoNear" | "$graphLookup" | "$group" | "$indexStats" | "$limit" | "$listLocalSessions" | "$lookup" | "$match" | "$merge" | "$out" | "$project" | "$redact" | "$replaceRoot" | "$replaceWith" | "$sample" | "$search" | "$searchMeta" | "$set" | "$setWindowFields" | "$skip" | "$sort" | "$sortByCount" | "$unionWith" | "$unset" | "$unwind" | "$vectorSearch")[]; | ||
| declare const OUT_STAGES: ({ | ||
@@ -753,2 +753,18 @@ readonly name: "$merge"; | ||
| declare const REQUIRED_AS_FIRST_STAGE: ({ | ||
| 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: "$collStats"; | ||
@@ -770,2 +786,18 @@ readonly value: "$collStats"; | ||
| } | { | ||
| 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: "$documents"; | ||
@@ -803,2 +835,18 @@ readonly value: "$documents"; | ||
| } | { | ||
| 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}"; | ||
| } | { | ||
| readonly name: "$vectorSearch"; | ||
@@ -819,52 +867,4 @@ readonly value: "$vectorSearch"; | ||
| readonly snippet: "{\n queryVector: [${1:dimension1}, ${2:dimension2}, ...],\n path: ${3:string},\n numCandidates: ${4:numCandidates},\n index: ${5:string},\n limit: ${6:limit},\n filter: {${7:expression}}\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}"; | ||
| })[]; | ||
| export { STAGE_OPERATORS, STAGE_OPERATOR_NAMES, OUT_STAGES, FULL_SCAN_STAGES, REQUIRED_AS_FIRST_STAGE, }; | ||
| //# sourceMappingURL=stage-operators.d.ts.map |
@@ -95,2 +95,36 @@ "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: '$collStats', | ||
@@ -142,2 +176,34 @@ value: '$collStats', | ||
| { | ||
| 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: '$densify', | ||
@@ -391,2 +457,28 @@ value: '$densify', | ||
| { | ||
| 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}' } | ||
| ] | ||
| }`, | ||
| }, | ||
| { | ||
| name: '$lookup', | ||
@@ -620,5 +712,5 @@ value: '$lookup', | ||
| { | ||
| name: '$replaceWith', | ||
| value: '$replaceWith', | ||
| label: '$replaceWith', | ||
| name: '$replaceRoot', | ||
| value: '$replaceRoot', | ||
| label: '$replaceRoot', | ||
| outputStage: false, | ||
@@ -630,3 +722,3 @@ fullScan: false, | ||
| meta: 'stage', | ||
| version: '4.2.0', | ||
| version: '3.4.0', | ||
| apiVersions: [1], | ||
@@ -640,9 +732,9 @@ namespaces: [...ns_1.ANY_NAMESPACE], | ||
| snippet: `{ | ||
| newWith: \${1:replacementDocument} | ||
| newRoot: \${1:replacementDocument} | ||
| }`, | ||
| }, | ||
| { | ||
| name: '$replaceRoot', | ||
| value: '$replaceRoot', | ||
| label: '$replaceRoot', | ||
| name: '$replaceWith', | ||
| value: '$replaceWith', | ||
| label: '$replaceWith', | ||
| outputStage: false, | ||
@@ -654,3 +746,3 @@ fullScan: false, | ||
| meta: 'stage', | ||
| version: '3.4.0', | ||
| version: '4.2.0', | ||
| apiVersions: [1], | ||
@@ -664,3 +756,3 @@ namespaces: [...ns_1.ANY_NAMESPACE], | ||
| snippet: `{ | ||
| newRoot: \${1:replacementDocument} | ||
| newWith: \${1:replacementDocument} | ||
| }`, | ||
@@ -775,34 +867,2 @@ }, | ||
| { | ||
| name: '$vectorSearch', | ||
| value: '$vectorSearch', | ||
| label: '$vectorSearch', | ||
| outputStage: false, | ||
| fullScan: false, | ||
| firstStage: true, | ||
| score: 1, | ||
| env: [env_1.ATLAS], | ||
| meta: 'stage', | ||
| version: '>=6.0.10 <7.0.0 || >=7.0.2', | ||
| apiVersions: [], | ||
| namespaces: [ns_1.COLLECTION], | ||
| description: 'Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`.', | ||
| comment: `/** | ||
| * queryVector: Array of numbers of BSON types \`int\` or \`double\` that represent the query vector. The array size must match the number of vector dimensions specified in the index for the field. (Required) | ||
| * path: The field to search. (Required) | ||
| * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (\`limit\`) to increase accuracy. (Required) | ||
| * index: Name of the Atlas Search index to use. (Required) | ||
| * limit: Number (of type \`int\` only) of documents to return in the results. (Required) | ||
| * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional) | ||
| */ | ||
| `, | ||
| snippet: `{ | ||
| queryVector: [\${1:dimension1}, \${2:dimension2}, ...], | ||
| path: \${3:string}, | ||
| numCandidates: \${4:numCandidates}, | ||
| index: \${5:string}, | ||
| limit: \${6:limit}, | ||
| filter: {\${7:expression}} | ||
| }`, | ||
| }, | ||
| { | ||
| name: '$set', | ||
@@ -1012,5 +1072,5 @@ value: '$set', | ||
| { | ||
| name: '$changeStream', | ||
| value: '$changeStream', | ||
| label: '$changeStream', | ||
| name: '$vectorSearch', | ||
| value: '$vectorSearch', | ||
| label: '$vectorSearch', | ||
| outputStage: false, | ||
@@ -1020,86 +1080,26 @@ fullScan: false, | ||
| score: 1, | ||
| env: [env_1.ATLAS, env_1.ON_PREM], | ||
| env: [env_1.ATLAS], | ||
| meta: 'stage', | ||
| version: '4.2.0', | ||
| apiVersions: [1], | ||
| namespaces: [ns_1.DATABASE], | ||
| description: 'Returns a Change Stream cursor for the collection.', | ||
| version: '>=6.0.10 <7.0.0 || >=7.0.2', | ||
| apiVersions: [], | ||
| namespaces: [ns_1.COLLECTION], | ||
| description: 'Performs a kNN search on a vector in the specified field or fields. The field that you want to search must be covered by an Atlas Search index of type `vectorEmbedding`.', | ||
| 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. | ||
| * queryVector: Array of numbers of BSON types \`int\` or \`double\` that represent the query vector. The array size must match the number of vector dimensions specified in the index for the field. (Required) | ||
| * path: The field to search. (Required) | ||
| * numCandidates: Number of nearest neighbors to use during the search. You can specify a number higher than the number of documents to return (\`limit\`) to increase accuracy. (Required) | ||
| * index: Name of the Atlas Search index to use. (Required) | ||
| * limit: Number (of type \`int\` only) of documents to return in the results. (Required) | ||
| * filter: Any MongoDB Query Language (MQL) match expression that compares an indexed field with a boolean, number (not decimals), or string to use as a prefilter. (Optional) | ||
| */ | ||
| `, | ||
| snippet: `{ | ||
| allChangesForCluster: \${1:boolean}, | ||
| fullDocument: '\${2:string}', | ||
| fullDocumentBeforeChange: '\${3:string}', | ||
| resumeAfter: \${4:resumeToken}, | ||
| showExpandedEvents: \${5:boolean}, | ||
| startAfter: \${6:resumeToken}, | ||
| startAtOperationTime: \${7:time}, | ||
| queryVector: [\${1:dimension1}, \${2:dimension2}, ...], | ||
| path: \${3:string}, | ||
| numCandidates: \${4:numCandidates}, | ||
| index: \${5:string}, | ||
| limit: \${6:limit}, | ||
| filter: {\${7:expression}} | ||
| }`, | ||
| }, | ||
| { | ||
| 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}' } | ||
| ] | ||
| }`, | ||
| }, | ||
| ]; | ||
@@ -1106,0 +1106,0 @@ exports.STAGE_OPERATORS = STAGE_OPERATORS; |
@@ -16,3 +16,3 @@ { | ||
| "homepage": "https://github.com/mongodb-js/devtools-shared", | ||
| "version": "0.8.6", | ||
| "version": "0.8.7", | ||
| "repository": { | ||
@@ -72,3 +72,3 @@ "type": "git", | ||
| }, | ||
| "gitHead": "f01bcebd2209c792da0365ba258a3dba82d6f9e8" | ||
| "gitHead": "0976b0f598e732484d7b87338847d9491a2911bf" | ||
| } |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No metric changes
No dependency changes