Skip to content

Commit c7c3a2f

Browse files
committed
DOCSP-45770: atlas search queries
1 parent e3b7abf commit c7c3a2f

File tree

7 files changed

+656
-57
lines changed

7 files changed

+656
-57
lines changed

snooty.toml

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,35 @@ name = "php-library"
22
title = "PHP Library Manual"
33

44
intersphinx = [
5-
"https://www.mongodb.com/docs/manual/objects.inv",
6-
"https://www.mongodb.com/docs/drivers/objects.inv",
7-
"https://www.mongodb.com/docs/atlas/objects.inv",
5+
"https://www.mongodb.com/docs/manual/objects.inv",
6+
"https://www.mongodb.com/docs/drivers/objects.inv",
7+
"https://www.mongodb.com/docs/atlas/objects.inv",
88
]
99

1010
toc_landing_pages = [
11-
"/reference/class/MongoDBClient",
12-
"/reference/class/MongoDBCollection",
13-
"/reference/class/MongoDBDatabase",
14-
"/reference/class/MongoDBGridFSBucket",
15-
"/reference/class/MongoDBBulkWriteResult",
16-
"/reference/class/MongoDBDeleteResult",
17-
"/reference/class/MongoDBInsertManyResult",
18-
"/reference/class/MongoDBUpdateResult",
19-
"/reference/class/MongoDBChangeStream",
20-
"/reference/class/MongoDBMapReduceResult",
21-
"/reference/class/MongoDBModelCollectionInfo",
22-
"/reference/class/MongoDBModelDatabaseInfo",
23-
"/reference/class/MongoDBModelIndexInfo",
24-
"/get-started",
25-
"/connect",
26-
"/read",
27-
"/databases-collections",
28-
"/write",
29-
"/indexes",
30-
"/security",
31-
"/data-formats",
32-
"/upgrade",
11+
"/reference/class/MongoDBClient",
12+
"/reference/class/MongoDBCollection",
13+
"/reference/class/MongoDBDatabase",
14+
"/reference/class/MongoDBGridFSBucket",
15+
"/reference/class/MongoDBBulkWriteResult",
16+
"/reference/class/MongoDBDeleteResult",
17+
"/reference/class/MongoDBInsertManyResult",
18+
"/reference/class/MongoDBUpdateResult",
19+
"/reference/class/MongoDBChangeStream",
20+
"/reference/class/MongoDBMapReduceResult",
21+
"/reference/class/MongoDBModelCollectionInfo",
22+
"/reference/class/MongoDBModelDatabaseInfo",
23+
"/reference/class/MongoDBModelIndexInfo",
24+
"/get-started",
25+
"/connect",
26+
"/read",
27+
"/databases-collections",
28+
"/write",
29+
"/indexes",
30+
"/security",
31+
"/data-formats",
32+
"/upgrade",
33+
"/aggregation"
3334
]
3435

3536
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

source/aggregation.txt

Lines changed: 41 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ Transform Your Data with Aggregation
1818
:depth: 2
1919
:class: singlecol
2020

21-
.. TODO:
22-
.. toctree::
23-
:titlesonly:
24-
:maxdepth: 1
25-
26-
/aggregation/aggregation-tutorials
21+
.. toctree::
22+
:titlesonly:
23+
:maxdepth: 1
24+
25+
Atlas Search </aggregation/atlas-search>
26+
Atlas Vector Search </aggregation/vector-search>
2727

2828
Overview
2929
--------
@@ -78,9 +78,9 @@ Consider the following limitations when performing aggregation operations:
7878

7979
.. important:: $graphLookup Exception
8080

81-
The :manual:`$graphLookup
82-
</reference/operator/aggregation/graphLookup/>` stage has a strict
83-
memory limit of 100 megabytes and ignores the ``allowDiskUse`` option.
81+
The :manual:`$graphLookup
82+
</reference/operator/aggregation/graphLookup/>` stage has a strict
83+
memory limit of 100 megabytes and ignores the ``allowDiskUse`` option.
8484

8585
.. _php-aggregation-example:
8686

@@ -110,21 +110,21 @@ of New York. To do so, it uses an aggregation pipeline that contains the followi
110110
.. io-code-block::
111111
:copyable:
112112

113-
.. input:: /includes/aggregation.php
114-
:start-after: start-match-group
115-
:end-before: end-match-group
116-
:language: php
117-
:dedent:
113+
.. input:: /includes/aggregation/aggregation.php
114+
:start-after: start-match-group
115+
:end-before: end-match-group
116+
:language: php
117+
:dedent:
118118

119119
.. output::
120-
:visible: false
120+
:visible: false
121121

122-
{"_id":"Brooklyn","count":173}
123-
{"_id":"Queens","count":204}
124-
{"_id":"Bronx","count":71}
125-
{"_id":"Staten Island","count":20}
126-
{"_id":"Missing","count":2}
127-
{"_id":"Manhattan","count":221}
122+
{"_id":"Brooklyn","count":173}
123+
{"_id":"Queens","count":204}
124+
{"_id":"Bronx","count":71}
125+
{"_id":"Staten Island","count":20}
126+
{"_id":"Missing","count":2}
127+
{"_id":"Manhattan","count":221}
128128

129129
Explain an Aggregation
130130
~~~~~~~~~~~~~~~~~~~~~~
@@ -146,20 +146,20 @@ from the preceding :ref:`php-aggregation-example`:
146146
.. io-code-block::
147147
:copyable:
148148

149-
.. input:: /includes/aggregation.php
150-
:start-after: start-explain
151-
:end-before: end-explain
152-
:language: php
153-
:dedent:
149+
.. input:: /includes/aggregation/aggregation.php
150+
:start-after: start-explain
151+
:end-before: end-explain
152+
:language: php
153+
:dedent:
154154

155155
.. output::
156-
:visible: false
156+
:visible: false
157157

158-
{"explainVersion":"2","queryPlanner":{"namespace":"sample_restaurants.restaurants",
159-
"indexFilterSet":false,"parsedQuery":{"cuisine":{"$eq":"Bakery"}},"queryHash":"865F14C3",
160-
"planCacheKey":"D56D6F10","optimizedPipeline":true,"maxIndexedOrSolutionsReached":false,
161-
"maxIndexedAndSolutionsReached":false,"maxScansToExplodeReached":false,"winningPlan":{
162-
... }
158+
{"explainVersion":"2","queryPlanner":{"namespace":"sample_restaurants.restaurants",
159+
"indexFilterSet":false,"parsedQuery":{"cuisine":{"$eq":"Bakery"}},"queryHash":"865F14C3",
160+
"planCacheKey":"D56D6F10","optimizedPipeline":true,"maxIndexedOrSolutionsReached":false,
161+
"maxIndexedAndSolutionsReached":false,"maxScansToExplodeReached":false,"winningPlan":{
162+
... }
163163

164164
Additional Information
165165
----------------------
@@ -188,6 +188,15 @@ pages in the {+mdb-server+} manual:
188188
:manual:`Explain Output </reference/explain-results/>` and
189189
:manual:`Query Plans </core/query-plans/>`.
190190

191+
Atlas Search and Vector Search
192+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193+
194+
You can perform full-text searches by using the Atlas Search feature. To
195+
learn more, see the :ref:`php-atlas-search` guide.
196+
197+
You can perform similarity searches on vector embeddings by using the
198+
Atlas Vector Search feature. To learn more, see the :ref:`php-vector-search` guide.
199+
191200
.. TODO:
192201
Aggregation Tutorials
193202
~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)