Repository files navigation

This library provides a high-level abstraction around the lower-levelPHP driver (mongodb extension).

While the extension provides a limited API for executing commands, queries, andwrite operations, this library implements a full-featured API similar to that ofother MongoDB drivers. It contains abstractions for client, database, andcollection objects, and provides methods for CRUD operations and common commands(e.g. index and collection management).

If you are developing an application with MongoDB, you should consider usingthis library, or another high-level abstraction, instead of the extension alone.

Additional information about the architecture of this library and themongodbextension may be found inArchitecture Overview.

• https://www.mongodb.com/docs/php-library/current/
• https://www.mongodb.com/docs/drivers/php-drivers/

The preferred method of installing this library is withComposer by running the following from your projectroot:

$ composer require mongodb/mongodb

Additional installation instructions may be found in thelibrary documentation.

Since this library is a high-level abstraction for the driver, it also requiresthat themongodb extension be installed:

$ pecl install mongodb$ echo "extension=mongodb.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"`

Additional installation instructions for the extension may be found in itsPHP.net documentation.

Releases are created automatically and the resulting release tag is signed usingthePHP team's GPG key. To verify thetag signature, download the key and import it usinggpg:

gpg --import php-driver.asc

Then, in a local clone, verify the signature of a given tag (e.g.1.19.0):

git show --show-signature 1.19.0

Issues pertaining to the library should be reported in thePHPLIBproject in MongoDB's JIRA. Extension-related issues should be reported in thePHPCproject.

For general questions and support requests, please use one of MongoDB'sTechnical Support channels.

If you've identified a security vulnerability in a driver or any other MongoDBproject, please report it according to the instructions inCreate a Vulnerability Report.

Development is tracked in thePHPLIB project in MongoDB'sJIRA. Documentation for contributing to this project may be found inCONTRIBUTING.md.