diff --git a/.gitattributes b/.gitattributes
index 75618ae42..7309afd20 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -22,5 +22,6 @@ rector.php export-ignore
/src/Builder/Accumulator/*.php linguist-generated=true
/src/Builder/Expression/*.php linguist-generated=true
/src/Builder/Query/*.php linguist-generated=true
+/src/Builder/Search/*.php linguist-generated=true
/src/Builder/Stage/*.php linguist-generated=true
/tests/Builder/*/Pipelines.php linguist-generated=true
diff --git a/generator/README.md b/generator/README.md
index 3e18976f9..02a3be4ec 100644
--- a/generator/README.md
+++ b/generator/README.md
@@ -42,6 +42,8 @@ Each operator can contain a `tests` section with a list if pipelines. To represe
| Int64 | `!bson_int64 '123456789'` |
| Decimal128 | `!bson_decimal128 '0.9'` |
| UTCDateTime | `!bson_utcdatetime 0` |
+| ObjectId | `!bson_ObjectId '5a9427648b0beebeb69589a1` |
| Binary | `!bson_binary 'IA=='` |
+| Binary UUID | `!bson_uuid 'fac32260-b511-4c69-8485-a2be5b7dda9e'` |
To add new test cases to operators, you can get inspiration from the official MongoDB documentation and use the `generator/js2yaml.html` web page to manually convert a pipeline array from JS to Yaml.
diff --git a/generator/composer.json b/generator/composer.json
index 2deb4ae95..c4dedcfb7 100644
--- a/generator/composer.json
+++ b/generator/composer.json
@@ -4,7 +4,7 @@
"repositories": [
{
"type": "path",
- "url": "../",
+ "url": "..",
"symlink": true
}
],
diff --git a/generator/config/definitions.php b/generator/config/definitions.php
index a4f952d39..06d9b44ed 100644
--- a/generator/config/definitions.php
+++ b/generator/config/definitions.php
@@ -58,4 +58,16 @@
OperatorTestGenerator::class,
],
],
+
+ // Search Operators
+ [
+ 'configFiles' => __DIR__ . '/search',
+ 'namespace' => 'MongoDB\\Builder\\Search',
+ 'classNameSuffix' => 'Operator',
+ 'generators' => [
+ OperatorClassGenerator::class,
+ OperatorFactoryGenerator::class,
+ OperatorTestGenerator::class,
+ ],
+ ],
];
diff --git a/generator/config/expressions.php b/generator/config/expressions.php
index f731234b2..a2c649e8e 100644
--- a/generator/config/expressions.php
+++ b/generator/config/expressions.php
@@ -109,6 +109,10 @@
'implements' => [ResolvesToAny::class],
'acceptedTypes' => ['string'],
],
+ 'searchOperator' => [
+ 'returnType' => Type\SearchOperatorInterface::class,
+ 'acceptedTypes' => [Type\SearchOperatorInterface::class, ...$bsonTypes['object']],
+ ],
'geometry' => [
'returnType' => Type\GeometryInterface::class,
'acceptedTypes' => [Type\GeometryInterface::class, ...$bsonTypes['object']],
@@ -168,4 +172,12 @@
'GeoPoint' => [
'acceptedTypes' => [...$bsonTypes['object']],
],
+
+ // Search
+ 'searchPath' => [
+ 'acceptedTypes' => ['string', 'array'],
+ ],
+ 'searchScore' => [
+ 'acceptedTypes' => [...$bsonTypes['object']],
+ ],
];
diff --git a/generator/config/schema.json b/generator/config/schema.json
index 8e2f5f320..c92e6ddb7 100644
--- a/generator/config/schema.json
+++ b/generator/config/schema.json
@@ -46,7 +46,8 @@
"resolvesToInt",
"resolvesToTimestamp",
"resolvesToLong",
- "resolvesToDecimal"
+ "resolvesToDecimal",
+ "searchOperator"
]
}
},
@@ -60,7 +61,8 @@
"enum": [
"array",
"object",
- "single"
+ "single",
+ "search"
]
},
"description": {
@@ -135,7 +137,8 @@
"resolvesToInt", "intFieldPath", "int",
"resolvesToTimestamp", "timestampFieldPath", "timestamp",
"resolvesToLong", "longFieldPath", "long",
- "resolvesToDecimal", "decimalFieldPath", "decimal"
+ "resolvesToDecimal", "decimalFieldPath", "decimal",
+ "searchPath", "searchScore", "searchOperator"
]
}
},
diff --git a/generator/config/search/autocomplete.yaml b/generator/config/search/autocomplete.yaml
new file mode 100644
index 000000000..a984b9a39
--- /dev/null
+++ b/generator/config/search/autocomplete.yaml
@@ -0,0 +1,152 @@
+# $schema: ../schema.json
+name: autocomplete
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The autocomplete operator performs a search for a word or phrase that
+ contains a sequence of characters from an incomplete input string. The
+ fields that you intend to query with the autocomplete operator must be
+ indexed with the autocomplete data type in the collection's index definition.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: query
+ type:
+ - string
+ -
+ name: tokenOrder
+ optional: true
+ type:
+ - string # any|sequential
+ -
+ name: fuzzy
+ optional: true
+ type:
+ - object
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Basic'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/#basic-example'
+ pipeline:
+ -
+ $search:
+ autocomplete:
+ query: 'off'
+ path: 'title'
+ -
+ $limit: 10
+ -
+ $project:
+ _id: 0
+ title: 1
+
+ -
+ name: 'Fuzzy'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/#fuzzy-example'
+ pipeline:
+ -
+ $search:
+ autocomplete:
+ query: 'pre'
+ path: 'title'
+ fuzzy:
+ maxEdits: 1
+ prefixLength: 1
+ maxExpansions: 256
+ -
+ $limit: 10
+ -
+ $project:
+ _id: 0
+ title: 1
+
+ -
+ name: 'Token Order any'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/#simple-any-example'
+ pipeline:
+ -
+ $search:
+ autocomplete:
+ query: 'men with'
+ path: 'title'
+ tokenOrder: 'any'
+ -
+ $limit: 4
+ -
+ $project:
+ _id: 0
+ title: 1
+
+ -
+ name: 'Token Order sequential'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/#simple-sequential-example'
+ pipeline:
+ -
+ $search:
+ autocomplete:
+ query: 'men with'
+ path: 'title'
+ tokenOrder: 'sequential'
+ -
+ $limit: 4
+ -
+ $project:
+ _id: 0
+ title: 1
+
+ -
+ name: 'Highlighting'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/#highlighting-example'
+ pipeline:
+ -
+ $search:
+ autocomplete:
+ query: 'ger'
+ path: 'title'
+ highlight:
+ path: 'title'
+ -
+ $limit: 5
+ -
+ $project:
+ score:
+ $meta: 'searchScore'
+ _id: 0
+ title: 1
+ highlights:
+ $meta: 'searchHighlights'
+
+ -
+ name: 'Across Multiple Fields'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/#search-across-multiple-fields'
+ pipeline:
+ -
+ $search:
+ compound:
+ should:
+ -
+ autocomplete:
+ query: 'inter'
+ path: 'title'
+ -
+ autocomplete:
+ query: 'inter'
+ path: 'plot'
+ minimumShouldMatch: 1
+ -
+ $limit: 10
+ -
+ $project:
+ _id: 0
+ title: 1
+ plot: 1
diff --git a/generator/config/search/compound.yaml b/generator/config/search/compound.yaml
new file mode 100644
index 000000000..7a1d9f419
--- /dev/null
+++ b/generator/config/search/compound.yaml
@@ -0,0 +1,156 @@
+# $schema: ../schema.json
+name: compound
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/compound/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The compound operator combines two or more operators into a single query.
+ Each element of a compound query is called a clause, and each clause
+ consists of one or more sub-queries.
+arguments:
+ -
+ name: must
+ optional: true
+ type:
+ - searchOperator
+ - array # of searchOperator
+ -
+ name: mustNot
+ optional: true
+ type:
+ - searchOperator
+ - array # of searchOperator
+ -
+ name: should
+ optional: true
+ type:
+ - searchOperator
+ - array # of searchOperator
+ -
+ name: filter
+ optional: true
+ type:
+ - searchOperator
+ - array # of searchOperator
+ -
+ name: minimumShouldMatch
+ optional: true
+ type:
+ - int
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'must and mustNot'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/compound/#must-and-mustnot-example'
+ pipeline:
+ -
+ $search:
+ compound:
+ must:
+ -
+ text:
+ query: 'varieties'
+ path: 'description'
+ mustNot:
+ -
+ text:
+ query: 'apples'
+ path: 'description'
+
+ -
+ name: 'must and should'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/compound/#must-and-should-example'
+ pipeline:
+ -
+ $search:
+ compound:
+ must:
+ -
+ text:
+ query: 'varieties'
+ path: 'description'
+ should:
+ -
+ text:
+ query: 'Fuji'
+ path: 'description'
+ -
+ $project:
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'minimumShouldMatch'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/compound/#minimumshouldmatch-example'
+ pipeline:
+ -
+ $search:
+ compound:
+ must:
+ -
+ text:
+ query: 'varieties'
+ path: 'description'
+ should:
+ -
+ text:
+ query: 'Fuji'
+ path: 'description'
+ -
+ text:
+ query: 'Golden Delicious'
+ path: 'description'
+ minimumShouldMatch: 1
+
+ -
+ name: 'Filter'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/compound/#filter-examples'
+ pipeline:
+ -
+ $search:
+ compound:
+ must:
+ -
+ text:
+ query: 'varieties'
+ path: 'description'
+ should:
+ -
+ text:
+ query: 'banana'
+ path: 'description'
+ filter:
+ -
+ text:
+ query: 'granny'
+ path: 'description'
+
+ -
+ name: 'Nested'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/compound/#nested-example'
+ pipeline:
+ -
+ $search:
+ compound:
+ should:
+ -
+ text:
+ query: 'apple'
+ path: 'type'
+ -
+ compound:
+ must:
+ -
+ text:
+ query: 'organic'
+ path: 'category'
+ -
+ equals:
+ value: true
+ path: 'in_stock'
+ minimumShouldMatch: 1
diff --git a/generator/config/search/embeddedDocument.yaml b/generator/config/search/embeddedDocument.yaml
new file mode 100644
index 000000000..19c804625
--- /dev/null
+++ b/generator/config/search/embeddedDocument.yaml
@@ -0,0 +1,155 @@
+# $schema: ../schema.json
+name: embeddedDocument
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/embedded-document/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The embeddedDocument operator is similar to $elemMatch operator.
+ It constrains multiple query predicates to be satisfied from a single
+ element of an array of embedded documents. embeddedDocument can be used only
+ for queries over fields of the embeddedDocuments
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: operator
+ type:
+ - searchOperator
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Basic'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/embedded-document/#index-definition'
+ pipeline:
+ -
+ $search:
+ embeddedDocument:
+ path: 'items'
+ operator:
+ compound:
+ must:
+ -
+ text:
+ path: 'items.tags'
+ query: 'school'
+ should:
+ -
+ text:
+ path: 'items.name'
+ query: 'backpack'
+ score:
+ embedded:
+ aggregate: 'mean'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ items.name: 1
+ items.tags: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Facet'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/embedded-document/#facet-query'
+ pipeline:
+ -
+ $searchMeta:
+ facet:
+ operator:
+ embeddedDocument:
+ path: 'items'
+ operator:
+ compound:
+ must:
+ -
+ text:
+ path: 'items.tags'
+ query: 'school'
+ should:
+ -
+ text:
+ path: 'items.name'
+ query: 'backpack'
+ facets:
+ purchaseMethodFacet:
+ type: 'string'
+ path: 'purchaseMethod'
+
+ -
+ name: 'Query and Sort'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/embedded-document/#query-and-sort'
+ pipeline:
+ -
+ $search:
+ embeddedDocument:
+ path: 'items'
+ operator:
+ text:
+ path: 'items.name'
+ query: 'laptop'
+ sort:
+ items.tags: 1
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ items.name: 1
+ items.tags: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Query for Matching Embedded Documents Only'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/embedded-document/#query-for-matching-embedded-documents-only'
+ pipeline:
+ -
+ $search:
+ embeddedDocument:
+ path: 'items'
+ operator:
+ compound:
+ must:
+ -
+ range:
+ path: 'items.quantity'
+ gt: 2
+ -
+ exists:
+ path: 'items.price'
+ -
+ text:
+ path: 'items.tags'
+ query: 'school'
+ -
+ $limit: 2
+ -
+ $project:
+ _id: 0
+ storeLocation: 1
+ items:
+ $filter:
+ input: '$items'
+ cond:
+ $and:
+ -
+ $ifNull:
+ - '$$this.price'
+ - 'false'
+ -
+ $gt:
+ - '$$this.quantity'
+ - 2
+ -
+ $in:
+ - 'office'
+ - '$$this.tags'
diff --git a/generator/config/search/equals.yaml b/generator/config/search/equals.yaml
new file mode 100644
index 000000000..b3e50c641
--- /dev/null
+++ b/generator/config/search/equals.yaml
@@ -0,0 +1,104 @@
+# $schema: ../schema.json
+name: equals
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/equals/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The equals operator checks whether a field matches a value you specify.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: value
+ type:
+ - binData
+ - bool
+ - date
+ - objectId
+ - 'null'
+ - number
+ - string
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Boolean'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/equals/#boolean-examples'
+ pipeline:
+ -
+ $search:
+ equals:
+ path: 'verified_user'
+ value: true
+ -
+ $project:
+ name: 1
+ _id: 0
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'ObjectId'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/equals/#objectid-example'
+ pipeline:
+ -
+ $search:
+ equals:
+ path: 'teammates'
+ value: !bson_objectId '5a9427648b0beebeb69589a1'
+
+ -
+ name: 'Date'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/equals/#date-example'
+ pipeline:
+ -
+ $search:
+ equals:
+ path: 'account_created'
+ value: !bson_utcdatetime '2022-05-04T05:01:08.000+00:00'
+
+ -
+ name: 'Number'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/equals/#number-example'
+ pipeline:
+ -
+ $search:
+ equals:
+ path: 'employee_number'
+ value: 259
+
+ -
+ name: 'String'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/equals/#string-example'
+ pipeline:
+ -
+ $search:
+ equals:
+ path: 'name'
+ value: 'jim hall'
+
+ -
+ name: 'UUID'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/equals/#uuid-example'
+ pipeline:
+ -
+ $search:
+ equals:
+ path: 'uuid'
+ value: !bson_uuid 'fac32260-b511-4c69-8485-a2be5b7dda9e'
+
+ -
+ name: 'Null'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/equals/#null-example'
+ pipeline:
+ -
+ $search:
+ equals:
+ path: 'job_title'
+ value: ~
diff --git a/generator/config/search/exists.yaml b/generator/config/search/exists.yaml
new file mode 100644
index 000000000..062e8ba59
--- /dev/null
+++ b/generator/config/search/exists.yaml
@@ -0,0 +1,56 @@
+# $schema: ../schema.json
+name: exists
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/exists/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The exists operator tests if a path to a specified indexed field name exists in a document.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Basic'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/exists/#basic-example'
+ pipeline:
+ -
+ $search:
+ exists:
+ path: 'type'
+
+ -
+ name: 'Embedded'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/exists/#embedded-example'
+ pipeline:
+ -
+ $search:
+ exists:
+ path: 'quantities.lemons'
+
+ -
+ name: 'Compound'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/exists/#compound-example'
+ pipeline:
+ -
+ $search:
+ compound:
+ must:
+ -
+ exists:
+ path: 'type'
+ -
+ text:
+ query: 'apple'
+ path: 'type'
+ should:
+ text:
+ query: 'fuji'
+ path: 'description'
diff --git a/generator/config/search/facet.yaml b/generator/config/search/facet.yaml
new file mode 100644
index 000000000..53dc8cba9
--- /dev/null
+++ b/generator/config/search/facet.yaml
@@ -0,0 +1,56 @@
+# $schema: ../schema.json
+name: facet
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/facet/'
+type:
+ - searchOperator # should be searchCollector
+encode: object
+description: |
+ The facet collector groups results by values or ranges in the specified
+ faceted fields and returns the count for each of those groups.
+arguments:
+ -
+ name: facets
+ type:
+ - object # map of facetDefinition
+ -
+ name: operator
+ optional: true
+ type:
+ - searchOperator
+tests:
+ -
+ name: 'Facet'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/facet/#examples'
+ pipeline:
+ -
+ $search:
+ facet:
+ operator:
+ near:
+ path: 'released'
+ origin: !bson_utcdatetime '1999-07-01T00:00:00.000+00:00'
+ pivot: 7776000000
+ facets:
+ genresFacet:
+ type: 'string'
+ path: 'genres'
+ -
+ $limit: 2
+ -
+ $facet:
+ docs:
+ -
+ $project:
+ title: 1
+ released: 1
+ meta:
+ -
+ $replaceWith: '$$SEARCH_META'
+ -
+ $limit: 1
+ -
+ $set:
+ meta:
+ $arrayElemAt:
+ - '$meta'
+ - 0
diff --git a/generator/config/search/geoShape.yaml b/generator/config/search/geoShape.yaml
new file mode 100644
index 000000000..4da121e45
--- /dev/null
+++ b/generator/config/search/geoShape.yaml
@@ -0,0 +1,123 @@
+# $schema: ../schema.json
+name: geoShape
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/geoShape/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The geoShape operator supports querying shapes with a relation to a given
+ geometry if indexShapes is set to true in the index definition.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: relation
+ type:
+ - string # contains | disjoint | intersects | within
+ -
+ name: geometry
+ type:
+ - geometry
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Disjoint'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/geoShape/#disjoint-example'
+ pipeline:
+ -
+ $search:
+ geoShape:
+ relation: 'disjoint'
+ geometry:
+ type: 'Polygon'
+ coordinates:
+ -
+ - [-161.323242, 22.512557]
+ - [-152.446289, 22.065278]
+ - [-156.09375, 17.811456]
+ - [-161.323242, 22.512557]
+ path: 'address.location'
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ name: 1
+ address: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Intersect'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/geoShape/#intersects-example'
+ pipeline:
+ -
+ $search:
+ geoShape:
+ relation: 'intersects'
+ geometry:
+ type: 'MultiPolygon'
+ coordinates:
+ -
+ -
+ - [2.16942, 41.40082]
+ - [2.17963, 41.40087]
+ - [2.18146, 41.39716]
+ - [2.15533, 41.40686]
+ - [2.14596, 41.38475]
+ - [2.17519, 41.41035]
+ - [2.16942, 41.40082]
+ -
+ -
+ - [2.16365, 41.39416]
+ - [2.16963, 41.39726]
+ - [2.15395, 41.38005]
+ - [2.17935, 41.43038]
+ - [2.16365, 41.39416]
+ path: 'address.location'
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ name: 1
+ address: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Within'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/geoShape/#within-example'
+ pipeline:
+ -
+ $search:
+ geoShape:
+ relation: 'within'
+ geometry:
+ type: 'Polygon'
+ coordinates:
+ -
+ - [-74.3994140625, 40.5305017757]
+ - [-74.7290039063, 40.5805846641]
+ - [-74.7729492188, 40.9467136651]
+ - [-74.0698242188, 41.1290213475]
+ - [-73.65234375, 40.9964840144]
+ - [-72.6416015625, 40.9467136651]
+ - [-72.3559570313, 40.7971774152]
+ - [-74.3994140625, 40.5305017757]
+ path: 'address.location'
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ name: 1
+ address: 1
+ score:
+ $meta: 'searchScore'
diff --git a/generator/config/search/geoWithin.yaml b/generator/config/search/geoWithin.yaml
new file mode 100644
index 000000000..1739f1997
--- /dev/null
+++ b/generator/config/search/geoWithin.yaml
@@ -0,0 +1,103 @@
+# $schema: ../schema.json
+name: geoWithin
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/geoWithin/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The geoWithin operator supports querying geographic points within a given
+ geometry. Only points are returned, even if indexShapes value is true in
+ the index definition.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: box
+ optional: true
+ type:
+ - object
+ -
+ name: circle
+ optional: true
+ type:
+ - object
+ -
+ name: geometry
+ optional: true
+ type:
+ - geometry
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'box'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/geoWithin/#box-example'
+ pipeline:
+ -
+ $search:
+ geoWithin:
+ path: 'address.location'
+ box:
+ bottomLeft:
+ type: 'Point'
+ coordinates: [112.467, -55.05]
+ topRight:
+ type: 'Point'
+ coordinates: [168, -9.133]
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ name: 1
+ address: 1
+
+ -
+ name: 'circle'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/geoWithin/#circle-example'
+ pipeline:
+ -
+ $search:
+ geoWithin:
+ circle:
+ center:
+ type: 'Point'
+ coordinates: [-73.54, 45.54]
+ radius: 1600
+ path: 'address.location'
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ name: 1
+ address: 1
+
+ -
+ name: 'geometry'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/geoWithin/#geometry-examples'
+ pipeline:
+ -
+ $search:
+ geoWithin:
+ geometry:
+ type: 'Polygon'
+ coordinates:
+ -
+ - [-161.323242, 22.512557]
+ - [-152.446289, 22.065278]
+ - [-156.09375, 17.811456]
+ - [-161.323242, 22.512557]
+ path: 'address.location'
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ name: 1
+ address: 1
diff --git a/generator/config/search/in.yaml b/generator/config/search/in.yaml
new file mode 100644
index 000000000..cc1aa6c33
--- /dev/null
+++ b/generator/config/search/in.yaml
@@ -0,0 +1,89 @@
+# $schema: ../schema.json
+name: in
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/in/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The in operator performs a search for an array of BSON values in a field.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: value
+ type:
+ - any
+ - array # of any
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Single Value Field Match'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/in/#examples'
+ pipeline:
+ -
+ $search:
+ in:
+ path: 'birthdate'
+ value:
+ - !bson_utcdatetime '1977-03-02T02:20:31.000+00:00'
+ - !bson_utcdatetime '1977-03-01T00:00:00.000+00:00'
+ - !bson_utcdatetime '1977-05-06T21:57:35.000+00:00'
+ -
+ $project:
+ _id: 0
+ name: 1
+ birthdate: 1
+
+ -
+ name: 'Array Value Field Match'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/in/#examples'
+ pipeline:
+ -
+ $search:
+ in:
+ path: 'accounts'
+ value:
+ - 371138
+ - 371139
+ - 371140
+ -
+ $project:
+ _id: 0
+ name: 1
+ accounts: 1
+
+ -
+ name: 'Compound Query Match'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/in/#examples'
+ pipeline:
+ -
+ $search:
+ compound:
+ must:
+ -
+ in:
+ path: 'name'
+ value:
+ - 'james sanchez'
+ - 'jennifer lawrence'
+ should:
+ -
+ in:
+ path: '_id'
+ value:
+ - !bson_objectId '5ca4bbcea2dd94ee58162a72'
+ - !bson_objectId '5ca4bbcea2dd94ee58162a91'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 1
+ name: 1
+ score:
+ $meta: 'searchScore'
diff --git a/generator/config/search/moreLikeThis.yaml b/generator/config/search/moreLikeThis.yaml
new file mode 100644
index 000000000..8c4803bdd
--- /dev/null
+++ b/generator/config/search/moreLikeThis.yaml
@@ -0,0 +1,99 @@
+# $schema: ../schema.json
+name: moreLikeThis
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/moreLikeThis/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The moreLikeThis operator returns documents similar to input documents.
+ The moreLikeThis operator allows you to build features for your applications
+ that display similar or alternative results based on one or more given documents.
+arguments:
+ -
+ name: like
+ type:
+ - object
+ - array # of object
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Single Document with Multiple Fields'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/morelikethis/#example-1--single-document-with-multiple-fields'
+ pipeline:
+ -
+ $search:
+ moreLikeThis:
+ like:
+ title: 'The Godfather'
+ genres: 'action'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ title: 1
+ released: 1
+ genres: 1
+
+ -
+ name: 'Input Document Excluded in Results'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/morelikethis/#example-2--input-document-excluded-in-results'
+ pipeline:
+ -
+ $search:
+ compound:
+ must:
+ -
+ moreLikeThis:
+ like:
+ _id: !bson_objectId '573a1396f29313caabce4a9a'
+ genres:
+ - 'Crime'
+ - 'Drama'
+ title: 'The Godfather'
+ mustNot:
+ -
+ equals:
+ path: '_id'
+ value: !bson_objectId '573a1396f29313caabce4a9a'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 1
+ title: 1
+ released: 1
+ genres: 1
+
+ -
+ name: 'Multiple Analyzers'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/morelikethis/#example-3--multiple-analyzers'
+ pipeline:
+ -
+ $search:
+ compound:
+ should:
+ -
+ moreLikeThis:
+ like:
+ _id: !bson_objectId '573a1396f29313caabce4a9a'
+ genres:
+ - 'Crime'
+ - 'Drama'
+ title: 'The Godfather'
+ mustNot:
+ -
+ equals:
+ path: '_id'
+ value: !bson_objectId '573a1394f29313caabcde9ef'
+ -
+ $limit: 10
+ -
+ $project:
+ title: 1
+ genres: 1
+ _id: 1
diff --git a/generator/config/search/near.yaml b/generator/config/search/near.yaml
new file mode 100644
index 000000000..bd4119cf9
--- /dev/null
+++ b/generator/config/search/near.yaml
@@ -0,0 +1,124 @@
+# $schema: ../schema.json
+name: near
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/near/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The near operator supports querying and scoring numeric, date, and GeoJSON point values.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: origin
+ type:
+ - date
+ - number
+ - geometry
+ -
+ name: pivot
+ type:
+ - number
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Number'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/near/#number-example'
+ pipeline:
+ -
+ $search:
+ index: 'runtimes'
+ near:
+ path: 'runtime'
+ origin: 279
+ pivot: 2
+ -
+ $limit: 7
+ -
+ $project:
+ _id: 0
+ title: 1
+ runtime: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Date'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/near/#date-example'
+ pipeline:
+ -
+ $search:
+ index: 'releaseddate'
+ near:
+ path: 'released'
+ origin: !bson_utcdatetime '1915-09-13T00:00:00.000+00:00'
+ pivot: 7776000000
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ title: 1
+ released: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'GeoJSON Point'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/near/#geojson-point-examples'
+ pipeline:
+ -
+ $search:
+ near:
+ origin:
+ type: 'Point'
+ coordinates:
+ - -8.61308
+ - 41.1413
+ pivot: 1000
+ path: 'address.location'
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ name: 1
+ address: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Compound'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/near/#compound-example'
+ pipeline:
+ -
+ $search:
+ compound:
+ must:
+ text:
+ query: 'Apartment'
+ path: 'property_type'
+ should:
+ near:
+ origin:
+ type: 'Point'
+ coordinates:
+ - 114.15027
+ - 22.28158
+ pivot: 1000
+ path: 'address.location'
+ -
+ $limit: 3
+ -
+ $project:
+ _id: 0
+ property_type: 1
+ address: 1
+ score:
+ $meta: 'searchScore'
diff --git a/generator/config/search/phrase.yaml b/generator/config/search/phrase.yaml
new file mode 100644
index 000000000..4d9b75c4e
--- /dev/null
+++ b/generator/config/search/phrase.yaml
@@ -0,0 +1,109 @@
+# $schema: ../schema.json
+name: phrase
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/phrase/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The phrase operator performs search for documents containing an ordered sequence of terms using the analyzer specified in the index configuration.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: query
+ type:
+ - string
+ - array # of string
+ -
+ name: slop
+ optional: true
+ type:
+ - int
+ -
+ name: synonyms
+ optional: true
+ type:
+ - string
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Single Phrase'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/phrase/#single-phrase-example'
+ pipeline:
+ -
+ $search:
+ phrase:
+ path: 'title'
+ query: 'new york'
+ -
+ $limit: 10
+ -
+ $project:
+ _id: 0
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Multiple Phrase'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/phrase/#multiple-phrases-example'
+ pipeline:
+ -
+ $search:
+ phrase:
+ path: 'title'
+ query:
+ - 'the man'
+ - 'the moon'
+ -
+ $limit: 10
+ -
+ $project:
+ _id: 0
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Phrase Slop'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/phrase/#slop-example'
+ pipeline:
+ -
+ $search:
+ phrase:
+ path: 'title'
+ query: 'men women'
+ slop: 5
+ -
+ $project:
+ _id: 0
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Phrase Synonyms'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/phrase/#synonyms-example'
+ pipeline:
+ -
+ $search:
+ phrase:
+ path: 'plot'
+ query: 'automobile race'
+ slop: 5
+ synonyms: 'my_synonyms'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ plot: 1
+ title: 1
+ score:
+ $meta: 'searchScore'
diff --git a/generator/config/search/queryString.yaml b/generator/config/search/queryString.yaml
new file mode 100644
index 000000000..8202771c9
--- /dev/null
+++ b/generator/config/search/queryString.yaml
@@ -0,0 +1,35 @@
+# $schema: ../schema.json
+name: queryString
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/queryString/'
+type:
+ - searchOperator
+encode: object
+description: |
+
+arguments:
+ -
+ name: defaultPath
+ type:
+ - searchPath
+ -
+ name: query
+ type:
+ - string
+
+# The various example from the doc are variations of the "query" parameter
+# this is not pertinent for testing the aggregation builder, unless we create
+# a queryString builder.
+tests:
+ -
+ name: 'Boolean Operator Queries'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/queryString/#boolean-operator-queries'
+ pipeline:
+ -
+ $search:
+ queryString:
+ defaultPath: 'title'
+ query: 'Rocky AND (IV OR 4 OR Four)'
+ -
+ $project:
+ _id: 0
+ title: 1
diff --git a/generator/config/search/range.yaml b/generator/config/search/range.yaml
new file mode 100644
index 000000000..f42c69176
--- /dev/null
+++ b/generator/config/search/range.yaml
@@ -0,0 +1,139 @@
+# $schema: ../schema.json
+name: range
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/range/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The range operator supports querying and scoring numeric, date, and string values.
+ You can use this operator to find results that are within a given numeric, date, objectId, or letter (from the English alphabet) range.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: gt
+ optional: true
+ type:
+ - date
+ - number
+ - string
+ - objectId
+ -
+ name: gte
+ optional: true
+ type:
+ - date
+ - number
+ - string
+ - objectId
+ -
+ name: lt
+ optional: true
+ type:
+ - date
+ - number
+ - string
+ - objectId
+ -
+ name: lte
+ optional: true
+ type:
+ - date
+ - number
+ - string
+ - objectId
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Number gte lte'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/range/#number-example'
+ pipeline:
+ -
+ $search:
+ range:
+ path: 'runtime'
+ gte: 2
+ lte: 3
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ title: 1
+ runtime: 1
+
+ -
+ name: 'Number lte'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/range/#number-example'
+ pipeline:
+ -
+ $search:
+ range:
+ path: 'runtime'
+ lte: 2
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ title: 1
+ runtime: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Date'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/range/#date-example'
+ pipeline:
+ -
+ $search:
+ range:
+ path: 'released'
+ gt: !bson_utcdatetime '2010-01-01T00:00:00.000Z'
+ lt: !bson_utcdatetime '2015-01-01T00:00:00.000Z'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ title: 1
+ released: 1
+
+ -
+ name: 'ObjectId'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/range/#objectid-example'
+ pipeline:
+ -
+ $search:
+ range:
+ path: '_id'
+ gte: !bson_objectId '573a1396f29313caabce4a9a'
+ lte: !bson_objectId '573a1396f29313caabce4ae7'
+ -
+ $project:
+ _id: 1
+ title: 1
+ released: 1
+
+ -
+ name: 'String'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/range/#string-example'
+ pipeline:
+ -
+ $search:
+ range:
+ path: 'title'
+ gt: 'city'
+ lt: 'country'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ title: 1
diff --git a/generator/config/search/regex.yaml b/generator/config/search/regex.yaml
new file mode 100644
index 000000000..869ffabde
--- /dev/null
+++ b/generator/config/search/regex.yaml
@@ -0,0 +1,42 @@
+# $schema: ../schema.json
+name: regex
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/regex/'
+type:
+ - searchOperator
+encode: object
+description: |
+ regex interprets the query field as a regular expression.
+ regex is a term-level operator, meaning that the query field isn't analyzed.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: query
+ type:
+ - string
+ -
+ name: allowAnalyzedField
+ optional: true
+ type:
+ - bool
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Regex'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/regex/#examples'
+ pipeline:
+ -
+ $search:
+ regex:
+ path: 'title'
+ query: '[0-9]{2} (.){4}s'
+ -
+ $project:
+ _id: 0
+ title: 1
diff --git a/generator/config/search/text.yaml b/generator/config/search/text.yaml
new file mode 100644
index 000000000..dbd48cdd0
--- /dev/null
+++ b/generator/config/search/text.yaml
@@ -0,0 +1,194 @@
+# $schema: ../schema.json
+name: text
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The text operator performs a full-text search using the analyzer that you specify in the index configuration.
+ If you omit an analyzer, the text operator uses the default standard analyzer.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: query
+ type:
+ - string
+ -
+ name: fuzzy
+ optional: true
+ type:
+ - object
+ -
+ name: matchCriteria
+ optional: true
+ type:
+ - string # "any" | "all"
+ -
+ name: synonyms
+ optional: true
+ type:
+ - string
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Basic'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/#basic-example'
+ pipeline:
+ -
+ $search:
+ text:
+ path: 'title'
+ query: 'surfer'
+ -
+ $project:
+ _id: 0
+ title: 1
+ score:
+ $meta: 'searchScore'
+ -
+ name: 'Fuzzy Default'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/#fuzzy-examples'
+ pipeline:
+ -
+ $search:
+ text:
+ path: 'title'
+ query: 'naw yark'
+ fuzzy: {}
+ -
+ $limit: 10
+ -
+ $project:
+ _id: 0
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Fuzzy maxExpansions'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/#fuzzy-examples'
+ pipeline:
+ -
+ $search:
+ text:
+ path: 'title'
+ query: 'naw yark'
+ fuzzy:
+ maxEdits: 1
+ maxExpansions: 100
+ -
+ $limit: 10
+ -
+ $project:
+ _id: 0
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Fuzzy prefixLength'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/#fuzzy-examples'
+ pipeline:
+ -
+ $search:
+ text:
+ path: 'title'
+ query: 'naw yark'
+ fuzzy:
+ maxEdits: 1
+ prefixLength: 2
+ -
+ $limit: 8
+ -
+ $project:
+ _id: 1
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Match any Using equivalent Mapping'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/#match-any-using-equivalent-mapping'
+ pipeline:
+ -
+ $search:
+ text:
+ path: 'plot'
+ query: 'attire'
+ synonyms: 'my_synonyms'
+ matchCriteria: 'any'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ plot: 1
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Match any Using explicit Mapping'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/#match-any-using-explicit-mapping'
+ pipeline:
+ -
+ $search:
+ text:
+ path: 'plot'
+ query: 'boat race'
+ synonyms: 'my_synonyms'
+ matchCriteria: 'any'
+ -
+ $limit: 10
+ -
+ $project:
+ _id: 0
+ plot: 1
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Match all Using Synonyms'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/#match-all-using-synonyms'
+ pipeline:
+ -
+ $search:
+ text:
+ path: 'plot'
+ query: 'automobile race'
+ matchCriteria: 'all'
+ synonyms: 'my_synonyms'
+ -
+ $limit: 20
+ -
+ $project:
+ _id: 0
+ plot: 1
+ title: 1
+ score:
+ $meta: 'searchScore'
+
+ -
+ name: 'Wildcard Path'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/text/'
+ pipeline:
+ -
+ $search:
+ text:
+ path:
+ wildcard: '*'
+ query: 'surfer'
+ -
+ $project:
+ _id: 0
+ title: 1
+ score:
+ $meta: 'searchScore'
diff --git a/generator/config/search/wildcard.yaml b/generator/config/search/wildcard.yaml
new file mode 100644
index 000000000..d17fb4803
--- /dev/null
+++ b/generator/config/search/wildcard.yaml
@@ -0,0 +1,60 @@
+# $schema: ../schema.json
+name: wildcard
+link: 'https://www.mongodb.com/docs/atlas/atlas-search/wildcard/'
+type:
+ - searchOperator
+encode: object
+description: |
+ The wildcard operator enables queries which use special characters in the search string that can match any character.
+arguments:
+ -
+ name: path
+ type:
+ - searchPath
+ -
+ name: query
+ type:
+ - string
+ -
+ name: allowAnalyzedField
+ optional: true
+ type:
+ - bool
+ -
+ name: score
+ optional: true
+ type:
+ - searchScore
+tests:
+ -
+ name: 'Wildcard Path'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/wildcard/#index-definition'
+ pipeline:
+ -
+ $search:
+ wildcard:
+ query: 'Wom?n *'
+ path:
+ wildcard: '*'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ title: 1
+
+ -
+ name: 'Escape Character Example'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/wildcard/#escape-character-example'
+ pipeline:
+ -
+ $search:
+ wildcard:
+ query: '*\?'
+ path: 'title'
+ -
+ $limit: 5
+ -
+ $project:
+ _id: 0
+ title: 1
diff --git a/generator/config/stage/search.yaml b/generator/config/stage/search.yaml
index 2531e75f6..34bf57a34 100644
--- a/generator/config/stage/search.yaml
+++ b/generator/config/stage/search.yaml
@@ -3,16 +3,93 @@ name: $search
link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/search/'
type:
- stage
-encode: single
+encode: object
description: |
Performs a full-text search of the field or fields in an Atlas collection.
NOTE: $search is only available for MongoDB Atlas clusters, and is not available for self-managed deployments.
arguments:
-
- name: search
+ name: operator
+ mergeObject: true
+ type:
+ - searchOperator
+ description: |
+ Operator to search with. You can provide a specific operator or use
+ the compound operator to run a compound query with multiple operators.
+ -
+ name: index
+ optional: true
+ type:
+ - string
+ description: |
+ Name of the Atlas Search index to use. If omitted, defaults to "default".
+ -
+ name: highlight
+ optional: true
+ type:
+ # @todo support "highlight" type object
+ # https://www.mongodb.com/docs/atlas/atlas-search/highlighting/
+ - object
+ description: |
+ Specifies the highlighting options for displaying search terms in their original context.
+ -
+ name: concurrent
+ optional: true
+ type:
+ - bool
+ description: |
+ Parallelize search across segments on dedicated search nodes.
+ If you don't have separate search nodes on your cluster,
+ Atlas Search ignores this flag. If omitted, defaults to false.
+ -
+ name: count
+ optional: true
+ type:
+ - string
+ description: |
+ Document that specifies the count options for retrieving a count of the results.
+ -
+ name: searchAfter
+ optional: true
+ type:
+ - string
+ description: |
+ Reference point for retrieving results. searchAfter returns documents starting immediately following the specified reference point.
+ -
+ name: searchBefore
+ optional: true
+ type:
+ - string
+ description: |
+ Reference point for retrieving results. searchBefore returns documents starting immediately before the specified reference point.
+ -
+ name: scoreDetails
+ optional: true
+ type:
+ - bool
+ description: |
+ Flag that specifies whether to retrieve a detailed breakdown of the score for the documents in the results. If omitted, defaults to false.
+ -
+ name: sort
+ optional: true
+ type:
+ - object
+ description: |
+ Document that specifies the fields to sort the Atlas Search results by in ascending or descending order.
+ -
+ name: returnStoredSource
+ optional: true
+ type:
+ - bool
+ description: |
+ Flag that specifies whether to perform a full document lookup on the backend database or return only stored source fields directly from Atlas Search.
+ -
+ name: tracking
+ optional: true
type:
- object
-
+ description: |
+ Document that specifies the tracking option to retrieve analytics information on the search terms.
tests:
-
name: 'Example'
diff --git a/generator/config/stage/searchMeta.yaml b/generator/config/stage/searchMeta.yaml
index 322d048eb..a7d92c272 100644
--- a/generator/config/stage/searchMeta.yaml
+++ b/generator/config/stage/searchMeta.yaml
@@ -3,16 +3,34 @@ name: $searchMeta
link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/searchMeta/'
type:
- stage
-encode: single
+encode: object
description: |
Returns different types of metadata result documents for the Atlas Search query against an Atlas collection.
NOTE: $searchMeta is only available for MongoDB Atlas clusters running MongoDB v4.4.9 or higher, and is not available for self-managed deployments.
arguments:
-
- name: meta
+ name: operator
+ mergeObject: true
type:
- - object
+ - searchOperator
+ description: |
+ Operator to search with. You can provide a specific operator or use
+ the compound operator to run a compound query with multiple operators.
+ -
+ name: index
+ optional: true
+ type:
+ - string
+ description: |
+ Name of the Atlas Search index to use. If omitted, defaults to default.
+ -
+ name: count
+ optional: true
+ type:
+ - object
+ description: |
+ Document that specifies the count options for retrieving a count of the results.
tests:
-
name: 'Example'
@@ -26,3 +44,89 @@ tests:
lt: 1999
count:
type: 'total'
+
+ -
+ name: 'Year Facet'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/facet/#example-1'
+ pipeline:
+ - $searchMeta:
+ facet:
+ operator:
+ range:
+ path: 'year'
+ gte: 1980
+ lte: 2000
+ facets:
+ yearFacet:
+ type: 'number'
+ path: 'year'
+ boundaries:
+ - 1980
+ - 1990
+ - 2000
+ default: 'other'
+
+ -
+ name: 'Date Facet'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/facet/#example-2'
+ pipeline:
+ -
+ $searchMeta:
+ facet:
+ operator:
+ range:
+ path: 'released'
+ gte: !bson_utcdatetime '2000-01-01T00:00:00.000Z'
+ lte: !bson_utcdatetime '2015-01-31T00:00:00.000Z'
+ facets:
+ yearFacet:
+ type: 'date'
+ path: 'released'
+ boundaries:
+ - !bson_utcdatetime '2000-01-01'
+ - !bson_utcdatetime '2005-01-01'
+ - !bson_utcdatetime '2010-01-01'
+ - !bson_utcdatetime '2015-01-01'
+ default: 'other'
+
+ -
+ name: 'Metadata Results'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/facet/#examples'
+ pipeline:
+ -
+ $searchMeta:
+ facet:
+ operator:
+ range:
+ path: 'released'
+ gte: !bson_utcdatetime '2000-01-01T00:00:00.000Z'
+ lte: !bson_utcdatetime '2015-01-31T00:00:00.000Z'
+ facets:
+ directorsFacet:
+ type: 'string'
+ path: 'directors'
+ numBuckets: 7
+ yearFacet:
+ type: 'number'
+ path: 'year'
+ boundaries:
+ - 2000
+ - 2005
+ - 2010
+ - 2015
+
+ -
+ name: 'Autocomplete Bucket Results through Facet Queries'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/#bucket-results-through-facet-queries'
+ pipeline:
+ -
+ $searchMeta:
+ facet:
+ operator:
+ autocomplete:
+ path: 'title'
+ query: 'Gravity'
+ facets:
+ titleFacet:
+ type: 'string'
+ path: 'title'
diff --git a/generator/config/stage/vectorSearch.yaml b/generator/config/stage/vectorSearch.yaml
new file mode 100644
index 000000000..ec4b4ff4b
--- /dev/null
+++ b/generator/config/stage/vectorSearch.yaml
@@ -0,0 +1,119 @@
+# $schema: ../schema.json
+name: $vectorSearch
+link: 'https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-stage/'
+type:
+ - stage
+encode: object
+description: |
+ The $vectorSearch stage performs an ANN or ENN search on a vector in the specified field.
+arguments:
+ -
+ name: index
+ type:
+ - string
+ description: |
+ Name of the Atlas Vector Search index to use.
+ -
+ name: limit
+ type:
+ - int
+ description: |
+ Number of documents to return in the results. This value can't exceed the value of numCandidates if you specify numCandidates.
+ -
+ name: path
+ type:
+ - searchPath
+ description: |
+ Indexed vector type field to search.
+ -
+ name: queryVector
+ type:
+ - array # of numbers
+ description: |
+ Array of numbers that represent the query vector. The number type must match the indexed field value type.
+ -
+ name: exact
+ optional: true
+ type:
+ - bool
+ description: |
+ This is required if numCandidates is omitted. false to run ANN search. true to run ENN search.
+ -
+ name: filter
+ optional: true
+ type:
+ - query
+ description: |
+ Any match query that compares an indexed field with a boolean, date, objectId, number (not decimals), string, or UUID to use as a pre-filter.
+ -
+ name: numCandidates
+ optional: true
+ type:
+ - int
+ description: |
+ This field is required if exact is false or omitted.
+ Number of nearest neighbors to use during the search. Value must be less than or equal to (<=) 10000. You can't specify a number less than the number of documents to return (limit).
+
+tests:
+ -
+ name: 'ANN Basic'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-stage/#ann-examples'
+ pipeline:
+ -
+ $vectorSearch:
+ index: 'vector_index'
+ path: 'plot_embedding'
+ queryVector: [-0.0016261312, -0.028070757, -0.011342932] # skip other numbers, not relevant to the test
+ numCandidates: 150
+ limit: 10
+ -
+ $project:
+ _id: 0
+ plot: 1
+ title: 1
+ score:
+ $meta: 'vectorSearchScore'
+
+ -
+ name: 'ANN Filter'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-stage/#ann-examples'
+ pipeline:
+ -
+ $vectorSearch:
+ index: 'vector_index'
+ path: 'plot_embedding'
+ filter:
+ $and:
+ -
+ year:
+ $lt: 1975
+ queryVector: [0.02421053, -0.022372592, -0.006231137] # skip other numbers, not relevant to the test
+ numCandidates: 150
+ limit: 10
+ -
+ $project:
+ _id: 0
+ title: 1
+ plot: 1
+ year: 1
+ score:
+ $meta: 'vectorSearchScore'
+
+ -
+ name: 'ENN'
+ link: 'https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-stage/#enn-examples'
+ pipeline:
+ -
+ $vectorSearch:
+ index: 'vector_index'
+ path: 'plot_embedding'
+ queryVector: [-0.006954097, -0.009932499, -0.001311474] # skip other numbers, not relevant to the test
+ exact: true
+ limit: 10
+ -
+ $project:
+ _id: 0
+ plot: 1
+ title: 1
+ score:
+ $meta: 'vectorSearchScore'
diff --git a/generator/js2yaml.html b/generator/js2yaml.html
index a0f8654af..31241adb1 100644
--- a/generator/js2yaml.html
+++ b/generator/js2yaml.html
@@ -28,6 +28,9 @@ Convert JS examples into Yaml
binary: BinData(0, "IA=="),
empty_object: {},
empty_array: [],
+ objectId: ObjectId("5f0f1d9b1c9d440000f3f3f3"),
+ uuid: UUID("fac32260-b511-4c69-8485-a2be5b7dda9e"),
+ list: [1, 2, 3],
}
},
// First Stage
@@ -90,6 +93,14 @@ Convert JS examples into Yaml
return new TaggedValue('bson_int64', value)
}
+ function ObjectId(value) {
+ return new TaggedValue('bson_objectId', value)
+ }
+
+ function UUID(value) {
+ return new TaggedValue('bson_uuid', value)
+ }
+
function convert(jsString) {
try {
return toYaml(eval(jsString), 1);
@@ -109,6 +120,11 @@ Convert JS examples into Yaml
return ' []';
}
+ // Inline list of numbers
+ if (object.every(item => typeof item === 'number')) {
+ return ' [' + object.join(', ') + ']';
+ }
+
return newline + '-' + object.map((item) => toYaml(item, indent + 1)).join(newline + '-');
}
diff --git a/generator/src/OperatorTestGenerator.php b/generator/src/OperatorTestGenerator.php
index a8e6e91cc..f665b9210 100644
--- a/generator/src/OperatorTestGenerator.php
+++ b/generator/src/OperatorTestGenerator.php
@@ -10,6 +10,7 @@
use MongoDB\BSON\Decimal128;
use MongoDB\BSON\Document;
use MongoDB\BSON\Int64;
+use MongoDB\BSON\ObjectId;
use MongoDB\BSON\Regex;
use MongoDB\BSON\UTCDateTime;
use MongoDB\Builder\Pipeline;
@@ -27,6 +28,7 @@
use function base64_decode;
use function basename;
use function get_object_vars;
+use function hex2bin;
use function is_array;
use function is_numeric;
use function is_object;
@@ -145,6 +147,8 @@ private function convertYamlTaggedValues(mixed $object): mixed
'bson_decimal128' => new Decimal128($value),
'bson_utcdatetime' => new UTCDateTime(is_numeric($value) ? $value : new DateTimeImmutable($value)),
'bson_binary' => new Binary(base64_decode($value)),
+ 'bson_objectId' => new ObjectId($value),
+ 'bson_uuid' => new Binary(hex2bin(str_replace('-', '', $value)), Binary::TYPE_UUID),
default => throw new InvalidArgumentException(sprintf('Yaml tag "%s" is not supported.', $object->getTag())),
};
}
@@ -158,6 +162,7 @@ private function convertYamlTaggedValues(mixed $object): mixed
}
if (is_object($object)) {
+ $object = clone $object;
foreach (get_object_vars($object) as $key => $value) {
$object->{$key} = $this->convertYamlTaggedValues($value);
}
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
index 0d349c0d9..7b0912775 100644
--- a/phpcs.xml.dist
+++ b/phpcs.xml.dist
@@ -19,7 +19,7 @@
rector.php
- src/Builder/(Accumulator|Expression|Query|Projection|Stage)/*\.php
+ src/Builder/(Accumulator|Expression|Query|Projection|Search|Stage)/*\.php
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
index 301c049ac..321bbc05a 100644
--- a/psalm-baseline.xml
+++ b/psalm-baseline.xml
@@ -172,6 +172,11 @@