Source

riak-0.9.2 / client_lib / php / docs / riakmapreduce / riakmapreduce.html

Full commit
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 10 Mar 2010 17:01:22 -0500">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">

<title>RiakMapReduce (Riak PHP Client API)</title>

</head>
<body id="definition" onload="parent.document.title=document.title;">

<div class="header">
<h1>RiakAPI</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../riakmapreduce/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../riakmapreduce/package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../riakmapreduce/riakmapreduce.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<div class="qualifiedName">RiakMapReduce.RiakMapReduce</div>
<div class="location">/riak.php at line 206</div>

<h1>Class RiakMapReduce</h1>

<pre class="tree"><strong>RiakMapReduce</strong><br /></pre>

<hr>

<p class="signature">public  class <strong>RiakMapReduce</strong></p>

<div class="comment" id="overview_description"><p>The RiakMapReduce object allows you to build up and run a
map/reduce operation on Riak.</p></div>

<hr>

<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#RiakMapReduce()">RiakMapReduce</a>(<a href="../riakclient/riakclient.html">RiakClient</a> client)</p><p class="description">Construct a Map/Reduce object.</p></td>
</tr>
</table>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> <a href="../riakmapreduce/riakmapreduce.html">RiakMapReduce</a></td>
<td class="description"><p class="name"><a href="#add()">add</a>(mixed arg1, mixed arg2, mixed arg3)</p><p class="description">Add inputs to a map/reduce operation. </p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#link()">link</a>(string bucket, string tag, boolean keep)</p><p class="description">Add a link phase to the map/reduce operation.</p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#map()">map</a>(mixed function, array() options)</p><p class="description">Add a map phase to the map/reduce operation.</p></td>
</tr>
<tr>
<td class="type"> $this</td>
<td class="description"><p class="name"><a href="#reduce()">reduce</a>(mixed function, array() options)</p><p class="description">Add a reduce phase to the map/reduce operation.</p></td>
</tr>
<tr>
<td class="type"> array()</td>
<td class="description"><p class="name"><a href="#run()">run</a>(integer timeout)</p><p class="description">Run the map/reduce operation. </p></td>
</tr>
</table>

<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/riak.php at line 213</div>
<h3 id="RiakMapReduce()">RiakMapReduce</h3>
<code class="signature">public <strong>RiakMapReduce</strong>(<a href="../riakclient/riakclient.html">RiakClient</a> client)</code>
<div class="details">
<p>Construct a Map/Reduce object.</p><dl>
<dt>Parameters:</dt>
<dd>client - - A RiakClient object.</dd>
</dl>
</div>

<hr>

<h2 id="detail_method">Method Detail</h2>
<div class="location">/riak.php at line 230</div>
<h3 id="add()">add</h3>
<code class="signature">public  <a href="../riakmapreduce/riakmapreduce.html">RiakMapReduce</a> <strong>add</strong>(mixed arg1, mixed arg2, mixed arg3)</code>
<div class="details">
<p>Add inputs to a map/reduce operation. This method takes three
different forms, depending on the provided inputs. You can
specify either  a RiakObject, a string bucket name, or a bucket,
key, and additional arg.</p><dl>
<dt>Parameters:</dt>
<dd>arg1 - - RiakObject or Bucket</dd>
<dd>arg2 - - Key or blank</dd>
<dd>arg3 - - Arg or blank</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 277</div>
<h3 id="link()">link</h3>
<code class="signature">public  $this <strong>link</strong>(string bucket, string tag, boolean keep)</code>
<div class="details">
<p>Add a link phase to the map/reduce operation.</p><dl>
<dt>Parameters:</dt>
<dd>bucket - - Bucket name (default '_', which means all buckets)</dd>
<dd>tag - - Tag (default '_', which means all buckets)</dd>
<dd>keep - - Flag whether to keep results from this stage in the map/reduce. (default FALSE, unless this is the last step in the phase)</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 292</div>
<h3 id="map()">map</h3>
<code class="signature">public  $this <strong>map</strong>(mixed function, array() options)</code>
<div class="details">
<p>Add a map phase to the map/reduce operation.</p><dl>
<dt>Parameters:</dt>
<dd>function - - Either a named Javascript function (ie: "Riak.mapValues"), or an anonymous javascript function (ie: "function(...) { ... }" or an array ["erlang_module", "function"].</dd>
<dd>options - - An optional associative array containing "language", "keep" flag, and/or "arg".</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 312</div>
<h3 id="reduce()">reduce</h3>
<code class="signature">public  $this <strong>reduce</strong>(mixed function, array() options)</code>
<div class="details">
<p>Add a reduce phase to the map/reduce operation.</p><dl>
<dt>Parameters:</dt>
<dd>function - - Either a named Javascript function (ie: "Riak.mapValues"), or an anonymous javascript function (ie: "function(...) { ... }" or an array ["erlang_module", "function"].</dd>
<dd>options - - An optional associative array containing "language", "keep" flag, and/or "arg".</dd>
</dl>
</div>

<hr>

<div class="location">/riak.php at line 328</div>
<h3 id="run()">run</h3>
<code class="signature">public  array() <strong>run</strong>(integer timeout)</code>
<div class="details">
<p>Run the map/reduce operation. Returns an array of results, or an
array of RiakLink objects if the last phase is a link phase.</p><dl>
<dt>Parameters:</dt>
<dd>timeout - - Timeout in seconds.</dd>
</dl>
</div>

<hr>

<div class="header">
<h1>RiakAPI</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../riakmapreduce/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../riakmapreduce/package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../riakmapreduce/riakmapreduce.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>