declare const STAGE_OPERATORS: readonly [{ readonly name: "$addFields"; readonly value: "$addFields"; readonly label: "$addFields"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Adds new field(s) to a document with a computed value, or reassigns an existing field(s) with a computed value."; readonly comment: "/**\n * newField: The new field name.\n * expression: The new field expression.\n */\n"; readonly snippet: "{\n ${1:newField}: ${2:expression}, ${3:...}\n}"; }, { readonly name: "$bucket"; readonly value: "$bucket"; readonly label: "$bucket"; readonly outputStage: false; readonly fullScan: true; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Categorizes incoming documents into groups, called buckets, based on specified boundaries."; readonly comment: "/**\n * groupBy: The expression to group by.\n * boundaries: An array of the lower boundaries for each bucket.\n * default: The bucket name for documents that do not fall within the specified boundaries\n * output: {\n * outputN: Optional. The output object may contain a single or numerous field names used to accumulate values per bucket.\n * }\n */\n"; readonly snippet: "{\n groupBy: ${1:expression},\n boundaries: [ ${2:lowerbound}, ${3:...} ],\n default: ${4:literal},\n output: {\n ${5:outputN}: { ${6:accumulator} }, ${7:...}\n }\n}"; }, { readonly name: "$bucketAuto"; readonly value: "$bucketAuto"; readonly label: "$bucketAuto"; readonly outputStage: false; readonly fullScan: true; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Automatically categorizes documents into a specified number of buckets, attempting even distribution if possible."; readonly comment: "/**\n * groupBy: The expression to group by.\n * buckets: The desired number of buckets\n * output: {\n * outputN: Optional. The output object may contain a single or numerous field names used to accumulate values per bucket.\n * }\n * granularity: Optional number series\n */\n"; readonly snippet: "{\n groupBy: ${1:expression},\n buckets: ${2:number},\n output: {\n ${3:outputN}: ${4:accumulator}, ${5:...}\n },\n granularity: '${6:string}'\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: "$changeStreamSplitLargeEvent"; readonly value: "$changeStreamSplitLargeEvent"; readonly label: "$changeStreamSplitLargeEvent"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "7.0.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db"]; readonly description: "Splits large change stream events that exceed 16MB into smaller fragments returned as separate events."; readonly comment: "/**\n * No additional options required.\n */\n"; readonly snippet: "{}"; }, { readonly name: "$collStats"; readonly value: "$collStats"; readonly label: "$collStats"; 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.4.0"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll", "view", "timeseries"]; readonly description: "Returns statistics regarding a collection or view."; readonly comment: "/**\n * histograms: Optional latency histograms.\n * storageStats: Optional storage stats.\n */\n"; readonly snippet: "{\n latencyStats: {\n histograms: ${1:boolean}\n },\n storageStats: {${2:}},\n}"; }, { readonly name: "$count"; readonly value: "$count"; readonly label: "$count"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Returns a count of the number of documents at this stage of the aggregation pipeline."; readonly comment: "/**\n * Provide the field name for the count.\n */\n"; readonly snippet: "'${1:string}'"; }, { 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"; readonly value: "$densify"; readonly label: "$densify"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "5.1.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Creates new documents to eliminate the gaps in the time or numeric domain at the required granularity level."; readonly comment: "/**\n * field: The required field to densify.\n * partitionByFields: The set of fields that acts as a compound key to define each partition.\n * range: {\n * step: The amount to increment the field value in each document.\n * unit: If specified field must evaluate to a date for every document in the collection, otherwise must evaluate to a numeric.\n * bounds: A string or array of numeric/date bounds, corresponding to the type of the field.\n * }\n */\n"; readonly snippet: "{\n field: ${1:string},\n partitionByFields: [${2:string}, ${3:string}, ...],\n range: {\n step: ${4:number},\n unit: ${5:string},\n bounds: [${6:lowerbound}, ${7:upperbound}, ...]\n }\n}"; }, { readonly name: "$documents"; readonly value: "$documents"; readonly label: "$documents"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: true; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "4.4.9"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db"]; readonly description: "Returns literal documents from input values."; readonly comment: "/**\n * expression: Any valid expression.\n */\n"; readonly snippet: "{\n ${1:expression}\n}"; }, { readonly name: "$facet"; readonly value: "$facet"; readonly label: "$facet"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Allows for multiple parellel aggregations to be specified."; readonly comment: "/**\n * outputFieldN: The first output field.\n * stageN: The first aggregation stage.\n */\n"; readonly snippet: "{\n ${1:outputFieldN}: [ ${2:stageN}, ${3:...} ]\n}"; }, { readonly name: "$fill"; readonly value: "$fill"; readonly label: "$fill"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "5.3.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Populates null and missing field values within documents."; readonly comment: "/**\n * sortBy: Syntax is the same as $sort, required if \"method\" is used in at least one output spec otherwise optional\n * partitionBy: Optional, default is a single partition. Specification is the same as _id in $group (same as partitionBy in window functions).\n * partitionByFields: Optional, set of fields that acts as a compound key to define each partition.\n * output - Required, object for each field to fill in. For a single field, can be a single object.\n * output. - A field to be filled with value, if missing or null in the current document.\n */\n"; readonly snippet: "{\n sortBy: ${1:sortSpec},\n partitionBy: ${2:expression},\n partitionByFields: [${3:string}, ${4:string}, ...],\n output: {\n field1: {value: ${5:expression}},\n field2: {method: ${6:string}},\n ...\n }\n}"; }, { readonly name: "$geoNear"; readonly value: "$geoNear"; readonly label: "$geoNear"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Returns documents based on proximity to a geospatial point."; readonly comment: "/**\n * near: The point to search near.\n * distanceField: The calculated distance.\n * maxDistance: The maximum distance, in meters, documents can be before being excluded from results.\n * query: Limits results that match the query\n * includeLocs: Optional. Labels and includes the point used to match the document.\n * num: Optional. The maximum number of documents to return.\n * spherical: Defaults to false. Specifies whether to use spherical geometry.\n */\n"; readonly snippet: "{\n near: { type: 'Point', coordinates: [ ${1:number}, ${2:number} ] },\n distanceField: '${3:string}',\n maxDistance: ${4:number},\n query: {${5}},\n includeLocs: '${6}',\n num: ${7:number},\n spherical: ${8:boolean}\n}"; }, { readonly name: "$graphLookup"; readonly value: "$graphLookup"; readonly label: "$graphLookup"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Performs a recursive search on a collection."; readonly comment: "/**\n * from: The target collection.\n * startWith: Expression to start.\n * connectFromField: Field to connect.\n * connectToField: Field to connect to.\n * as: Name of the array field.\n * maxDepth: Optional max recursion depth.\n * depthField: Optional Name of the depth field.\n * restrictSearchWithMatch: Optional query.\n */\n"; readonly snippet: "{\n from: '${1:string}',\n startWith: ${2:expression},\n connectFromField: '${3:string}',\n connectToField: '${4:string}',\n as: '${5:string}',\n maxDepth: ${6:number},\n depthField: '${7:string}',\n restrictSearchWithMatch: {${8}}\n}"; }, { readonly name: "$group"; readonly value: "$group"; readonly label: "$group"; readonly outputStage: false; readonly fullScan: true; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Groups documents by a specified expression."; readonly comment: "/**\n * _id: The id of the group.\n * fieldN: The first field name.\n */\n"; readonly snippet: "{\n _id: ${1:expression},\n ${2:fieldN}: {\n ${3:accumulatorN}: ${4:expressionN}\n }\n}"; }, { readonly name: "$indexStats"; readonly value: "$indexStats"; readonly label: "$indexStats"; 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.2.0"; readonly apiVersions: readonly []; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Returns statistics regarding the use of each index for the collection."; readonly comment: "/**\n * No parameters.\n */\n"; readonly snippet: "{}"; }, { readonly name: "$limit"; readonly value: "$limit"; readonly label: "$limit"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Limits the number of documents that flow into subsequent stages."; readonly comment: "/**\n * Provide the number of documents to limit.\n */\n"; readonly snippet: "${1:number}"; }, { 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: "$listSearchIndexes"; readonly value: "$listSearchIndexes"; readonly label: "$listSearchIndexes"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: true; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "7.0.0"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll"]; readonly description: "Returns information about existing Atlas Search and Atlas Vector Search indexes on a specified collection."; readonly comment: "/**\n * name: Optional. The name of the index to return information for.\n * id: Optional. The id of the index to return information for.\n */\n"; readonly snippet: "{\n name: '${1:indexName}'\n}"; }, { readonly name: "$lookup"; readonly value: "$lookup"; readonly label: "$lookup"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Performs a join between two collections."; readonly comment: "/**\n * from: The target collection.\n * localField: The local join field.\n * foreignField: The target join field.\n * as: The name for the results.\n * pipeline: Optional pipeline to run on the foreign collection.\n * let: Optional variables to use in the pipeline field stages.\n */\n"; readonly snippet: "{\n from: ${1:collection},\n localField: ${2:field},\n foreignField: ${3:field},\n as: ${4:result}\n}"; }, { readonly name: "$match"; readonly value: "$match"; readonly label: "$match"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Filters the document stream to allow only matching documents to pass through to subsequent stages."; readonly comment: "/**\n * query: The query in MQL.\n */\n"; readonly snippet: "{\n ${1:query}\n}"; }, { readonly name: "$merge"; readonly value: "$merge"; readonly label: "$merge"; readonly outputStage: true; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "4.1.11"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Merges the resulting documents into a collection, optionally overriding existing documents."; readonly comment: "/**\n * into: The target collection.\n * on: Fields to identify.\n * let: Defined variables.\n * whenMatched: Action for matching docs.\n * whenNotMatched: Action for non-matching docs.\n */\n"; readonly snippet: "{\n into: '${1:string}',\n on: '${2:string}',\n let: '${3:specification(s)}',\n whenMatched: '${4:string}',\n whenNotMatched: '${5:string}'\n}"; }, { readonly name: "$merge"; readonly value: "$merge"; readonly label: "$merge"; readonly outputStage: true; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["adl"]; readonly meta: "stage"; readonly version: "4.0.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Merges the resulting documents into a collection, optionally overriding existing documents."; readonly comment: "/**\n * atlas: Location to write the documents from the aggregation pipeline.\n * on: Fields to identify.\n * let: Defined variables.\n * whenMatched: Action for matching docs.\n * whenNotMatched: Action for non-matching docs.\n */\n"; readonly snippet: "{\n into: {\n atlas: {\n clusterName: '${1:atlasClusterName}',\n db: '${2:database}',\n coll: '${3:collection}',\n projectId: '${4:optionalAtlasProjectId}'\n }\n },\n on: '${5:identifier}',\n let: { ${6:specification(s)} },\n whenMatched: '${7:string}',\n whenNotMatched: '${8:string}'\n}"; }, { readonly name: "$out"; readonly value: "$out"; readonly label: "$out"; readonly outputStage: true; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Writes the result of a pipeline to a new or existing collection."; readonly comment: "/**\n * Provide the name of the output database and collection.\n */\n"; readonly snippet: "'${1:string}'"; }, { readonly name: "$out"; readonly value: "$out"; readonly label: "$out"; readonly outputStage: true; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["adl"]; readonly meta: "stage"; readonly version: "4.0.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Writes the result of a pipeline to an Atlas cluster, S3 bucket, or Azure Blob Storage."; readonly comment: "/**\n * Use any one of the following:\n * s3: Parameters to save the data to S3.\n * atlas: Parameters to save the data to Atlas. Example:\n * {\n * atlas: {\n * db: 'string',\n * coll: 'string',\n * projectId: 'string',\n * clusterName: 'string'\n * }\n * },\n * azure: Parameters to save the data to Azure. Example:\n * {\n * azure: {\n * serviceURL: 'string',\n * containerName: 'string',\n * region: 'string,\n * filename: 'string',\n * format: {\n * name: 'string',\n * maxFileSize: 'string',\n * maxRowGroupSize: 'string',\n * columnCompression: 'string'\n * },\n * errorMode: 'string'\n * }\n * }\n */\n"; readonly snippet: "{\n s3: '${1:s3url}',\n atlas: {\n db: '${2:db}',\n coll: '${3:coll}',\n projectId: '${4:projectId}',\n clusterName: '${5:clusterName}'\n }\n}"; }, { readonly name: "$project"; readonly value: "$project"; readonly label: "$project"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Adds new field(s) to a document with a computed value, or reassigns an existing field(s) with a computed value. Unlike $addFields, $project can also remove fields."; readonly comment: "/**\n * specifications: The fields to\n * include or exclude.\n */\n"; readonly snippet: "{\n ${1:specification(s)}\n}"; }, { readonly name: "$rankFusion"; readonly value: "$rankFusion"; readonly label: "$rankFusion"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas"]; readonly meta: "stage"; readonly version: "8.0.14"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll"]; readonly description: "Combines multiple pipelines using reciprocal rank fusion to create hybrid search results."; readonly comment: "/**\n * input.pipelines: Required. Map from name to input pipeline. Each pipeline must be a Ranked Selection Pipeline operating on the same collection. Minimum of one pipeline.\n * combination.weights: Optional. Map from pipeline name to numbers (non-negative). If unspecified, default weight is 1 for each pipeline.\n * scoreDetails: Optional. Default false. Set to true to include detailed scoring information in {$meta: \"scoreDetails\"} for debugging and tuning.\n */\n"; readonly snippet: "{\n input: {\n pipelines: {\n ${1:searchPipeline}: [\n {$search: {${2:searchStage}}},\n {$limit: ${3:limit}}\n ],\n ${4:vectorPipeline}: [\n {$vectorSearch: {${5:vectorSearchStage}}}\n ]\n }\n },\n combination: {\n weights: {\n ${6:searchPipeline}: ${7:number},\n ${8:vectorPipeline}: ${9:number}\n }\n },\n scoreDetails: ${10:false}\n}"; }, { readonly name: "$redact"; readonly value: "$redact"; readonly label: "$redact"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.6.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Restricts the content for each document based on information stored in the documents themselves"; readonly comment: "/**\n * expression: Any valid expression that\n * evaluates to $$DESCEND, $$PRUNE, or $$KEEP.\n */\n"; readonly snippet: "{\n ${1:expression}\n}"; }, { readonly name: "$replaceRoot"; readonly value: "$replaceRoot"; readonly label: "$replaceRoot"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Replaces a document with the specified embedded document."; readonly comment: "/**\n * replacementDocument: A document or string.\n */\n"; readonly snippet: "{\n newRoot: ${1:replacementDocument}\n}"; }, { readonly name: "$replaceWith"; readonly value: "$replaceWith"; readonly label: "$replaceWith"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "4.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Replaces a document with the specified embedded document."; readonly comment: "/**\n * replacementDocument: A document or string.\n */\n"; readonly snippet: "{\n newWith: ${1:replacementDocument}\n}"; }, { readonly name: "$rerank"; readonly value: "$rerank"; readonly label: "$rerank"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas"]; readonly meta: "stage"; readonly version: "4.1.11"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll"]; readonly description: "Use our best-in-class Voyage reranker models to rerank sets of documents from previous stages."; readonly comment: "/**\n * query.text: Query text for reranking. Supports reranking instructions for 2.5 series or newer.\n * path: Field(s) to rerank over\n * model: The reranker model to use (rerank-2.5, rerank-2.5-lite, rerank-2, rerank-2-lite)\n * numDocsToRerank: The maximum number of documents consumed and returned by the $rerank stage\n */\n"; readonly snippet: "{\n query: {\n text: ${1:string}\n },\n path: ${2:string},\n model: '${3:rerank-2.5}',\n numDocsToRerank: ${4:numDocsToRerank}\n}"; }, { readonly name: "$sample"; readonly value: "$sample"; readonly label: "$sample"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["coll", "view", "timeseries"]; readonly description: "Randomly selects the specified number of documents from its input."; readonly comment: "/**\n * size: The number of documents to sample.\n */\n"; readonly snippet: "{\n size: ${1:number}\n}"; }, { readonly name: "$score"; readonly value: "$score"; readonly label: "$score"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "8.2.0"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll"]; readonly description: "Computes and returns a new score as metadata. It also optionally normalizes the input scores, by default to a range between zero and one."; readonly comment: "/**\n * score: Required expression. Computes a new value from the input scores and stores the value in the $meta keyword score. Returns an error for non-numeric inputs.\n * scoreDetails: Optional. Default false. Set to true to include detailed scoring information in {$meta: \"scoreDetails\"} for debugging and tuning.\n * normalization: Optional. Default none. Normalizes the input scores before computing the new score. Value can be none, sigmoid or minMaxScaler.\n * weight: Optional. Default 1. Multiplies the computed score by the weight value. Returns an error for non-numeric inputs.\n */\n"; readonly snippet: "{\n score: ${1:expression},\n scoreDetails: ${2:false},\n normalization: \"${3:none|sigmoid|minMaxScaler}\",\n weight: ${4:number},\n}"; }, { readonly name: "$scoreFusion"; readonly value: "$scoreFusion"; readonly label: "$scoreFusion"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas"]; readonly meta: "stage"; readonly version: "8.2.0"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll"]; readonly description: "Combines multiple pipelines using relative score fusion to create hybrid search results."; readonly comment: "/**\n * input.pipelines: Required. Map from name to input pipeline. Each pipeline must be operating on the same collection. Minimum of one pipeline.\n * input.normalization: Required. Normalizes the score to the range 0 to 1 before combining the results. Value can be none, sigmoid or minMaxScaler.\n * combination.weights: Optional. Map from pipeline name to numbers (non-negative). If unspecified, default weight is 1 for each pipeline.\n * combination.method: Optional. Specifies method for combining scores. Value can be avg or expression. Default is avg.\n * combination.expression: Optional. This is the custom expression that is used when combination.method is set to expression.\n * scoreDetails: Optional. Default false. Set to true to include detailed scoring information.\n */\n"; readonly snippet: "{\n input: {\n pipelines: {\n ${1:searchPipeline}: [\n {$search: {${2:searchStage}}},\n {$limit: ${3:limit}}\n ],\n ${4:vectorPipeline}: [\n {$vectorSearch: {${5:vectorSearchStage}}}\n ]\n },\n normalization: '${6:none|sigmoid|minMaxScaler}'\n },\n combination: {\n weights: {\n ${7:searchPipeline}: ${8:number},\n ${9:vectorPipeline}: ${10:number}\n },\n method: '${11:avg|expression}',\n expression: '${12:expression}'\n },\n scoreDetails: ${13:false}\n}"; }, { readonly name: "$search"; readonly value: "$search"; readonly label: "$search"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "4.1.11"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll", "view"]; readonly description: "Performs a full-text search on the specified field(s)."; readonly comment: "/**\n * index: The name of the Search index.\n * text: Analyzed search, with required fields of query and path, the analyzed field(s) to search. Use matchCriteria to match 'any' or 'all' query terms.\n * compound: Combines ops.\n * span: Find in text field regions.\n * exists: Test for presence of a field.\n * near: Find near number or date.\n * range: Find in numeric or date range.\n */\n"; readonly snippet: "{\n index: '${1:string}',\n text: {\n query: '${2:string}',\n path: '${3:string}'\n }\n}"; }, { readonly name: "$searchMeta"; readonly value: "$searchMeta"; readonly label: "$searchMeta"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "4.4.9"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll", "view"]; readonly description: "Performs a full-text search on the specified field(s) and gets back only the generated search meta data from a query."; readonly comment: "/**\n * index: The name of the Search index.\n * count: The count of the results.\n * facet: {\n * operator: Analyzed search, with required fields of query and path, can either be replaced with the name of a valid operator.\n * facets: {\n * stringFacet: Narrows search results based on unique string values, with required fields of type and path.\n * numberFacet: Narrows search results by breaking them up into separate ranges of numbers, with required fields of type, path, and boundaries.\n * dateFacet: Narrows search results by breaking them up into separate ranges of dates, with required fields of type, path, and boundaries.\n * }\n * }\n */\n"; readonly snippet: "{\n index: ${1:string},\n facet: {\n operator: {\n text: {\n query: ${2:string},\n path: ${3:string}\n }\n },\n facets: {\n ${4:stringFacet}: {\n type: ${5:string},\n path: ${6:string},\n numBuckets: ${7:integer}\n },\n numberFacet: {\n type: 'number',\n path: ${8:string},\n boundaries: [${9:lowerbound}, ${10:upperbound}, ...],\n default: ${11:string}\n }\n }\n }\n}"; }, { readonly name: "$set"; readonly value: "$set"; readonly label: "$set"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "4.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Adds new fields to documents. $set outputs documents that contain all existing fields from the input documents and newly added fields."; readonly comment: "/**\n * field: The field name\n * expression: The expression.\n */\n"; readonly snippet: "{\n ${1:field}: ${2:expression}\n}"; }, { readonly name: "$setWindowFields"; readonly value: "$setWindowFields"; readonly label: "$setWindowFields"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "5.0.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Capable of partitioning incoming data, and can apply one or more functions to defined windows within each partition."; readonly comment: "/**\n * partitionBy: partitioning of data.\n * sortBy: fields to sort by.\n * output: {\n * path: {\n * function: The window function to compute over the given window.\n * window: {\n * documents: A number of documents before and after the current document.\n * range: A range of possible values around the value in the current document's sortBy field.\n * unit: Specifies the units for the window bounds.\n * }\n * }\n * }\n */\n"; readonly snippet: "{\n partitionBy: ${1:expression},\n sortBy: ${2:sortSpec},\n output: {\n ${3:path}: {\n ${4:function}: ${5:functionArgs},\n window: {\n documents: [${6:lowerbound}, ${7:upperbound}],\n range: [${8:lowerbound}, ${9:upperbound}],\n unit: ${10:string}\n }\n },\n ${11:path2}: ...\n }\n}"; }, { readonly name: "$skip"; readonly value: "$skip"; readonly label: "$skip"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Skips a specified number of documents before advancing to the next stage."; readonly comment: "/**\n * Provide the number of documents to skip.\n */\n"; readonly snippet: "${1:number}"; }, { readonly name: "$sort"; readonly value: "$sort"; readonly label: "$sort"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Reorders the document stream by a specified sort key and direction."; readonly comment: "/**\n * Provide any number of field/order pairs.\n */\n"; readonly snippet: "{\n ${1:field1}: ${2:sortOrder}\n}"; }, { readonly name: "$sortByCount"; readonly value: "$sortByCount"; readonly label: "$sortByCount"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Groups incoming documents based on the value of a specified expression, then computes the count of documents in each distinct group."; readonly comment: "/**\n * expression: Grouping expression or string.\n */\n"; readonly snippet: "{\n ${1:expression}\n}"; }, { readonly name: "$unionWith"; readonly value: "$unionWith"; readonly label: "$unionWith"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "4.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Perform a union with a pipeline on another collection."; readonly comment: "/**\n * coll: The collection name.\n * pipeline: The pipeline on the other collection.\n */\n"; readonly snippet: "{\n coll: '${1:coll}',\n pipeline: [${2:pipeline}]\n}"; }, { readonly name: "$unset"; readonly value: "$unset"; readonly label: "$unset"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "4.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Excludes fields from the result document."; readonly comment: "/**\n * Provide the field name to exclude.\n * To exclude multiple fields, pass the field names in an array.\n */\n"; readonly snippet: "'${1:string}'"; }, { readonly name: "$unwind"; readonly value: "$unwind"; readonly label: "$unwind"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Outputs a new document for each element in a specified array. "; readonly comment: "/**\n * path: Path to the array field.\n * includeArrayIndex: Optional name for index.\n * preserveNullAndEmptyArrays: Optional\n * toggle to unwind null and empty values.\n */\n"; readonly snippet: "{\n path: ${1:path},\n includeArrayIndex: '${2:string}',\n preserveNullAndEmptyArrays: ${3:boolean}\n}"; }, { 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", "on-prem"]; readonly meta: "stage"; readonly version: ">=6.0.10 <7.0.0 || >=7.0.2"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll", "view"]; readonly description: "Performs a kNN search on embeddings in the specified field(s)"; 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 * exact: Choose between false for ANN (Approximate Nearest Neighbor) and true for ENN (Exact Nearest Neighbor). Defaults to false. (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 exact: ${8:boolean}\n}"; }]; declare const VECTOR_SEARCH_AUTO_EMBED_STAGE: { name: string; value: string; label: string; outputStage: boolean; fullScan: boolean; firstStage: boolean; score: number; env: string[]; meta: string; version: string; apiVersions: never[]; namespaces: string[]; description: string; comment: string; snippet: string; }; declare const STAGE_OPERATOR_NAMES: ("$count" | "$addFields" | "$bucket" | "$bucketAuto" | "$changeStream" | "$changeStreamSplitLargeEvent" | "$collStats" | "$currentOp" | "$densify" | "$documents" | "$facet" | "$fill" | "$geoNear" | "$graphLookup" | "$group" | "$indexStats" | "$limit" | "$listLocalSessions" | "$listSearchIndexes" | "$lookup" | "$match" | "$merge" | "$out" | "$project" | "$rankFusion" | "$redact" | "$replaceRoot" | "$replaceWith" | "$rerank" | "$sample" | "$score" | "$scoreFusion" | "$search" | "$searchMeta" | "$set" | "$setWindowFields" | "$skip" | "$sort" | "$sortByCount" | "$unionWith" | "$unset" | "$unwind" | "$vectorSearch")[]; declare const OUT_STAGES: ({ readonly name: "$merge"; readonly value: "$merge"; readonly label: "$merge"; readonly outputStage: true; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "4.1.11"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Merges the resulting documents into a collection, optionally overriding existing documents."; readonly comment: "/**\n * into: The target collection.\n * on: Fields to identify.\n * let: Defined variables.\n * whenMatched: Action for matching docs.\n * whenNotMatched: Action for non-matching docs.\n */\n"; readonly snippet: "{\n into: '${1:string}',\n on: '${2:string}',\n let: '${3:specification(s)}',\n whenMatched: '${4:string}',\n whenNotMatched: '${5:string}'\n}"; } | { readonly name: "$merge"; readonly value: "$merge"; readonly label: "$merge"; readonly outputStage: true; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["adl"]; readonly meta: "stage"; readonly version: "4.0.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Merges the resulting documents into a collection, optionally overriding existing documents."; readonly comment: "/**\n * atlas: Location to write the documents from the aggregation pipeline.\n * on: Fields to identify.\n * let: Defined variables.\n * whenMatched: Action for matching docs.\n * whenNotMatched: Action for non-matching docs.\n */\n"; readonly snippet: "{\n into: {\n atlas: {\n clusterName: '${1:atlasClusterName}',\n db: '${2:database}',\n coll: '${3:collection}',\n projectId: '${4:optionalAtlasProjectId}'\n }\n },\n on: '${5:identifier}',\n let: { ${6:specification(s)} },\n whenMatched: '${7:string}',\n whenNotMatched: '${8:string}'\n}"; } | { readonly name: "$out"; readonly value: "$out"; readonly label: "$out"; readonly outputStage: true; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Writes the result of a pipeline to a new or existing collection."; readonly comment: "/**\n * Provide the name of the output database and collection.\n */\n"; readonly snippet: "'${1:string}'"; } | { readonly name: "$out"; readonly value: "$out"; readonly label: "$out"; readonly outputStage: true; readonly fullScan: false; readonly firstStage: false; readonly score: 1; readonly env: readonly ["adl"]; readonly meta: "stage"; readonly version: "4.0.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Writes the result of a pipeline to an Atlas cluster, S3 bucket, or Azure Blob Storage."; readonly comment: "/**\n * Use any one of the following:\n * s3: Parameters to save the data to S3.\n * atlas: Parameters to save the data to Atlas. Example:\n * {\n * atlas: {\n * db: 'string',\n * coll: 'string',\n * projectId: 'string',\n * clusterName: 'string'\n * }\n * },\n * azure: Parameters to save the data to Azure. Example:\n * {\n * azure: {\n * serviceURL: 'string',\n * containerName: 'string',\n * region: 'string,\n * filename: 'string',\n * format: {\n * name: 'string',\n * maxFileSize: 'string',\n * maxRowGroupSize: 'string',\n * columnCompression: 'string'\n * },\n * errorMode: 'string'\n * }\n * }\n */\n"; readonly snippet: "{\n s3: '${1:s3url}',\n atlas: {\n db: '${2:db}',\n coll: '${3:coll}',\n projectId: '${4:projectId}',\n clusterName: '${5:clusterName}'\n }\n}"; })[]; declare const FULL_SCAN_STAGES: ({ readonly name: "$bucket"; readonly value: "$bucket"; readonly label: "$bucket"; readonly outputStage: false; readonly fullScan: true; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Categorizes incoming documents into groups, called buckets, based on specified boundaries."; readonly comment: "/**\n * groupBy: The expression to group by.\n * boundaries: An array of the lower boundaries for each bucket.\n * default: The bucket name for documents that do not fall within the specified boundaries\n * output: {\n * outputN: Optional. The output object may contain a single or numerous field names used to accumulate values per bucket.\n * }\n */\n"; readonly snippet: "{\n groupBy: ${1:expression},\n boundaries: [ ${2:lowerbound}, ${3:...} ],\n default: ${4:literal},\n output: {\n ${5:outputN}: { ${6:accumulator} }, ${7:...}\n }\n}"; } | { readonly name: "$bucketAuto"; readonly value: "$bucketAuto"; readonly label: "$bucketAuto"; readonly outputStage: false; readonly fullScan: true; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "3.4.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Automatically categorizes documents into a specified number of buckets, attempting even distribution if possible."; readonly comment: "/**\n * groupBy: The expression to group by.\n * buckets: The desired number of buckets\n * output: {\n * outputN: Optional. The output object may contain a single or numerous field names used to accumulate values per bucket.\n * }\n * granularity: Optional number series\n */\n"; readonly snippet: "{\n groupBy: ${1:expression},\n buckets: ${2:number},\n output: {\n ${3:outputN}: ${4:accumulator}, ${5:...}\n },\n granularity: '${6:string}'\n}"; } | { readonly name: "$group"; readonly value: "$group"; readonly label: "$group"; readonly outputStage: false; readonly fullScan: true; readonly firstStage: false; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "2.2.0"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Groups documents by a specified expression."; readonly comment: "/**\n * _id: The id of the group.\n * fieldN: The first field name.\n */\n"; readonly snippet: "{\n _id: ${1:expression},\n ${2:fieldN}: {\n ${3:accumulatorN}: ${4:expressionN}\n }\n}"; })[]; 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"; readonly value: "$collStats"; readonly label: "$collStats"; 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.4.0"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll", "view", "timeseries"]; readonly description: "Returns statistics regarding a collection or view."; readonly comment: "/**\n * histograms: Optional latency histograms.\n * storageStats: Optional storage stats.\n */\n"; readonly snippet: "{\n latencyStats: {\n histograms: ${1:boolean}\n },\n storageStats: {${2:}},\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: "$documents"; readonly value: "$documents"; readonly label: "$documents"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: true; readonly score: 1; readonly env: readonly ["atlas", "adl", "on-prem"]; readonly meta: "stage"; readonly version: "4.4.9"; readonly apiVersions: readonly [1]; readonly namespaces: readonly ["db"]; readonly description: "Returns literal documents from input values."; readonly comment: "/**\n * expression: Any valid expression.\n */\n"; readonly snippet: "{\n ${1:expression}\n}"; } | { readonly name: "$indexStats"; readonly value: "$indexStats"; readonly label: "$indexStats"; 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.2.0"; readonly apiVersions: readonly []; readonly namespaces: readonly ["db", "coll", "view", "timeseries"]; readonly description: "Returns statistics regarding the use of each index for the collection."; readonly comment: "/**\n * No parameters.\n */\n"; readonly snippet: "{}"; } | { 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: "$listSearchIndexes"; readonly value: "$listSearchIndexes"; readonly label: "$listSearchIndexes"; readonly outputStage: false; readonly fullScan: false; readonly firstStage: true; readonly score: 1; readonly env: readonly ["atlas", "on-prem"]; readonly meta: "stage"; readonly version: "7.0.0"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll"]; readonly description: "Returns information about existing Atlas Search and Atlas Vector Search indexes on a specified collection."; readonly comment: "/**\n * name: Optional. The name of the index to return information for.\n * id: Optional. The id of the index to return information for.\n */\n"; readonly snippet: "{\n name: '${1:indexName}'\n}"; } | { 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", "on-prem"]; readonly meta: "stage"; readonly version: ">=6.0.10 <7.0.0 || >=7.0.2"; readonly apiVersions: readonly []; readonly namespaces: readonly ["coll", "view"]; readonly description: "Performs a kNN search on embeddings in the specified field(s)"; 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 * exact: Choose between false for ANN (Approximate Nearest Neighbor) and true for ENN (Exact Nearest Neighbor). Defaults to false. (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 exact: ${8:boolean}\n}"; })[]; export { STAGE_OPERATORS, STAGE_OPERATOR_NAMES, OUT_STAGES, FULL_SCAN_STAGES, REQUIRED_AS_FIRST_STAGE, VECTOR_SEARCH_AUTO_EMBED_STAGE, }; //# sourceMappingURL=stage-operators.d.ts.map