Skip to content

Commit 809ba45

Browse files
committed
fixes
1 parent 93e377d commit 809ba45

File tree

10 files changed

+84
-51
lines changed

10 files changed

+84
-51
lines changed

snooty.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ toc_landing_pages = [
1111
"/security/authentication",
1212
"/aggregation-tutorials",
1313
"/data-formats",
14-
"/connect/connection-options"
14+
"/connect/connection-options",
15+
"crud",
16+
"/crud/query",
17+
"/crud/update"
1518
]
1619

1720
intersphinx = [

source/connect/connection-options.txt

Lines changed: 49 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -113,26 +113,9 @@ Network Compression
113113
| **MongoClient Example**: ``zlibCompressionLevel = 3``
114114
| **Connection URI Example**: ``zlibCompressionLevel=3``
115115

116-
Timeouts
117-
~~~~~~~~
116+
For more information about network compression in {+driver-short+}, see
117+
:ref:`<pymongo-network-compression>`.
118118

119-
.. list-table::
120-
:header-rows: 1
121-
:widths: 30 70
122-
123-
* - Connection Option
124-
- Description
125-
126-
* - ``timeoutMS``
127-
- | The number of milliseconds each driver operation must complete within. If an
128-
| operation doesn't finish in the specified time, {+driver-short+} raises a timeout exception.
129-
| For more information, see :ref:`<pymongo-csot>`.
130-
|
131-
| **Data Type**: ``int``
132-
| **Default**: ``None``
133-
| **MongoClient Example**: ``timeoutMS = 10000``
134-
| **Connection URI Example**: ``timeoutMs=10000``
135-
136119
Server Selection
137120
~~~~~~~~~~~~~~~~
138121

@@ -153,6 +136,50 @@ Server Selection
153136
| **MongoClient Example**: ``server_selector = your_function``
154137
| **Connection URI Example**: N/A
155138

139+
Stable API
140+
~~~~~~~~~~
141+
142+
.. list-table::
143+
:header-rows: 1
144+
:widths: 30 70
145+
146+
* - Connection Option
147+
- Description
148+
149+
* - ``server_api``
150+
- | A ``ServerApi`` object that specifies the Stable API version and other Stable API
151+
| options.
152+
|
153+
| **Data Type**: ``ServerApi``
154+
| **Default**: ``None``
155+
| **MongoClient Example**: ``server_api = ServerApi("1")``
156+
| **Connection URI Example**: N/A
157+
158+
For more information about the Stable API, see :ref:`<pymongo-stable-api>`.
159+
160+
Timeouts
161+
~~~~~~~~
162+
163+
.. list-table::
164+
:header-rows: 1
165+
:widths: 30 70
166+
167+
* - Connection Option
168+
- Description
169+
170+
* - ``timeoutMS``
171+
- | The number of milliseconds each driver operation must complete within. If an
172+
| operation doesn't finish in the specified time, {+driver-short+} raises a timeout exception.
173+
| For more information, see :ref:`<pymongo-csot>`.
174+
|
175+
| **Data Type**: ``int``
176+
| **Default**: ``None``
177+
| **MongoClient Example**: ``timeoutMS = 10000``
178+
| **Connection URI Example**: ``timeoutMs=10000``
179+
180+
For more information about using timeouts to limit server execution time, see
181+
:ref:`<pymongo-csot>`.
182+
156183
Connection Pools
157184
~~~~~~~~~~~~~~~~
158185

@@ -293,7 +320,7 @@ Authentication
293320
| **MongoClient Example**: ``password = "strong password"``
294321
| **Connection URI Example**: ``password=strong+password``
295322

296-
For more information about the connection option in this section, see :ref:`pymongo-auth`.
323+
For more information about the connection options in this section, see :ref:`pymongo-auth`.
297324

298325
Read and Write Operations
299326
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -376,4 +403,5 @@ Read and Write Operations
376403
| **MongoClient Example**: ``retryWrites=False``
377404
| **Connection URI Example**: ``retryWrites=false``
378405

379-
For more information about the connection options in this section, see :ref:`pymongo-databases-collections`.
406+
For more information about the connection options in this section, see
407+
:ref:`pymongo-configure-crud`.

source/crud/query/cursors.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ Sample Data
3535

3636
The examples in this guide use the ``sample_restaurants.restaurants`` collection
3737
from the :atlas:`Atlas sample datasets </sample-data>`. To learn how to create a
38-
free MongoDB Atlas cluster and load the sample datasets, see the :ref:`<pymongo-get-started>`.
38+
free MongoDB Atlas cluster and load the sample datasets, see the :ref:`<pymongo-get-started>`
39+
tutorial.
3940

4041
.. _pymongo-cursors-iterate:
4142

source/crud/query/find.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ Sample Data
3636

3737
The examples in this guide use the ``sample_restaurants.restaurants`` collection
3838
from the :atlas:`Atlas sample datasets </sample-data>`. To learn how to create a
39-
free MongoDB Atlas cluster and load the sample datasets, see the :ref:`<pymongo-get-started>`.
39+
free MongoDB Atlas cluster and load the sample datasets, see the :ref:`<pymongo-get-started>`
40+
tutorial.
4041

4142
.. _pymongo-retrieve-find:
4243

source/crud/query/specify-documents-to-return.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ Sample Data
3232

3333
The examples in this guide use the ``sample_restaurants.restaurants`` collection
3434
from the :atlas:`Atlas sample datasets </sample-data>`. To learn how to create a
35-
free MongoDB Atlas cluster and load the sample datasets, see the :ref:`<pymongo-get-started>`.
35+
free MongoDB Atlas cluster and load the sample datasets, see the :ref:`<pymongo-get-started>`
36+
tutorial.
3637

3738
Limit
3839
-----

source/data-formats.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Specialized Data Formats
2626
Custom Types </data-formats/custom-types>
2727
Dates & Times </data-formats/dates-and-times>
2828
UUIDs </data-formats/uuid>
29-
Time Series </data-formats/time-series>
29+
Time Series Data </data-formats/time-series>
3030

3131
Overview
3232
--------

source/data-formats/custom-types/serialization.txt

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,14 @@ Serialization
2020
Overview
2121
--------
2222

23-
In this guide, you can learn how to use {+driver-short+} to perform
24-
serialization.
23+
In this guide, you can learn how to use {+driver-short+} to serialize your custom types.
2524

2625
Serialization is the process of mapping a {+language+} object to a BSON
2726
document for storage in MongoDB. {+driver-short+} automatically converts basic {+language+}
2827
types into BSON when you insert a document into a collection. Similarly, when you retrieve a
2928
document from a collection, {+driver-short+} automatically converts the returned BSON
3029
back into the corresponding {+language+} types.
3130

32-
You can use {+driver-short+} to serialize and deserialize the following {+language+}
33-
types:
34-
35-
- ``str``
36-
- ``int``
37-
- ``float``
38-
- ``bool``
39-
- ``datetime.datetime``
40-
- ``list``
41-
- ``dict``
42-
- ``None``
43-
4431
For a complete list of {+language+}-to-BSON mappings, see the `bson <{+api-root+}bson/index.html>`__
4532
API documentation.
4633

source/index.txt

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,18 +87,32 @@ Atlas Search
8787
Learn how to use Atlas Search to build full-text search capabilities in the
8888
`Atlas Search tutorial <https://www.mongodb.com/docs/atlas/atlas-search/tutorial/>`__.
8989

90-
Secure Your Data
91-
----------------
90+
Atlas Vector Search
91+
-------------------
9292

93-
Learn about ways you can authenticate your application and encrypt your data in
94-
the :ref:`pymongo-security` section.
93+
Learn how to use Atlas Vector Search to query your Atlas data based on semantic meaning
94+
rather than keyword matches in the
95+
`Atlas Vector Search <https://www.mongodb.com/docs/atlas/atlas-search/tutorial/>`__
96+
documentation.
9597

9698
Monitoring and Logging
9799
----------------------
98100

99101
Learn how to monitor changes to your application and write them to logs in the
100102
:ref:`pymongo-monitoring-logging` section.
101103

104+
Secure Your Data
105+
----------------
106+
107+
Learn about ways you can authenticate your application and encrypt your data in
108+
the :ref:`pymongo-security` section.
109+
110+
Reference
111+
---------
112+
113+
Find more information about {+driver-short+} versions, compatibility, and third-party tools
114+
in the the :ref:`pymongo-reference` section.
115+
102116
API Documentation
103117
-----------------
104118

@@ -109,6 +123,4 @@ Issues & Help
109123
-------------
110124

111125
Learn how to report bugs, contribute to the driver, and find help in the
112-
:ref:`<pymongo-issues-help>` section.
113-
114-
126+
:ref:`<pymongo-issues-help>` section.

source/reference.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Reference
1212
Compatibility </reference/compatibility>
1313
Third-Party Tools </reference/third-party-tools>
1414
Upgrade Guides </reference/upgrade>
15-
Migration Guides </reference/migration>
15+
Migrate to PyMongo Async </reference/migration>
1616
Previous Versions </reference/previous-versions>

source/reference/migration.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ The following Motor method signatures behave differently in the {+driver-async+}
7272

7373
.. _pymongo-to-async-guide:
7474

75-
Switch from {+driver-short+}
76-
----------------------------
75+
Migrate from {+driver-short+}
76+
-----------------------------
7777

7878
The {+driver-async+} driver behaves similarly to {+driver-short+}, but
7979
all methods that perform network operations are coroutines and must be awaited.
80-
To switch from {+driver-short+} to {+driver-async+}, you must update your code
80+
To migrate from {+driver-short+} to {+driver-async+}, you must update your code
8181
in the following ways:
8282

8383
- Replace all uses of ``MongoClient`` with ``AsyncMongoClient``.

0 commit comments

Comments
 (0)