ベンダー固有のモジュール
PHP マニュアル

tokyo_tyrant

目次

TokyoTyrant クラス

はじめに

Tokyo Tyrant のメインクラスです。

クラス概要

TokyoTyrant
class TokyoTyrant {
/* 定数 */
const int TokyoTyrant::RDBDEF_PORT = 1978 ;
const int TokyoTyrant::RDBQC_STREQ = 0 ;
const int TokyoTyrant::RDBQC_STRINC = 1 ;
const int TokyoTyrant::RDBQC_STRBW = 2 ;
const int TokyoTyrant::RDBQC_STREW = 3 ;
const int TokyoTyrant::RDBQC_STRAND = 4 ;
const int TokyoTyrant::RDBQC_STROR = 5 ;
const int TokyoTyrant::RDBQC_STROREQ = 6 ;
const int TokyoTyrant::RDBQC_STRRX = 7 ;
const int TokyoTyrant::RDBQC_NUMEQ = 8 ;
const int TokyoTyrant::RDBQC_NUMGT = 9 ;
const int TokyoTyrant::RDBQC_NUMGE = 10 ;
const int TokyoTyrant::RDBQC_NUMLT = 11 ;
const int TokyoTyrant::RDBQC_NUMLE = 12 ;
const int TokyoTyrant::RDBQC_NUMBT = 13 ;
const int TokyoTyrant::RDBQC_NUMOREQ = 14 ;
const int TokyoTyrant::RDBQC_NEGATE = 16777216 ;
const int TokyoTyrant::RDBQC_NOIDX = 33554432 ;
const int TokyoTyrant::RDBQO_STRASC = 0 ;
const int TokyoTyrant::RDBQO_STRDESC = 1 ;
const int TokyoTyrant::RDBQO_NUMASC = 2 ;
const int TokyoTyrant::RDBQO_NUMDESC = 3 ;
const int TokyoTyrant::RDBIT_LEXICAL = 0 ;
const int TokyoTyrant::RDBIT_DECIMAL = 1 ;
const int TokyoTyrant::RDBIT_TOKEN = 2 ;
const int TokyoTyrant::RDBIT_QGRAM = 3 ;
const int TokyoTyrant::RDBIT_OPT = 9998 ;
const int TokyoTyrant::RDBIT_VOID = 9999 ;
const int TokyoTyrant::RDBIT_KEEP = 16777216 ;
const int TokyoTyrant::RDBQCFTS_PH = 15 ;
const int TokyoTyrant::RDBQCFTS_AND = 16 ;
const int TokyoTyrant::RDBQCFTS_OR = 17 ;
const int TokyoTyrant::RDBQCFTS_EX = 18 ;
const int TokyoTyrant::RDBXO_LCKREC = 1 ;
const int TokyoTyrant::RDBXOLCK_GLB = 2 ;
const int TokyoTyrant::RDBREC_INT = 1 ;
const int TokyoTyrant::RDBREC_DBL = 2 ;
const int TokyoTyrant::RDBMS_UNION = 0 ;
const int TokyoTyrant::RDBMS_ISECT = 1 ;
const int TokyoTyrant::RDBMS_DIFF = 2 ;
const int TokyoTyrant::RDBT_RECON = 1 ;
/* メソッド */
public intfloat add ( string $key , intfloat $increment [, int $type = 0 ] )
public TokyoTyrant connect ( string $host [, int $port = TokyoTyrant::RDBDEF_PORT [, array $options ]] )
public TokyoTyrant connectUri ( string $uri )
public __construct ([ string $host [, int $port = TokyoTyrant::RDBDEF_PORT [, array $options ]]] )
public TokyoTyrant copy ( string $path )
public string ext ( string $name , int $options , string $key , string $value )
public array fwmKeys ( string $prefix , int $max_recs )
public mixed get ( mixed $keys )
public TokyoTyrantIterator getIterator ( void )
public int num ( void )
public TokyoTyrant out ( mixed $keys )
public TokyoTyrant put ( mixed $keys [, string $value = NULL ] )
public TokyoTyrant putCat ( mixed $keys [, string $value ] )
public TokyoTyrant putKeep ( mixed $keys [, string $value ] )
public TokyoTyrant putNr ( mixed $keys [, string $value = NULL ] )
public mixed putShl ( string $key , string $value , int $width )
public mixed restore ( string $log_dir , int $timestamp [, bool $check_consistency = true ] )
public mixed setMaster ( string $host , int $port , int $timestamp [, bool $check_consistency = true ] )
public int size ( string $key )
public array stat ( void )
public mixed sync ( void )
public TokyoTyrant tune ( float $timeout [, int $options = TokyoTyrant::RDBT_RECON ] )
public mixed vanish ( void )
}

