Navigation

MongoDB PHP Driver

Introduction

The PHP driver consists of two components, the MongoDB extension and library.

The extension provides a low-level API and mainly serves to integrate libmongoc and libbson with PHP.

While it is possible to use the extension alone, users are strongly encouraged to use the extension and library together. The library provides a high-level API consistent with other MongoDB language drivers.

Installation

First, make sure you have a recent version of PHP installed on your system. See the official PHP manual for download and installation instructions.

Install the PHP MongoDB Extension before installing the PHP Library for MongoDB. You can install the extension using PECL on the command line:

1
$ sudo pecl install mongodb

Finally, add the following line to your php.ini file:

1
extension=mongodb.so

note

On some systems, there may be multiple INI files for individual SAPIs (e.g. CLI, FPM). Make sure to enable the extension in all SAPIs that you need.

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

1
$ composer require mongodb/mongodb

Additional installation instructions may be found in the library documentation.

Connect to MongoDB Atlas

To connect to a MongoDB Atlas cluster, use the Atlas connection string for your cluster:

1
2
3
4
5
6
7
<?php $client = new MongoDB\Client( 'mongodb+srv://<username>:<password>@<cluster-address>/test?retryWrites=true&w=majority' ); $db = $client->test;

Compatibility

Due to potential problems representing 64-bit integers on 32-bit platforms, users are advised to use 64-bit environments. When using a 32-bit platform, be aware that any 64-bit integer read from the database will be returned as a MongoDB\BSON\Int64 instance instead of a PHP integer type.

MongoDB Compatibility

PHP DriverMongoDB 4.2MongoDB 4.0MongoDB 3.6MongoDB 3.4MongoDB 3.2MongoDB 3.0MongoDB 2.6
ext 1.6 + lib 1.5
ext 1.5 + lib 1.4
ext 1.4 + lib 1.3
ext 1.3 + lib 1.2
ext 1.2 + lib 1.1
ext 1.1 + lib 1.0
ext 1.0

Language Compatibility

PHP DriverPHP 7.4PHP 7.3PHP 7.2PHP 7.1PHP 7.0PHP 5.6PHP 5.5
ext 1.6 + lib 1.5
ext 1.5 + lib 1.4
ext 1.4 + lib 1.3
ext 1.3 + lib 1.2

How to get help

See Also