MongoDB driver for HHVM

This is an implementation of the MongoDB PHP driver for HHVM. It is not feature-complete and should be considered experimental.

This project is not officially supported and GitHub issues have been disabled.

Dependencies

Compiling this extension requires the following libraries:

HHVM (>=3.1.0) must be compiled from source, since the binary distributions of HHVM do not include necessary development headers. Instructions for compiling HHVM may be found here.
libmongoc (>=0.94.0) and its corresponding libbson dependency must be installed as a system library. Instructions for installing libmongoc may be found here.

Building and installation

Ensure that the HPHP_HOME environment variable is set to the HHVM project directory. This should be the path to the cloned HHVM git repository where you compiled the project.

$ export HPHP_HOME=/path/to/hhvm

Execute this project's build.sh script:

$ ./build.sh

This script checks for the HHVM path, executes hphpize to prepare the build process, and finally executes cmake and make to compile the extension.

The build process will produce a mongo.so file, which can then be dynamically loaded by HHVM by adding the following to HHVM's config.hdf file:

DynamicExtensions {
  mongo = /path/to/mongo.so
}

This example is taken from the Extension API documentation.

Note that the mongo key in this example is a placeholder; HHVM only cares that the path to the mongo.so file is correct. You may notice that in our test script, we use 0 as a key when specifying our extension via the command line.

Tests

The test suite is implemented with PHPUnit and may be executed via the test.sh script:

$ ./test.sh

The test script depends on the HPHP_HOME environment variable and will attempt to locate PHPUnit via the which command, so ensure that the phpunit binary is installed in an executable path.

Interactive Mode

To try out this work in progress for yourself, you can run the extension in interactive mode on HipHop VM via the interactive_mode.sh script:

$ ./interactive_mode.sh

Once in interactive mode, you can execute queries and all implemented methods on your existing local databases. For example, if a test database exists with a students collection, I can access one document in that collection by running the following commands:

hphpd> $cli = new MongoClient();
hphpd> $db = $cli->selectDB('test');
hphpd> $coll = $db->selectCollection('students');
hphpd> $cur = $coll->find()->limit(1);
hphpd> $cur->rewind();
hphpd> var_dump($cur->current());

Credits