定義済み定数

TokyoTyrant の定数

TokyoTyrant::RDBDEF_PORT

Tokyo Tyrant データベースのデフォルトのポート

TokyoTyrant::RDBQC_STREQ

文字列が～に等しい

TokyoTyrant::RDBQC_STRINC

文字列が～に含まれる

TokyoTyrant::RDBQC_STRBW

文字列が～で始まる

TokyoTyrant::RDBQC_STREW

文字列が～で終わる

TokyoTyrant::RDBQC_STRAND

文字列が～のすべてのトークンを含む

TokyoTyrant::RDBQC_STROR

文字列が～の少なくともひとつのトークンを含む

TokyoTyrant::RDBQC_STROREQ

文字列が～の少なくともひとつのトークンに等しい

TokyoTyrant::RDBQC_STRRX

文字列が正規表現にマッチする

TokyoTyrant::RDBQC_NUMEQ

数値が～に等しい

TokyoTyrant::RDBQC_NUMGT

数値が～より大きい

TokyoTyrant::RDBQC_NUMGE

数値が～以上

TokyoTyrant::RDBQC_NUMLT

数値が～未満

TokyoTyrant::RDBQC_NUMLE

数値が～以下

TokyoTyrant::RDBQC_NUMBT

数値が～と～の間にある

TokyoTyrant::RDBQC_NUMOREQ

数値が～のすくなくともひとつのトークンに等しい

TokyoTyrant::RDBQC_NEGATE

否定フラグ

TokyoTyrant::RDBQC_NOIDX

非インデックスフラグ

TokyoTyrant::RDBQO_STRASC

文字列の昇順

TokyoTyrant::RDBQO_STRDESC

文字列の降順

TokyoTyrant::RDBQO_NUMASC

数値の昇順

TokyoTyrant::RDBQO_NUMDESC

数値の降順

TokyoTyrant::RDBIT_LEXICAL

レキシカル文字列

TokyoTyrant::RDBIT_DECIMAL

十進文字列

TokyoTyrant::RDBIT_TOKEN

トークン転置インデックス (Tokyo Tyrant >= 1.1.29)

TokyoTyrant::RDBIT_QGRAM

QGRAM 転置インデックス (Tokyo Tyrant >= 1.1.29)

TokyoTyrant::RDBIT_OPT

最適化

TokyoTyrant::RDBIT_VOID

void

TokyoTyrant::RDBIT_KEEP

既存のインデックスを保持する

TokyoTyrant::RDBQCFTS_PH

フレーズによる全文検索 (Tokyo Tyrant >= 1.1.29)

TokyoTyrant::RDBQCFTS_AND

すべてのトークンを含むものを全文検索 (Tokyo Tyrant >= 1.1.29)

TokyoTyrant::RDBQCFTS_OR

少なくともひとつのトークンを含むものを全文検索 (Tokyo Tyrant >= 1.1.29)

TokyoTyrant::RDBQCFTS_EX

複合式による全文検索 (Tokyo Tyrant >= 1.1.29)

TokyoTyrant::RDBQCFTS_AND

レコード間の union メタ検索 (Tokyo Tyrant >= 1.1.33)

TokyoTyrant::RDBQCFTS_OR

レコード間の intersection メタ検索 (Tokyo Tyrant >= 1.1.33)

TokyoTyrant::RDBQCFTS_EX

レコード間の difference メタ検索 (Tokyo Tyrant >= 1.1.33)

