-
Notifications
You must be signed in to change notification settings - Fork 34
DOCSP-41950: Landing page #150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 6 commits
769bbae
8a54840
189a314
a6e34bf
6e0fb61
29f110a
76cb126
ac74278
8a63ade
3aa2059
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
.. _php-data-formats: | ||
|
||
======================== | ||
Specialized Data Formats | ||
======================== | ||
|
||
.. contents:: On this page | ||
:local: | ||
:backlinks: none | ||
:depth: 1 | ||
:class: singlecol | ||
|
||
.. facet:: | ||
:name: genre | ||
:values: reference | ||
|
||
.. meta:: | ||
:keywords: store, bson, codec | ||
|
||
.. toctree:: | ||
:titlesonly: | ||
:maxdepth: 1 | ||
|
||
/data-formats/custom-types | ||
/data-formats/codecs | ||
/data-formats/decimal128 | ||
/data-formats/modeling-bson-data | ||
|
||
|
||
Overview | ||
-------- | ||
|
||
You can use several types of specialized data formats in your {+driver-short+} | ||
application. To learn how to work with these data formats, see the following | ||
guides: | ||
|
||
- :ref:`php-custom-types` | ||
- :ref:`php-codecs` | ||
- :ref:`php-decimal128` | ||
- :ref:`php-bson` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _php-custom-types: | ||
|
||
================= | ||
Custom Data-Types | ||
================= | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _php-decimal128: | ||
|
||
========== | ||
Decimal128 | ||
========== | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _php-bson: | ||
|
||
================== | ||
Modeling BSON Data | ||
================== | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _php-faq: | ||
|
||
========================== | ||
Frequently Asked Questions | ||
========================== | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -18,68 +18,104 @@ | |||||
/indexes | ||||||
/monitoring | ||||||
/security | ||||||
/tutorial | ||||||
/upgrade | ||||||
/reference | ||||||
FAQ </faq> | ||||||
/data-formats | ||||||
/compatibility | ||||||
/whats-new | ||||||
FAQ </faq> | ||||||
/reference | ||||||
|
||||||
The |php-library| provides a high-level abstraction around the lower-level | ||||||
Overview | ||||||
-------- | ||||||
|
||||||
Welcome to the documentation site for the official {+php-library+}. | ||||||
|
||||||
The {+driver-short+} provides a high-level abstraction around the lower-level | ||||||
:php:`mongodb extension <mongodb>`. | ||||||
|
||||||
The ``mongodb`` extension provides a limited API to connect to the database and | ||||||
execute generic commands, queries, and write operations. In contrast, the | ||||||
|php-library| provides a full-featured API and models client, database, and | ||||||
collection objects. Each of those classes provide various helper methods for | ||||||
performing operations in context. For example, :phpclass:`MongoDB\Collection` | ||||||
implements methods for executing CRUD operations and managing indexes on the | ||||||
collection, among other things. | ||||||
The ``mongodb`` extension provides a limited API to connect to a MongoDB | ||||||
database and execute generic commands, queries, and write operations. In | ||||||
contrast, the {+driver-short+} provides a full-featured API and models client, | ||||||
database, and collection objects. If you are developing a PHP application with | ||||||
MongoDB, consider using the {+driver-short+} instead of the extension alone. | ||||||
|
||||||
Get Started | ||||||
----------- | ||||||
|
||||||
Learn how to install the library and extension, establish a connection to MongoDB, | ||||||
and begin working with data in the :ref:`php-get-started` tutorial. | ||||||
|
||||||
Connect to MongoDB | ||||||
------------------ | ||||||
|
||||||
Learn how to create and configure a connection to a MongoDB deployment | ||||||
in the :ref:`php-connect` section. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note to reviewer: link broken until #147 is merged |
||||||
|
||||||
Databases and Collections | ||||||
------------------------- | ||||||
|
||||||
Learn how to use the {+driver-short+} to work with MongoDB databases and collections | ||||||
in the :ref:`php-databases-collections` section. | ||||||
|
||||||
Read Data from MongoDB | ||||||
---------------------- | ||||||
|
||||||
Learn how you can retrieve data from MongoDB in the :ref:`php-read` section. | ||||||
|
||||||
If you are developing a PHP application with MongoDB, you should consider using | ||||||
the |php-library| instead of the extension alone. | ||||||
Write Data to MongoDB | ||||||
--------------------- | ||||||
|
||||||
New to the PHP Library? | ||||||
----------------------- | ||||||
Learn how you can write data to MongoDB in the :ref:`php-write` section. | ||||||
|
||||||
If you have some experience with MongoDB but are new to the PHP library, the | ||||||
following pages should help you get started: | ||||||
Transform Your Data with Aggregation | ||||||
------------------------------------ | ||||||
|
||||||
- :ref:`php-download-and-install` | ||||||
Learn how to use the {+driver-short+} to perform aggregation operations in the | ||||||
:ref:`php-aggregation` section. | ||||||
|
||||||
- :doc:`/tutorial/connecting` | ||||||
Optimize Queries with Indexes | ||||||
----------------------------- | ||||||
|
||||||
- :doc:`/tutorial/crud` | ||||||
Learn how to work with common types of indexes in the :ref:`php-indexes` | ||||||
section. | ||||||
|
||||||
- :doc:`/tutorial/commands` | ||||||
Monitoring | ||||||
---------- | ||||||
|
||||||
- :doc:`/tutorial/gridfs` | ||||||
Learn how to monitor change events in the :ref:`php-monitoring` | ||||||
section. | ||||||
|
||||||
- :doc:`/tutorial/modeling-bson-data` | ||||||
Secure Your Data | ||||||
---------------- | ||||||
|
||||||
- :doc:`/reference/bson` | ||||||
Learn about ways you can authenticate your application and encrypt your data in | ||||||
the :ref:`php-security` section. | ||||||
|
||||||
Code examples can be found in the ``examples`` directory in the source code. | ||||||
Specialized Data Formats | ||||||
------------------------ | ||||||
|
||||||
If you have previously worked with the legacy ``mongo`` extension, it will be | ||||||
helpful to review the :doc:`/upgrade` for a summary of API changes between the | ||||||
old driver and this library. | ||||||
Learn how to work with specialized data formats and custom types in the | ||||||
:ref:`php-data-formats` section. | ||||||
|
||||||
You can view changes introduced in each version release of the | ||||||
{+php-library+} in the :ref:`php-lib-whats-new` section. | ||||||
Compatibility | ||||||
------------- | ||||||
|
||||||
New to MongoDB? | ||||||
--------------- | ||||||
See compatibility tables showing the recommended {+driver-short+} version to use for | ||||||
specific PHP and {+mdb-server+} versions in the :ref:`php-compatibility` section. | ||||||
|
||||||
If you are a new MongoDB user, the following links should help you become more | ||||||
familiar with MongoDB and introduce some of the concepts and terms you will | ||||||
encounter in the library documentation: | ||||||
What's New | ||||||
---------- | ||||||
|
||||||
- :manual:`Introduction to MongoDB </introduction>` | ||||||
Learn about new features and changes in each version in the :ref:`<php-lib-whats-new>` | ||||||
section. | ||||||
|
||||||
- :manual:`Databases and Collections </core/databases-and-collections>` | ||||||
.. TODO: | ||||||
Upgrade {+driver-short+} Versions | ||||||
--------------------------------- | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. S: add newline under heading |
||||||
Learn what changes you might need to make to your application to upgrade driver versions | ||||||
Check failure on line 114 in source/index.txt
|
||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
in the :ref:`php-upgrade` section. | ||||||
|
||||||
- :manual:`Documents </core/document>` and | ||||||
:manual:`BSON Types </reference/bson-types>` | ||||||
FAQ | ||||||
--- | ||||||
|
||||||
- :manual:`MongoDB CRUD Operations </crud>` | ||||||
See answers to commonly asked questions about the {+driver-short+} in the | ||||||
the :ref:`php-faq` section. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
:orphan: | ||
|
||
Tutorials | ||
========= | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
:orphan: | ||
|
||
============================== | ||
Deploy to AWS Lambda with Bref | ||
============================== | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
:orphan: | ||
|
||
========= | ||
Collation | ||
========= | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
:orphan: | ||
|
||
========================= | ||
Execute Database Commands | ||
========================= | ||
|
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: should we rename "driver-short"? Line 37