createindex.xml

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

<refentry xml:id="mysql-xdevapi-collection.createindex" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Collection::createIndex</refname>
  <refpurpose>コレクションにインデックスを作成</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>void</type><methodname>mysql_xdevapi\Collection::createIndex</methodname>
   <methodparam><type>string</type><parameter>index_name</parameter></methodparam>
   <methodparam><type>string</type><parameter>index_desc_json</parameter></methodparam>
  </methodsynopsis>
  <para>
    コレクションにインデックスを作成します。
  </para>
  <para>
    指定された名前と同じインデックスが既に存在していた場合、
    もしくはインデックスの定義が正しくなかった場合は、
    例外がスローされます。
   </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>index_name</parameter></term>
    <listitem>
     <para>
      作成するインデックスの名前。
      この名前は、 <literal>CREATE INDEX</literal> SQLクエリが受け入れられる、
      正しいものでなければなりません。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>index_desc_json</parameter></term>
    <listitem>
     <para>
      作成するインデックスの定義。
      IndexField オブジェクトの配列を含み、
      個々のオブジェクトはインデックスに含まれる単一のドキュメントを記述します。
      そして、オプションで、インデックスのタイプを示すオプションの文字列を含めます。
      インデックスのタイプは、INDEX(デフォルト) または SPATIAL です。
     </para>
     <para>
      IndexField の記述は、以下のフィールドを含みます:
     </para>
     <itemizedlist>
      <listitem>
        <para>
          <code>field</code>: 文字列。インデックスされるドキュメンメンバまたはフィールドの完全なパス
        </para>
      </listitem>
      <listitem>
       <para>
        <code>type</code>: 文字列。フィールドにマップされる、サポートされたSQLカラムの型のうちひとつ。
        数値型のために、オプションで UNSIGNED を後ろに続けることができます。
        テキスト型のために、インデックスのために考慮する長さを追加できます。
       </para>
      </listitem>
      <listitem>
        <para>
          <code>required</code>: bool。 (オプション) フィールドがドキュメントで必須である場合、trueを指定します。
          デフォルトは &false; です。
          <literal>GEOJSON</literal> では例外的に、デフォルトが &true; です。
         </para>
       </listitem>
      <listitem>
        <para>
          <code>options</code>: integer, (オプション)
          <literal>GEOJSON</literal> データをデコードする時に使う特別なのオプションフラグ
        </para>
      </listitem>
      <listitem>
        <para>
          <code>srid</code>: integer, (オプション)
          <literal>GEOJSON</literal> データをデコードする時に使う srid の値
        </para>
      </listitem>
      </itemizedlist>

      <para>
        IndexDefinition や IndexField に、上記で説明していないフィールドを含めるとエラーになります。
      </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para></para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>mysql_xdevapi\Collection::createIndex</function> の例</title>
   <programlisting role="php">
<![CDATA[
<?php
$session = mysql_xdevapi\getSession("mysqlx://user:password@localhost");
$session->sql("DROP DATABASE IF EXISTS addressbook")->execute();
$session->sql("CREATE DATABASE addressbook")->execute();

$schema     = $session->getSchema("addressbook");
$collection = $schema->createCollection("people");

// text index を作る
$collection->createIndex(
  'myindex1', 
  '{"fields": [{
    "field": "$.name", 
    "type": "TEXT(25)", 
    "required": true}], 
    "unique": false}'
);

// spatial インデックスを作る
$collection->createIndex(
  'myindex2', 
  '{"fields": [{
    "field": "$.home", 
    "type": "GEOJSON", 
    "required": true}], 
    "type": "SPATIAL"}'
);

// 複数のフィルードを持つインデックス
$collection->createIndex(
  'myindex3', 
  '{"fields": [
    {
      "field": "$.name",
      "type": "TEXT(20)",
      "required": true
    },
    {
      "field": "$.age",
      "type": "INTEGER"
    },
    {
      "field": "$.job",
      "type": "TEXT(30)",
      "required": false
    }
  ],
  "unique": true
  }'
);
]]>
   </programlisting>
  </example>
 </refsect1>

</refentry>

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