mongoexception.xml

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

<phpdoc:classref xml:id="class.mongoexception" 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>MongoException クラス</title>
 <titleabbrev>MongoException</titleabbrev>

 <partintro>

  <!-- {{{ MongoException intro -->
  <section xml:id="mongoexception.intro">
   &reftitle.intro;
   <para>
    Mongo のデフォルトの例外です。
   </para>

   <para>
    さまざまなエラー条件を扱います。最終的にはより詳細な例外にたどり着きますが、
    それらもすべて <classname>MongoException</classname> を継承しています。
   </para>

   <itemizedlist>

    <listitem>
     <para>
      <literal>The MongoSomething object has not been correctly initialized by its constructor</literal>
     </para>
     <para>
      コード: 0
     </para>
     <para>
      おそらく、Mongo オブジェクトがデータベースに接続していないものと思われます。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>zero-length keys are not allowed, did you use $ with double quotes?</literal>
     </para>
     <para>
      コード: 1
     </para>
     <para>
      キーとして "" を使おうとしました。一般的に、これはしていはいけないことです。
      "" を使うとサブオブジェクトへのアクセスが煩雑になり、またこのキーは MongoDB
      が内部的に使ってもいます。しかし、どうしても使いたい場合は、php.ini ファイルで
      <link linkend="ini.mongo.allow-empty-keys">mongo.allow_empty_keys</link>
      に true を設定すればこのチェックを回避できます。
      回避するよう設定した場合は、エラーチェックをより厳密に行って
      文字列書き込みエラーを防ぐことを推奨します。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>'.' not allowed in key: &lt;key&gt;</literal>
     </para>
     <para>
      コード: 2
     </para>
     <para>
      '.' を含むキーに書き込もうとしました。これは禁じられています。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>insert too large: &lt;size&gt;, max: &lt;max&gt;</literal>
     </para>
     <para>
      コード: 3
     </para>
     <para>
      長すぎるデータをデータベースに一度に送ろうとしました。データベースがデータの追加を受け付けるのは、
      ある特定の大きさ (現在は 16 MB) までです。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>no elements in doc</literal>
     </para>
     <para>
      コード: 4
     </para>
     <para>
      フィールドを持たないドキュメントを保存しようとしました。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>size of BSON doc is &lt;size&gt; bytes, max &lt;max&gt;MB</literal>
     </para>
     <para>
      コード: 5
     </para>
     <para>
      MongoDB で保存可能な長さを超えるドキュメントを保存しようとしました。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>no documents given</literal>
     </para>
     <para>
      コード: 6
     </para>
     <para>
      空のドキュメントの配列を一括追加しようとしました。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>MongoCollection::group takes an array, object, or MongoCode key</literal>
     </para>
     <para>
      コード: 7
     </para>
     <para>
      間違った型パラメータを <function>MongoCollection::group</function> に送信しました。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>field names must be strings</literal>
     </para>
     <para>
      コード: 8
     </para>
     <para>
      フィールドセレクタの書式は
      <literal>array("field1" =&gt; 1, "field2" =&gt; 1, ..., "fieldN" =&gt; 1)</literal>
      としなければなりません。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>invalid regex</literal>
     </para>
     <para>
      コード: 9
     </para>
     <para>
      <classname>MongoRegex</classname> に渡した正規表現が正しい形式ではありません。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>MongoDBRef::get: $ref field must be a string</literal>
     </para>
     <para>
      コード: 10
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>MongoDBRef::get: $db field must be a string</literal>
     </para>
     <para>
      コード: 11
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>non-utf8 string: &lt;str&gt;</literal>
     </para>
     <para>
      コード: 12
     </para>
     <para>
      このエラーが発生するのは、非 utf8 文字列をデータベースに送信しようとしたときです。
      データベースに送る文字列はすべて UTF8 でなければなりません。
      この例外を発生させなくする移行用オプションは、php.ini のオプションを参照ください。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>mutex error: &lt;err&gt;</literal>
     </para>
     <para>
      コード: 13
     </para>
     <para>
      マルチスレッド環境では、ドライバはリクエストとレスポンスの同期にミューテックスを使います。
      これはきわめて深刻なエラーで、スタックトレースもないかもしれません。
      めったに発生しないエラーなので、システムの情報と可能な限りの再現手順を添えてメンテナに報告しましょう。
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>index name too long: &lt;len&gt;, max &lt;max&gt; characters</literal>
     </para>
     <para>
      コード: 14
     </para>
     <para>
      128 文字を超える名前のインデックスは作れません。このエラーが発生した場合は、
      <function>MongoCollection::ensureIndex</function> の "name"
      オプションを使って短いインデックス名をつけなければなりません。
     </para>
    </listitem>

   </itemizedlist>
  </section>
  <!-- }}} -->

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

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

    <!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>MongoException</classname>
     </ooclass>
     <ooclass>
      <modifier>extends</modifier>
      <classname>Exception</classname>
     </ooclass>
    </classsynopsisinfo>
    <!-- }}} -->
    
   </classsynopsis>
   <!-- }}} -->

  </section>

 </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
-->