TokyoTyrant::RDBT_RECON

接続失敗時に再接続するかどうか。 持続的な接続の場合はこのパラメータを on にしておくことを推奨します。

TokyoTyrant::RDBXOLCK_REC

レコードロック

TokyoTyrant::RDBXOLCK_GLB

グローバルロック

TokyoTyrant::RDBREC_INT

レコード型 int

TokyoTyrant::RDBREC_DBL

レコード型 float (double)

TokyoTyrant::TTE_SUCCESS

成功

TokyoTyrant::TTE_INVALID

無効な操作

TokyoTyrant::TTE_NOHOST

ホストが見つからない

TokyoTyrant::TTE_REFUSED

接続が拒否された

TokyoTyrant::TTE_SEND

送信エラー

TokyoTyrant::TTE_RECV

受信エラー

TokyoTyrant::TTE_KEEP

レコードが存在する

TokyoTyrant::TTE_NOREC

レコードが見つからない

TokyoTyrant::TTE_MISC

その他雑多なエラー

TokyoTyrantTable クラス

はじめに

テーブルデータベースへの API を提供します。 テーブルデータベースを作成するには ttserver -port 1979 /tmp/tt_table.tct のようなコマンドを実行します。Tokyo Tyrant のテーブル API はスキーマのないデータベースで、任意の数の key-value ペアをひとつの主キーのもとに格納することができます。

クラス概要

TokyoTyrantTable
class TokyoTyrantTable extends TokyoTyrant {
/* メソッド */
public void add ( string $key , mixed $increment [, string $type ] )
public int genUid ( void )
public array get ( mixed $keys )
public TokyoTyrantIterator getIterator ( void )
public TokyoTyrantQuery getQuery ( void )
public void out ( mixed $keys )
public int put ( string $key , array $columns )
public void putCat ( string $key , array $columns )
public void putKeep ( string $key , array $columns )
public void putNr ( mixed $keys [, string $value ] )
public void putShl ( string $key , string $value , int $width )
public mixed setIndex ( string $column , int $type )
/* 継承したメソッド */
public intfloat TokyoTyrant::add ( string $key , intfloat $increment [, int $type = 0 ] )
public TokyoTyrant TokyoTyrant::connect ( string $host [, int $port = TokyoTyrant::RDBDEF_PORT [, array $options ]] )
public TokyoTyrant TokyoTyrant::connectUri ( string $uri )
public TokyoTyrant::__construct ([ string $host [, int $port = TokyoTyrant::RDBDEF_PORT [, array $options ]]] )
public TokyoTyrant TokyoTyrant::copy ( string $path )
public string TokyoTyrant::ext ( string $name , int $options , string $key , string $value )
public array TokyoTyrant::fwmKeys ( string $prefix , int $max_recs )
public mixed TokyoTyrant::get ( mixed $keys )
public TokyoTyrantIterator TokyoTyrant::getIterator ( void )
public int TokyoTyrant::num ( void )
public TokyoTyrant TokyoTyrant::out ( mixed $keys )
public TokyoTyrant TokyoTyrant::put ( mixed $keys [, string $value = NULL ] )
public TokyoTyrant TokyoTyrant::putCat ( mixed $keys [, string $value ] )
public TokyoTyrant TokyoTyrant::putKeep ( mixed $keys [, string $value ] )
public TokyoTyrant TokyoTyrant::putNr ( mixed $keys [, string $value = NULL ] )
public mixed TokyoTyrant::putShl ( string $key , string $value , int $width )
public mixed TokyoTyrant::restore ( string $log_dir , int $timestamp [, bool $check_consistency = true ] )
public mixed TokyoTyrant::setMaster ( string $host , int $port , int $timestamp [, bool $check_consistency = true ] )
public int TokyoTyrant::size ( string $key )
public array TokyoTyrant::stat ( void )
public mixed TokyoTyrant::sync ( void )
public TokyoTyrant TokyoTyrant::tune ( float $timeout [, int $options = TokyoTyrant::RDBT_RECON ] )
public mixed TokyoTyrant::vanish ( void )
}

TokyoTyrantQuery クラス

