mongomaxkey.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c613a7e2f1f795b1fb741e4bda1a40e441c49f7a Maintainer: takagi Status: ready -->

<phpdoc:classref xml:id="class.mongomaxkey" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>MongoMaxKey クラス</title>
 <titleabbrev>MongoMaxKey</titleabbrev>

 <partintro>

  <warning>
   &mongo.alternative.class.note;
   <simplelist role="alternatives">
    <member><classname>MongoDB\BSON\MaxKey</classname></member>
   </simplelist>
  </warning>

<!-- {{{ MongoBinData intro -->
  <section xml:id="mongomaxkey.intro">
   &reftitle.intro;
   <para>
    <classname>MongoMaxKey</classname> はデータベースが使う特別な型で、
    他のどんな BSON 型よりも大きいと評価されます。したがって、
    特定のフィールドの昇順でクエリを並べ替えると、値が
    <classname>MongoMaxKey</classname> であるドキュメントが最後となります。
   </para>
   <para>
    <classname>MongoMaxKey</classname> にはフィールドやメソッド、定数はありません。
    データベースに追加するときに使う、単なる "いちばん大きい" 値です。
   </para>
   <note>
    <simpara>
     <classname>MongoMaxKey</classname> は、インデックス作成やシャーディングのために、MongoDB が内部的に利用するものです。
     一般に、アプリケーション内でこのクラスを使う理由はありません。
    </simpara>
   </note>
  </section>
<!-- }}} -->

  <section xml:id="mongomaxkey.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>MongoMaxKey</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>MongoMaxKey</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
   </classsynopsis>
<!-- }}} -->

  </section>

  <section xml:id="mongomaxkey.example">
   <title><classname>MongoMaxKey</classname> の使用例</title>
   <programlisting role="php">
<![CDATA[
<?php

$collection->insert(array("task" => "dishes", "doBy" => new MongoMaxKey));
$collection->insert(array("task" => "staff meeting", "doBy" => new MongoDate(strtotime("+4 days"))));

$cursor = $collection->find()->sort(array("doBy" => 1));

?>
]]>
   </programlisting>
   <para>
    このカーソルの中身は、まずstaff meetingドキュメント、次にdishesドキュメントとなります。
    dishesドキュメントは、今後コレクションに何が追加されたとしても必ず最後になります
    ("doBy" フィールドが
    <classname>MongoMaxKey</classname> である別のドキュメントが追加されない限りは)。
   </para>
  </section>

  <simplesect role="seealso">
   &reftitle.seealso;
   <simplelist>
    <member><classname>MongoMinKey</classname></member>
   </simplelist>
  </simplesect>
 </partintro>

</phpdoc:classref>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->