odbc-statistics.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 902c2b77f827e8d0ecccf4f62fb90065d2f6ef79 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.odbc-statistics" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_statistics</refname>
  <refpurpose>テーブルに関する統計情報を取得する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>resource</type><type>false</type></type><methodname>odbc_statistics</methodname>
   <methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter></methodparam>
   <methodparam><type>string</type><parameter>schema</parameter></methodparam>
   <methodparam><type>string</type><parameter>table</parameter></methodparam>
   <methodparam><type>int</type><parameter>unique</parameter></methodparam>
   <methodparam><type>int</type><parameter>accuracy</parameter></methodparam>
  </methodsynopsis>
  <para>
   テーブルおよびインデックスに関する統計情報を取得します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>odbc</parameter></term>
     <listitem>
      &odbc.connection.id;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>catalog</parameter></term>
     <listitem>
      <para>
       &odbc.parameter.catalog;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>schema</parameter></term>
     <listitem>
      <para>
       &odbc.parameter.schema;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table</parameter></term>
     <listitem>
      <para>
       テーブル名。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>unique</parameter></term>
     <listitem>
      <para>
       インデックスのタイプ。
       <constant>SQL_INDEX_UNIQUE</constant>, <constant>SQL_INDEX_ALL</constant> のいずれかを指定します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>accuracy</parameter></term>
     <listitem>
      <para>
       <constant>SQL_ENSURE</constant>, <constant>SQL_QUICK</constant> のいずれかを指定します。
       後者は、サーバーで利用できる場合に限り、<literal>CARDINALITY</literal> と
       <literal>PAGES</literal> をドライバが取得するように要求します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   ODBC 結果 ID を返します。&return.falseforfailure;。
  </para>
  <para>
   結果セットのカラムは次のようになります。
   <itemizedlist>
    <listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
    <listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
    <listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
    <listitem><simpara><literal>NON_UNIQUE</literal></simpara></listitem>
    <listitem><simpara><literal>INDEX_QUALIFIER</literal></simpara></listitem>
    <listitem><simpara><literal>INDEX_NAME</literal></simpara></listitem>
    <listitem><simpara><literal>TYPE</literal></simpara></listitem>
    <listitem><simpara><literal>ORDINAL_POSITION</literal></simpara></listitem>
    <listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
    <listitem><simpara><literal>ASC_OR_DESC</literal></simpara></listitem>
    <listitem><simpara><literal>CARDINALITY</literal></simpara></listitem>
    <listitem><simpara><literal>PAGES</literal></simpara></listitem>
    <listitem><simpara><literal>FILTER_CONDITION</literal></simpara></listitem>
   </itemizedlist>
   &odbc.result.driver-specific;
  </para>
  <simpara>
   結果セットは <literal>NON_UNIQUE</literal>, <literal>TYPE</literal>, <literal>INDEX_QUALIFIER</literal>,
   <literal>INDEX_NAME</literal>, <literal>ORDINAL_POSITION</literal> でソートされます。
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="odbc-statistics.example.basic">
   <title>テーブルの統計情報を表示する</title>
   <programlisting role="php">
<![CDATA[
<?php
$conn = odbc_connect($dsn, $user, $pass);
$statistics = odbc_statistics($conn, 'TutorialDB', 'dbo', 'TEST', SQL_INDEX_UNIQUE, SQL_QUICK);
while (($row = odbc_fetch_array($statistics))) {
    print_r($row);
    break; // further rows omitted for brevity
}
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
Array
(
    [TABLE_CAT] => TutorialDB
    [TABLE_SCHEM] => dbo
    [TABLE_NAME] => TEST
    [NON_UNIQUE] =>
    [INDEX_QUALIFIER] =>
    [INDEX_NAME] =>
    [TYPE] => 0
    [ORDINAL_POSITION] =>
    [COLUMN_NAME] =>
    [ASC_OR_DESC] =>
    [CARDINALITY] => 15
    [PAGES] => 3
    [FILTER_CONDITION] =>
)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>odbc_tables</function></member>
   </simplelist>
  </para>
 </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
-->