<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The TokyoTyrantTable class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrant.vanish.html">TokyoTyrant::vanish</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyranttable.add.html">TokyoTyrantTable::add</a></div>
<div class="up"><a href="book.tokyo-tyrant.html">tokyo_tyrant</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.tokyotyranttable" class="reference">
<h1 class="title">The TokyoTyrantTable class</h1>
<div class="partintro"><p class="verinfo">(PECL tokyo_tyrant >= 0.1.0)</p>
<div class="section" id="tokyotyranttable.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Provides an API to the table databases. A table database can be create using the following
command: <em>ttserver -port 1979 /tmp/tt_table.tct</em>. In Tokyo Tyrant the table
API is a schemaless database which can store arbitrary amount of key-value pairs under a single
primary key.
</p>
</div>
<div class="section" id="tokyotyranttable.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">TokyoTyrantTable</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.tokyotyrant.html" class="classname">TokyoTyrant</a>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="tokyotyranttable.add.html" class="methodname">add</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$increment</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="tokyotyranttable.genuid.html" class="methodname">genUid</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="tokyotyranttable.get.html" class="methodname">get</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrantIterator</span> <span class="methodname"><a href="tokyotyranttable.getiterator.html" class="methodname">getIterator</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrantQuery</span> <span class="methodname"><a href="tokyotyranttable.getquery.html" class="methodname">getQuery</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="tokyotyranttable.out.html" class="methodname">out</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="tokyotyranttable.put.html" class="methodname">put</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$columns</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="tokyotyranttable.putcat.html" class="methodname">putCat</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$columns</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="tokyotyranttable.putkeep.html" class="methodname">putKeep</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$columns</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="tokyotyranttable.putnr.html" class="methodname">putNr</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="tokyotyranttable.putshl.html" class="methodname">putShl</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyranttable.setindex.html" class="methodname">setIndex</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$column</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">number</span> <span class="methodname"><a href="tokyotyrant.add.html" class="methodname">TokyoTyrant::add</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.number" class="type number">number</a></span> <code class="parameter">$increment</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code><span class="initializer"> = 0</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.connect.html" class="methodname">TokyoTyrant::connect</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = TokyoTyrant::RDBDEF_PORT</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.connecturi.html" class="methodname">TokyoTyrant::connectUri</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uri</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="tokyotyrant.construct.html" class="methodname">TokyoTyrant::__construct</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = TokyoTyrant::RDBDEF_PORT</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.copy.html" class="methodname">TokyoTyrant::copy</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="tokyotyrant.ext.html" class="methodname">TokyoTyrant::ext</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="tokyotyrant.fwmkeys.html" class="methodname">TokyoTyrant::fwmKeys</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$prefix</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$max_recs</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.get.html" class="methodname">TokyoTyrant::get</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrantIterator</span> <span class="methodname"><a href="tokyotyrant.getiterator.html" class="methodname">TokyoTyrant::getIterator</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="tokyotyrant.num.html" class="methodname">TokyoTyrant::num</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.out.html" class="methodname">TokyoTyrant::out</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.put.html" class="methodname">TokyoTyrant::put</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code><span class="initializer"> = NULL</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.putcat.html" class="methodname">TokyoTyrant::putCat</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.putkeep.html" class="methodname">TokyoTyrant::putKeep</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.putnr.html" class="methodname">TokyoTyrant::putNr</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$keys</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code><span class="initializer"> = NULL</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.putshl.html" class="methodname">TokyoTyrant::putShl</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.restore.html" class="methodname">TokyoTyrant::restore</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$log_dir</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timestamp</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$check_consistency</code><span class="initializer"> = true</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.setmaster.html" class="methodname">TokyoTyrant::setMaster</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timestamp</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$check_consistency</code><span class="initializer"> = true</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="tokyotyrant.size.html" class="methodname">TokyoTyrant::size</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="tokyotyrant.stat.html" class="methodname">TokyoTyrant::stat</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.sync.html" class="methodname">TokyoTyrant::sync</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">TokyoTyrant</span> <span class="methodname"><a href="tokyotyrant.tune.html" class="methodname">TokyoTyrant::tune</a></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$timeout</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = TokyoTyrant::RDBT_RECON</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrant.vanish.html" class="methodname">TokyoTyrant::vanish</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="tokyotyranttable.add.html">TokyoTyrantTable::add</a> — Adds a record</li><li><a href="tokyotyranttable.genuid.html">TokyoTyrantTable::genUid</a> — Generate unique id</li><li><a href="tokyotyranttable.get.html">TokyoTyrantTable::get</a> — Get a row</li><li><a href="tokyotyranttable.getiterator.html">TokyoTyrantTable::getIterator</a> — Get an iterator</li><li><a href="tokyotyranttable.getquery.html">TokyoTyrantTable::getQuery</a> — Get a query object</li><li><a href="tokyotyranttable.out.html">TokyoTyrantTable::out</a> — Remove records</li><li><a href="tokyotyranttable.put.html">TokyoTyrantTable::put</a> — Store a row</li><li><a href="tokyotyranttable.putcat.html">TokyoTyrantTable::putCat</a> — Concatenates to a row</li><li><a href="tokyotyranttable.putkeep.html">TokyoTyrantTable::putKeep</a> — Put a new record</li><li><a href="tokyotyranttable.putnr.html">TokyoTyrantTable::putNr</a> — Puts value</li><li><a href="tokyotyranttable.putshl.html">TokyoTyrantTable::putShl</a> — Concatenates to a record</li><li><a href="tokyotyranttable.setindex.html">TokyoTyrantTable::setIndex</a> — Sets index</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrant.vanish.html">TokyoTyrant::vanish</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyranttable.add.html">TokyoTyrantTable::add</a></div>
<div class="up"><a href="book.tokyo-tyrant.html">tokyo_tyrant</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
