|
1 | 1 | .. _pymongo-index:
|
2 | 2 |
|
3 |
| -MongoDB PyMongo Documentation |
| 3 | +MongoDB {+driver-short+} Documentation |
4 | 4 | =============================
|
5 | 5 |
|
6 | 6 | .. facet::
|
@@ -33,96 +33,108 @@ MongoDB PyMongo Documentation
|
33 | 33 |
|
34 | 34 | Overview
|
35 | 35 | --------
|
36 |
| -**PyMongo** is a Python distribution containing tools for working with |
37 |
| -`MongoDB <http://www.mongodb.org>`_, and is the recommended way to |
38 |
| -work with MongoDB from Python. This documentation attempts to explain |
39 |
| -everything you need to know to use **PyMongo**. |
40 | 36 |
|
41 |
| -Previous Versions |
42 |
| ------------------ |
43 |
| - |
44 |
| -For documentation on versions of the driver v4.6.x and earlier, see the :ref:`pymongo-previous-versions` section. |
| 37 | +Welcome to the documentation site for the official MongoDB {+driver-short+} |
| 38 | +Driver. PyMongo is a Python distribution containing tools for working with |
| 39 | +MongoDB, and is the recommended way to work with MongoDB from Python. |
45 | 40 |
|
46 |
| -Quick Start |
| 41 | +Get Started |
47 | 42 | -----------
|
48 | 43 |
|
49 |
| -Learn how to establish a connection to MongoDB and begin |
50 |
| -working with data in the :ref:`pymongo-quickstart` section. |
| 44 | +Learn how to install the driver, establish a connection to MongoDB, and begin |
| 45 | +working with data in the :ref:`pymongo-get-started` tutorial. |
51 | 46 |
|
52 |
| -What's New |
53 |
| ----------- |
| 47 | +Databases and Collections |
| 48 | +------------------------- |
| 49 | + |
| 50 | +Learn how to use {+driver-short+} to work with MongoDB databases and collections |
| 51 | +in the :ref:`pymongo-databases-collections` section. |
| 52 | + |
| 53 | +Write Data to MongoDB |
| 54 | +--------------------- |
| 55 | + |
| 56 | +Learn how you can write data to MongoDB in the :ref:`pymongo-write` section. |
| 57 | + |
| 58 | +Read Data from MongoDB |
| 59 | +---------------------- |
54 | 60 |
|
55 |
| -For a list of new features and changes in each version, see the :ref:`What's New <pymongo-whats-new>` |
| 61 | +Learn how you can retrieve data from MongoDB in the :ref:`pymongo-read` section. |
| 62 | + |
| 63 | +Optimize Queries with Indexes |
| 64 | +----------------------------- |
| 65 | + |
| 66 | +Learn how to work with common types of indexes in the :ref:`pymongo-indexes` |
56 | 67 | section.
|
57 | 68 |
|
58 |
| -Fundamentals |
59 |
| ------------- |
| 69 | +Transform Your Data with Aggregation |
| 70 | +------------------------------------ |
60 | 71 |
|
61 |
| -For detailed information on key concepts of using the {+driver-short+}, see |
62 |
| -:ref:`pymongo-fundamentals`. |
| 72 | +Learn how to use {+driver-short+} to perform aggregation operations in the |
| 73 | +:ref:`pymongo-aggregation` section. |
63 | 74 |
|
64 |
| -Tools |
65 |
| ------ |
66 |
| -For a list of Python tools and libraries that have been written for |
67 |
| -MongoDB, see the :ref:`pymongo-tools` section. |
| 75 | +Secure Your Data |
| 76 | +---------------- |
68 | 77 |
|
69 |
| -API Documentation |
| 78 | +Learn about ways you can authenticate your application and encrypt your data in |
| 79 | +the :ref:`pymongo-security` section. |
| 80 | + |
| 81 | +Specialized Data Formats |
| 82 | +------------------------ |
| 83 | + |
| 84 | +Learn how to work with specialized data formats and custom types in the |
| 85 | +:ref:`pymongo-data-formats` section. |
| 86 | + |
| 87 | +Third-Party Tools |
70 | 88 | -----------------
|
71 | 89 |
|
72 |
| -For detailed information about types and methods in {+driver-short+}, see |
73 |
| -the `{+driver-short+} API documentation |
74 |
| -<{+api-root+}>`__. |
| 90 | +For a list of popular third-party Python libraries for working with |
| 91 | +MongoDB, see the :ref:`pymongo-tools` section. |
75 | 92 |
|
76 |
| -FAQ |
77 |
| ---- |
| 93 | +Frequently Asked questions |
| 94 | +-------------------------- |
78 | 95 |
|
79 |
| -For answers to commonly asked questions about {+driver-short+}, see the :ref:`pymongo-faq` |
80 |
| -section. |
| 96 | +For answers to commonly asked questions about {+driver-short+}, see the |
| 97 | +:ref:`pymongo-faq` section. |
81 | 98 |
|
82 | 99 | Troubleshooting
|
83 | 100 | ---------------
|
84 | 101 |
|
85 |
| -For solutions to issues you might encounter when using the driver, |
86 |
| -see the :ref:`pymongo-troubleshooting` section. |
| 102 | +For solutions to issues you might encounter when using the driver, see the |
| 103 | +:ref:`pymongo-troubleshooting` section. |
| 104 | + |
| 105 | +What's New |
| 106 | +---------- |
| 107 | + |
| 108 | +For a list of new features and changes in each version, see the :ref:`<pymongo-whats-new>` |
| 109 | +section. |
| 110 | + |
| 111 | +Upgrade {+driver-short+} Versions |
| 112 | +------------------------ |
| 113 | + |
| 114 | +Learn what changes you might need to make to your application to upgrade driver versions |
| 115 | +in the :ref:`pymongo-upgrade` section. |
| 116 | + |
| 117 | +Previous Versions |
| 118 | +----------------- |
| 119 | + |
| 120 | +For documentation on versions of the driver v4.6.x and earlier, see the |
| 121 | +:ref:`pymongo-previous-versions` section. |
87 | 122 |
|
88 | 123 | Issues & Help
|
89 | 124 | -------------
|
90 | 125 |
|
91 | 126 | Learn how to report bugs, contribute to the driver, and find help in the
|
92 | 127 | :ref:`<pymongo-issues-help>` section.
|
93 | 128 |
|
94 |
| -Upgrade Driver Versions |
95 |
| ------------------------ |
| 129 | +Compatibility |
| 130 | +------------- |
96 | 131 |
|
97 |
| -Learn what changes you might need to make to your application to upgrade |
98 |
| -driver versions in the :ref:`Upgrade Driver Versions <pymongo-upgrade>` |
99 |
| -section. |
| 132 | +For compatibility tables that show the recommended {+driver-short+} |
| 133 | +version to use for specific Python and MongoDB Server versions, see the |
| 134 | +:ref:`pymongo-compatibility` section. |
100 | 135 |
|
101 |
| -Getting Help |
102 |
| ------------- |
103 |
| -If you're having trouble or have questions about PyMongo, ask your question on |
104 |
| -our `MongoDB Community Forum <https://www.mongodb.com/community/forums/tag/python>`_. |
105 |
| -You may also want to consider a |
106 |
| -`commercial support subscription <https://support.mongodb.com/welcome>`_. |
107 |
| -Once you get an answer, it'd be great if you could work it back into this |
108 |
| -documentation and contribute! |
109 |
| - |
110 |
| -Issues |
111 |
| ------- |
112 |
| -All issues should be reported (and can be tracked / voted for / |
113 |
| -commented on) at the main `MongoDB JIRA bug tracker |
114 |
| -<http://jira.mongodb.org/browse/PYTHON>`_, in the "Python Driver" |
115 |
| -project. |
116 |
| - |
117 |
| -Feature Requests / Feedback |
118 |
| ---------------------------- |
119 |
| -Use our `feedback engine <https://feedback.mongodb.com/forums/924286-drivers>`_ |
120 |
| -to send us feature requests and general feedback about PyMongo. |
121 |
| - |
122 |
| -Contributing |
123 |
| ------------- |
124 |
| -**PyMongo** has a large community and |
125 |
| -contributions are always encouraged. Contributions can be as simple as |
126 |
| -minor tweaks to this documentation. To contribute, fork the project on |
127 |
| -`GitHub <http://github.com/mongodb/mongo-python-driver/>`_ and send a |
128 |
| -pull request. |
| 136 | +API Documentation |
| 137 | +----------------- |
| 138 | + |
| 139 | +For detailed information about types and methods in {+driver-short+}, see |
| 140 | +the `{+driver-short+} API documentation <{+api-root+}>`__. |
0 commit comments