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.

• Tutorials
• Extension Architecture and Internals

• Documentation

  • Library
  • Extension

• Changelog

  • Library
  • Extension

• Source Code

  • Library
  • Extension

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:

$ sudo pecl install mongodb

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

extension=mongodb.so

The preferred method of installing the PHP 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.

Connect to MongoDB Atlas¶

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

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

Connect to a MongoDB Server on Your Local Machine¶

If you need to run a MongoDB server on your local machine for development purposes instead of using an Atlas cluster, you need to complete the following:

1. Download the Community or Enterprise version of MongoDB Server.
2. Install and configure MongoDB Server.
3. Start the server.

After you successfully start your MongoDB server, specify your connection string in your driver connection code.

If your MongoDB Server is running locally, you can use the connection string "mongodb://localhost:<port>" where <port> is the port number you configured your server to listen for incoming connections.

If you need to specify a different hostname or IP address, see our Server Manual entry on Connection Strings.

To test whether you can connect to your server, replace the connection string in the Connect to MongoDB Atlas code example and run it.

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.

See Also¶

• PHP Libraries, Frameworks, and Tools