<!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>Retrieve a list of distinct values for the given key across a collection.</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongocollection.deleteindexes.html">MongoCollection::deleteIndexes</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongocollection.drop.html">MongoCollection::drop</a></div> <div class="up"><a href="class.mongocollection.html">MongoCollection</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongocollection.distinct" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoCollection::distinct</h1> <p class="verinfo">(PECL mongo >=1.2.11)</p><p class="refpurpose"><span class="refname">MongoCollection::distinct</span> — <span class="dc-title">Retrieve a list of distinct values for the given key across a collection.</span></p> </div> <div class="refsect1 description" id="refsect1-mongocollection.distinct-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>MongoCollection::distinct</strong></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">$query</code></span> ] )</div> <p class="para rdfs-comment"> The distinct command returns a list of distinct values for the given key across a collection. </p> </div> <div class="refsect1 parameters" id="refsect1-mongocollection.distinct-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"><em><code class="parameter">key</code></em></span> <dd> <p class="para"> The key to use. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">query</code></em></span> <dd> <p class="para"> An optional query parameters </p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-mongocollection.distinct-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns an array of distinct values, or <strong><code>FALSE</code></strong> on failure </p> </div> <div class="refsect1 examples" id="refsect1-mongocollection.distinct-examples"> <h3 class="title">Examples</h3> <div class="example" id="mongocollection.distinct.basic"> <p><strong>Example #1 <span class="methodname"><strong>MongoCollection::distinct()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$m </span><span style="color: #007700">= new </span><span style="color: #0000BB">Mongo</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">selectDB</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">dropCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"distinct"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$c </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">distinct</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"stuff" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"bar"</span><span style="color: #007700">, </span><span style="color: #DD0000">"zip-code" </span><span style="color: #007700">=> </span><span style="color: #0000BB">10010</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"stuff" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"foo"</span><span style="color: #007700">, </span><span style="color: #DD0000">"zip-code" </span><span style="color: #007700">=> </span><span style="color: #0000BB">10010</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"stuff" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"bar"</span><span style="color: #007700">, </span><span style="color: #DD0000">"zip-code" </span><span style="color: #007700">=> </span><span style="color: #0000BB">99701</span><span style="color: #007700">), array(</span><span style="color: #DD0000">"w" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">distinct</span><span style="color: #007700">(</span><span style="color: #DD0000">"zip-code"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">distinct</span><span style="color: #007700">(</span><span style="color: #DD0000">"zip-code"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"stuff" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"foo"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">distinct</span><span style="color: #007700">(</span><span style="color: #DD0000">"zip-code"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"stuff" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"bar"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">);<br /><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) { [0]=> int(10010) [1]=> int(99701) } array(1) { [0]=> int(10010) } array(2) { [0]=> int(10010) [1]=> int(99701) } </pre></div> </div> </div> <div class="example" id="mongocollection.distinct.basic-embedded"> <p><strong>Example #2 <span class="methodname"><strong>MongoCollection::distinct()</strong></span> example on a embedded document</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$c</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"user" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"points" </span><span style="color: #007700">=> </span><span style="color: #0000BB">25</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"user" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"points" </span><span style="color: #007700">=> </span><span style="color: #0000BB">31</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"user" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"points" </span><span style="color: #007700">=> </span><span style="color: #0000BB">25</span><span style="color: #007700">)));<br /><br /></span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">distinct</span><span style="color: #007700">(</span><span style="color: #DD0000">"user.points"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">$c</span><span style="color: #007700">-></span><span style="color: #0000BB">distinct</span><span style="color: #007700">(</span><span style="color: #DD0000">"user.nonexisting"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retval</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) { [0]=> int(25) [1]=> int(31) } array(0) { } </pre></div> </div> </div> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongocollection.deleteindexes.html">MongoCollection::deleteIndexes</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongocollection.drop.html">MongoCollection::drop</a></div> <div class="up"><a href="class.mongocollection.html">MongoCollection</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>