はじめに

このクラスは、テーブルデータベースへの問い合わせに使用します。

クラス概要

TokyoTyrantQuery
class TokyoTyrantQuery implements Iterator {
/* メソッド */
public mixed addCond ( string $name , int $op , string $expr )
public __construct ( TokyoTyrantTable $table )
public int count ( void )
public array current ( void )
public string hint ( void )
public string key ( void )
public array metaSearch ( array $queries , int $type )
public array next ( void )
public TokyoTyrantQuery out ( void )
public bool rewind ( void )
public array search ( void )
public mixed setLimit ([ int $max [, int $skip ]] )
public mixed setOrder ( string $name , int $type )
public bool valid ( void )
}

TokyoTyrantIterator クラス

はじめに

TokyoTyrant および TokyoTyrantTable オブジェクト用のイテレータです。 データベース内のすべてのキーおよび値を反復処理します。 TokyoTyrantIterator はバージョン 0.2.0 で追加されました。

クラス概要

TokyoTyrantIterator
class TokyoTyrantIterator implements Iterator {
/* メソッド */
public __construct ( mixed $object )
public mixed current ( void )
public mixed key ( void )
public mixed next ( void )
public void rewind ( void )
public bool valid ( void )
/* 継承したメソッド */
public intfloat TokyoTyrant::add ( string $key , intfloat $increment [, int $type = 0 ] )
public TokyoTyrant TokyoTyrant::connect ( string $host [, int $port = TokyoTyrant::RDBDEF_PORT [, array $options ]] )
public TokyoTyrant TokyoTyrant::connectUri ( string $uri )
public TokyoTyrant::__construct ([ string $host [, int $port = TokyoTyrant::RDBDEF_PORT [, array $options ]]] )
public TokyoTyrant TokyoTyrant::copy ( string $path )
public string TokyoTyrant::ext ( string $name , int $options , string $key , string $value )
public array TokyoTyrant::fwmKeys ( string $prefix , int $max_recs )
public mixed TokyoTyrant::get ( mixed $keys )
public TokyoTyrantIterator TokyoTyrant::getIterator ( void )
public int TokyoTyrant::num ( void )
public TokyoTyrant TokyoTyrant::out ( mixed $keys )
public TokyoTyrant TokyoTyrant::put ( mixed $keys [, string $value = NULL ] )
public TokyoTyrant TokyoTyrant::putCat ( mixed $keys [, string $value ] )
public TokyoTyrant TokyoTyrant::putKeep ( mixed $keys [, string $value ] )
public TokyoTyrant TokyoTyrant::putNr ( mixed $keys [, string $value = NULL ] )
public mixed TokyoTyrant::putShl ( string $key , string $value , int $width )
public mixed TokyoTyrant::restore ( string $log_dir , int $timestamp [, bool $check_consistency = true ] )
public mixed TokyoTyrant::setMaster ( string $host , int $port , int $timestamp [, bool $check_consistency = true ] )
public int TokyoTyrant::size ( string $key )
public array TokyoTyrant::stat ( void )
public mixed TokyoTyrant::sync ( void )
public TokyoTyrant TokyoTyrant::tune ( float $timeout [, int $options = TokyoTyrant::RDBT_RECON ] )
public mixed TokyoTyrant::vanish ( void )
}

TokyoTyrantException クラス

はじめに

TokyoTyrantException

クラス概要

tokyotyrantexception
class tokyotyrantexception extends Exception {
/* プロパティ */
protected int $code ;
/* 継承したプロパティ */
protected string $message ;
protected int $code ;
protected string $file ;
protected int $line ;
/* 継承したメソッド */
final public string Exception::getMessage ( void )
final publicThrowablenull Exception::getPrevious ( void )
final public mixed Exception::getCode ( void )
final public string Exception::getFile ( void )
final public int Exception::getLine ( void )
final public array Exception::getTrace ( void )
final public string Exception::getTraceAsString ( void )
public string Exception::__toString ( void )
final private void Exception::__clone ( void )
}

プロパティ

code

例外コード。これを TokyoTyrant::TTE_* 定数と比較します。