Php/docs/class.tokyotyranttable

• PHP Manual
• tokyo_tyrant
• The TokyoTyrantTable class

(PECL tokyo_tyrant >= 0.1.0)

Introduction

Provides an API to the table databases. A table database can be create using the following command: ttserver -port 1979 /tmp/tt_table.tct. In Tokyo Tyrant the table API is a schemaless database which can store arbitrary amount of key-value pairs under a single primary key.

Class synopsis

TokyoTyrantTable extends TokyoTyrant {

/* Methods */

public add ( string $key , mixed $increment [, string $type ] ) : void

public genUid ( ) : int

public get ( mixed $keys ) : array

public getIterator ( ) : TokyoTyrantIterator

public getQuery ( ) : TokyoTyrantQuery

public out ( mixed $keys ) : void

public put ( string $key , array $columns ) : int

public putCat ( string $key , array $columns ) : void

public putKeep ( string $key , array $columns ) : void

public putNr ( mixed $keys [, string $value ] ) : void

public putShl ( string $key , string $value , int $width ) : void

public setIndex ( string $column , int $type ) : mixed

/* Inherited methods */

public TokyoTyrant::add ( string $key , int|float $increment [, int $type = 0 ] ) : int|float

public TokyoTyrant::connect ( string $host [, int $port = TokyoTyrant::RDBDEF_PORT [, array $options ]] ) : TokyoTyrant

public TokyoTyrant::connectUri ( string $uri ) : TokyoTyrant

public TokyoTyrant::__construct ([ string $host [, int $port = TokyoTyrant::RDBDEF_PORT [, array $options ]]] )

public TokyoTyrant::copy ( string $path ) : TokyoTyrant

public TokyoTyrant::ext ( string $name , int $options , string $key , string $value ) : string

public TokyoTyrant::fwmKeys ( string $prefix , int $max_recs ) : array

public TokyoTyrant::get ( mixed $keys ) : mixed

public TokyoTyrant::getIterator ( ) : TokyoTyrantIterator

public TokyoTyrant::num ( ) : int

public TokyoTyrant::out ( mixed $keys ) : TokyoTyrant

public TokyoTyrant::put ( mixed $keys [, string $value = NULL ] ) : TokyoTyrant

public TokyoTyrant::putCat ( mixed $keys [, string $value ] ) : TokyoTyrant

public TokyoTyrant::putKeep ( mixed $keys [, string $value ] ) : TokyoTyrant

public TokyoTyrant::putNr ( mixed $keys [, string $value = NULL ] ) : TokyoTyrant

public TokyoTyrant::putShl ( string $key , string $value , int $width ) : mixed

public TokyoTyrant::restore ( string $log_dir , int $timestamp [, bool $check_consistency = TRUE ] ) : mixed

public TokyoTyrant::setMaster ( string $host , int $port , int $timestamp [, bool $check_consistency = TRUE ] ) : mixed

public TokyoTyrant::size ( string $key ) : int

public TokyoTyrant::stat ( ) : array

public TokyoTyrant::sync ( ) : mixed

public TokyoTyrant::tune ( float $timeout [, int $options = TokyoTyrant::RDBT_RECON ] ) : TokyoTyrant

public TokyoTyrant::vanish ( ) : mixed

}

Table of Contents

• TokyoTyrantTable::add — Adds a record
• TokyoTyrantTable::genUid — Generate unique id
• TokyoTyrantTable::get — Get a row
• TokyoTyrantTable::getIterator — Get an iterator
• TokyoTyrantTable::getQuery — Get a query object
• TokyoTyrantTable::out — Remove records
• TokyoTyrantTable::put — Store a row
• TokyoTyrantTable::putCat — Concatenates to a row
• TokyoTyrantTable::putKeep — Put a new record
• TokyoTyrantTable::putNr — Puts value
• TokyoTyrantTable::putShl — Concatenates to a record
• TokyoTyrantTable::setIndex — Sets index