mongodb/mongodb

MongoDB driver library

1.20.0 2024-09-25 12:54 UTC

Requires

• php: ^7.4 || ^8.0
• composer-runtime-api: ^2.0
• ext-hash: *
• ext-json: *
• ext-mongodb: ^1.20.0
• psr/log: ^1.1.4|^2|^3
• symfony/polyfill-php80: ^1.27
• symfony/polyfill-php81: ^1.27

Requires (Dev)

• doctrine/coding-standard: ^12.0
• rector/rector: ^1.1
• squizlabs/php_codesniffer: ^3.7
• symfony/phpunit-bridge: ^5.2
• vimeo/psalm: ^5.13

Apache-2.0

• Andreas Braun
• Jeremy Mikola
• Jérôme Tamarelle

• database
• persistence
• mongodb
• driver

README

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

While the extension provides a limited API for executing commands, queries, and write operations, this library implements a full-featured API similar to that of other MongoDB drivers. It contains abstractions for client, database, and collection 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 using this library, or another high-level abstraction, instead of the extension alone.

Additional information about the architecture of this library and the mongodb extension may be found in Architecture Overview.

Documentation

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

Installation

The preferred method of installing this library is with Composer by running the following from your project root:

$ composer require mongodb/mongodb

Additional installation instructions may be found in the library documentation.

Since this library is a high-level abstraction for the driver, it also requires that the mongodb 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 its PHP.net documentation.

Release Integrity

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

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

Note

Composer does not support verifying signatures as part of its installation process.

Reporting Issues

Issues pertaining to the library should be reported in the PHPLIB project in MongoDB's JIRA. Extension-related issues should be reported in the PHPC project.

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

Security Vulnerabilities

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

Development

Development is tracked in the PHPLIB project in MongoDB's JIRA. Documentation for contributing to this project may be found in CONTRIBUTING.md.