@@ -18,68 +18,97 @@ MongoDB PHP Library
18
18
/indexes
19
19
/monitoring
20
20
/security
21
- /tutorial
22
- /upgrade
23
- /reference
24
- FAQ </faq>
25
21
/compatibility
26
22
/whats-new
23
+ FAQ </faq>
24
+ /reference
25
+
26
+ Overview
27
+ --------
28
+
29
+ Welcome to the documentation site for the official {+php-library+}.
27
30
28
- The |php-library| provides a high-level abstraction around the lower-level
31
+ The {+driver-short+} provides a high-level abstraction around the lower-level
29
32
:php:`mongodb extension <mongodb>`.
30
33
31
- The ``mongodb`` extension provides a limited API to connect to the database and
32
- execute generic commands, queries, and write operations. In contrast, the
33
- |php-library| provides a full-featured API and models client, database, and
34
- collection objects. Each of those classes provide various helper methods for
35
- performing operations in context. For example, :phpclass:`MongoDB\Collection`
36
- implements methods for executing CRUD operations and managing indexes on the
37
- collection, among other things.
34
+ The ``mongodb`` extension provides a limited API to connect to a MongoDB
35
+ database and execute generic commands, queries, and write operations. In
36
+ contrast, the {+driver-short+} provides a full-featured API and models client,
37
+ database, and collection objects. If you are developing a PHP application with
38
+ MongoDB, consider using the {+driver-short+} instead of the extension alone.
39
+
40
+ Get Started
41
+ -----------
42
+
43
+ Learn how to install the library and extension, establish a connection to MongoDB,
44
+ and begin working with data in the :ref:`php-get-started` tutorial.
45
+
46
+ Connect to MongoDB
47
+ ------------------
48
+
49
+ Learn how to create and configure a connection to a MongoDB deployment
50
+ in the :ref:`php-connect` section.
51
+
52
+ Databases and Collections
53
+ -------------------------
54
+
55
+ Learn how to use the {+driver-short+} to work with MongoDB databases and collections
56
+ in the :ref:`php-databases-collections` section.
38
57
39
- If you are developing a PHP application with MongoDB, you should consider using
40
- the |php-library| instead of the extension alone.
58
+ Read Data from MongoDB
59
+ ----------------------
41
60
42
- New to the PHP Library?
43
- -----------------------
61
+ Learn how you can retrieve data from MongoDB in the :ref:`php-read` section.
44
62
45
- If you have some experience with MongoDB but are new to the PHP library, the
46
- following pages should help you get started:
63
+ Write Data to MongoDB
64
+ ---------------------
47
65
48
- - :ref:`php-download-and-install`
66
+ Learn how you can write data to MongoDB in the :ref:`php-write` section.
49
67
50
- - :doc:`/tutorial/connecting`
68
+ Transform Your Data with Aggregation
69
+ ------------------------------------
51
70
52
- - :doc:`/tutorial/crud`
71
+ Learn how to use the {+driver-short+} to perform aggregation operations in the
72
+ :ref:`php-aggregation` section.
53
73
54
- - :doc:`/tutorial/commands`
74
+ Optimize Queries with Indexes
75
+ -----------------------------
55
76
56
- - :doc:`/tutorial/gridfs`
77
+ Learn how to work with common types of indexes in the :ref:`php-indexes`
78
+ section.
57
79
58
- - :doc:`/tutorial/modeling-bson-data`
80
+ Monitoring
81
+ ----------
59
82
60
- - :doc:`/reference/bson`
83
+ Learn how to monitor change events in the :ref:`php-monitoring`
84
+ section.
61
85
62
- Code examples can be found in the ``examples`` directory in the source code.
86
+ Secure Your Data
87
+ ----------------
63
88
64
- If you have previously worked with the legacy ``mongo`` extension, it will be
65
- helpful to review the :doc:`/upgrade` for a summary of API changes between the
66
- old driver and this library.
89
+ Learn about ways you can authenticate your application and encrypt your data in
90
+ the :ref:`php-security` section.
67
91
68
- You can view changes introduced in each version release of the
69
- {+php-library+} in the :ref:`php-lib-whats-new` section.
92
+ Compatibility
93
+ -------------
70
94
71
- New to MongoDB?
72
- ---------------
95
+ See compatibility tables showing the recommended {+driver-short+} version to use for
96
+ specific PHP and {+mdb-server+} versions in the :ref:`php-compatibility` section.
73
97
74
- If you are a new MongoDB user, the following links should help you become more
75
- familiar with MongoDB and introduce some of the concepts and terms you will
76
- encounter in the library documentation:
98
+ What's New
99
+ ----------
77
100
78
- - :manual:`Introduction to MongoDB </introduction>`
101
+ Learn about new features and changes in each version in the :ref:`<php-lib-whats-new>`
102
+ section.
79
103
80
- - :manual:`Databases and Collections </core/databases-and-collections>`
104
+ .. TODO:
105
+ Upgrade {+driver-short+} Versions
106
+ ---------------------------------
107
+ Learn what changes you might need to make to your application to upgrade driver versions
108
+ in the :ref:`php-upgrade` section.
81
109
82
- - :manual:`Documents </core/document>` and
83
- :manual:`BSON Types </reference/bson-types>`
110
+ FAQ
111
+ ---
84
112
85
- - :manual:`MongoDB CRUD Operations </crud>`
113
+ See answers to commonly asked questions about the {+driver-short+} in the
114
+ the :ref:`php-faq` section.
0 commit comments