First steps tutorial on how to use Tyrant with PHP

Connection

Currently, PHP Tyrant supports the two API proposed by Tokyo Tyrant, that is RDB for hash and b-tree databases, and RDBTable for Table databases.

You connect to your database server using its hostname and port.

$tt = Tyrant::connect('localhost', 1978);

In case you want to use multiple connections at the same time, PHP Tyrant keeps an internal pointer to them. It is also possible to connect to the same database server multiple times.

$tt1 = Tyrant::connect('localhost', 1978, 0);
$tt2 = Tyrant::connect('localhost', 1978, 1);
$tt3 = Tyrant::connect('ttserve.local', 1978);
$tt3 = Tyrant::connect('192.168.0.10', 1980);

In order to determine the database type your connection uses, PHP Tyrant will first query your server once it is connected, then load the appropriate driver, RDB or RDBTable.

Key-value API

Depending on your database type, adding records to the database will be different. Below are some basic operations for dealing with the RDB type.

Adding data

There are different ways to add records to the database. Tokyo Tyrant provides the following functions: put, putkeep, putcat, putshl and putnr. Example:

$tt->put('key', 'value');

PHP Tyrant also implements the ArrayAccess interface so it is possible to write the above like this:

$tt['key'] = 'value';

Getting data

$value = $tt['key'];

Deleting records

Records can be deleted by key.

$tt->out('key');

Tokyo Tyrant also provides a way to delete every records in the database.

$tt->vanish();

Iterator

PHP Tyrant implements the Iterator interface so it is possible to iterate over the records using foreach.

foreach ($tt as $k => $v) {
    var_dump($k, $v);
}

Tokyo Tyrant also provides a more native interface which might be a little faster, although a little less convenient.

$tt->iterinit();
while ($k = $tt->iternext()) {
    var_dump($k, $tt->get($k));
}