<!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>Searches records</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrantquery.rewind.html">TokyoTyrantQuery::rewind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrantquery.setlimit.html">TokyoTyrantQuery::setLimit</a></div>
<div class="up"><a href="class.tokyotyrantquery.html">TokyoTyrantQuery</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="tokyotyrantquery.search" class="refentry">
<div class="refnamediv">
<h1 class="refname">TokyoTyrantQuery::search</h1>
<p class="verinfo">(PECL tokyo_tyrant >= 0.1.0)</p><p class="refpurpose"><span class="refname">TokyoTyrantQuery::search</span> — <span class="dc-title">Searches records</span></p>
</div>
<div class="refsect1 description" id="refsect1-tokyotyrantquery.search-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>TokyoTyrantQuery::search</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Executes a search on the table database. Returns an array of arrays containing the matching records.
In the returned array the first level is the primary key of the data and the second level is the row data.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tokyotyrantquery.search-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tokyotyrantquery.search-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the matching rows and throws TokyoTyrantException on error
</p>
</div>
<div class="refsect1 examples" id="refsect1-tokyotyrantquery.search-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2240">
<p><strong>Example #1 <span class="methodname"><strong>TokyoTyrantQuery::search()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Connect to a table database */<br /></span><span style="color: #0000BB">$tt </span><span style="color: #007700">= new </span><span style="color: #0000BB">TokyoTyrantTable</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #0000BB">1979</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Add rows */<br /></span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"column1" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"some data"</span><span style="color: #007700">, </span><span style="color: #DD0000">"column2" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"something here"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"column1" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"more data"</span><span style="color: #007700">, </span><span style="color: #DD0000">"column2" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"best data this far"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"column1" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"again data"</span><span style="color: #007700">, </span><span style="color: #DD0000">"column3" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"not here"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"column45" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"random data"</span><span style="color: #007700">, </span><span style="color: #DD0000">"column2" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"something along the lines"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"column21" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"test data"</span><span style="color: #007700">, </span><span style="color: #DD0000">"column2" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"generating.."</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"column1" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"foobar data"</span><span style="color: #007700">, </span><span style="color: #DD0000">"column2" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"value here"</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">/* Get a new query object */<br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">getQuery</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* Add a search condition */<br /></span><span style="color: #0000BB">$query</span><span style="color: #007700">-></span><span style="color: #0000BB">addCond</span><span style="color: #007700">(</span><span style="color: #DD0000">"column2"</span><span style="color: #007700">, </span><span style="color: #0000BB">TokyoTyrant</span><span style="color: #007700">::</span><span style="color: #0000BB">RDBQC_STROR</span><span style="color: #007700">, </span><span style="color: #DD0000">"something"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Dump the search results */<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">-></span><span style="color: #0000BB">search</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
[1]=>
array(2) {
["column1"]=>
string(9) "some data"
["column2"]=>
string(14) "something here"
}
[4]=>
array(2) {
["column45"]=>
string(11) "random data"
["column2"]=>
string(25) "something along the lines"
}
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-tokyotyrantquery.search-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="tokyotyrantquery.out.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrantQuery::out()</a> - Removes records based on query</span></li>
<li class="member"> <span class="methodname"><a href="tokyotyrantquery.metasearch.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrantQuery::metaSearch()</a> - Retrieve records with multiple queries</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrantquery.rewind.html">TokyoTyrantQuery::rewind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrantquery.setlimit.html">TokyoTyrantQuery::setLimit</a></div>
<div class="up"><a href="class.tokyotyrantquery.html">TokyoTyrantQuery</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
