# TokyoTyrant クラス

(PECL tokyo_tyrant >= 0.1.0)

## はじめに

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

## クラス概要

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

## 定義済み定数

## 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`

  その他雑多なエラー

## 目次

- TokyoTyrant::add — 数値キーを加算する
- TokyoTyrant::connect — データベースに接続する
- TokyoTyrant::connectUri — データベースに接続する
- TokyoTyrant::__construct — 新しい TokyoTyrant オブジェクトを作成する
- TokyoTyrant::copy — データベースをコピーする
- TokyoTyrant::ext — リモートスクリプトを実行する
- TokyoTyrant::fwmKeys — 前方一致でマッチするキーを返す
- TokyoTyrant::get — 値を取得する
- TokyoTyrant::getIterator — イテレータを取得する
- TokyoTyrant::num — データベース内のレコードの数を取得する
- TokyoTyrant::out — レコードを削除する
- TokyoTyrant::put — 値を格納する
- TokyoTyrant::putCat — レコードを連結する
- TokyoTyrant::putKeep — レコードを書き込む
- TokyoTyrant::putNr — 値を格納する
- TokyoTyrant::putShl — レコードを連結する
- TokyoTyrant::restore — Restore the database
- TokyoTyrant::setMaster — Set the replication master
- TokyoTyrant::size — 値のサイズを返す
- TokyoTyrant::stat — 統計情報を取得する
- TokyoTyrant::sync — データベースを同期させる
- TokyoTyrant::tune — 接続の値を調節する
- TokyoTyrant::vanish — データベースを空にする