README

A PHP client driver for the RethinkDB query language (ReQL).

PHP-RQL is licensed under the terms of the Apache License 2.0 http://www.apache.org/licenses/LICENSE-2.0

Continuous Integration

Master branch: 👁 master branch

Development branch: 👁 dev branch

To run the tests at the command line, issue composer install and then composer test at the package root. This requires composer to be available in $PATH.

Documentation

Read the PHP-RQL API documentation.

The official JavaScript driver documentation has more details on the available terms. Most examples for the JavaScript driver can be translated to PHP-RQL with few changes.

Example

<?php
 // Load the driver
 require_once("rdb/rdb.php");

 // Connect to localhost
 $conn = r\connect('localhost');

 // Create a test table
 r\db("test")->tableCreate("tablePhpTest")->run($conn);

 // Insert a document
 $document = array('someKey' => 'someValue');
 $result = r\table("tablePhpTest")->insert($document)
 ->run($conn);
 echo "Insert: $result\n";

 // How many documents are in the table?
 $result = r\table("tablePhpTest")->count()->run($conn);
 echo "Count: $result\n";

 // List the someKey values of the documents in the table
 // (using a mapping-function)
 $result = r\table("tablePhpTest")->map(function($x) {
 return $x('someKey');
 })->run($conn);

 foreach ($result as $doc) {
 print_r($doc);
 }

 // Delete the test table
 r\db("test")->tableDrop("tablePhpTest")->run($conn);
?>

Release Notes

...are available on the main website: http://php-rql.dnsalias.net

Attributions

• PHP-RQL uses pb4php http://code.google.com/p/pb4php/ by Nikolai Kordulla.
• The API documentation is based on the official RethinkDB API documentation.
• The API documentation is built using jTokenizer by Tim Whitlock (http://timwhitlock.info) and PHP Markdown by Michel Fortin (https://michelf.ca/).