<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.odbc-tables" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>odbc_tables</refname>

<refpurpose>指定したデータソースに保存されたテーブルの名前のリストを取得する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_tables</methodname>

<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>table</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>types</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

指定した範囲の全てのテーブルリストを得ます。

</para>

<para>

限定子、所有者、テーブル名を数えるために、

<parameter>catalog</parameter>、<parameter>schema</parameter>、

<parameter>table</parameter>、<parameter>table_type</parameter>

について以下のような特別な記号が使用可能です。

<itemizedlist>

<listitem>

<simpara>

<parameter>catalog</parameter> がパーセント記号 (%) のみで、

<parameter>schema</parameter> および <parameter>table</parameter>

が空文字列であった場合、結果にはそのデータソースに関する

有効な限定子のリスト (&null; を有する TABLE_QUALIFIER カラム以外の

全てのカラム)が含まれます。

</simpara>

</listitem>

<listitem>

<simpara>

<parameter>schema</parameter> がパーセント記号 (%) のみで、

<parameter>catalog</parameter> および

<parameter>table</parameter> が空文字列の場合、結果にはその

データソースに関する有効な所有者のリスト (&null; を有する

TABLE_OWNER カラム以外の全てのカラム) が含まれます。

</simpara>

</listitem>

<listitem>

<simpara>

<parameter>table_type</parameter> がパーセント記号 (%) のみで、

<parameter>catalog</parameter>、<parameter>schema</parameter>、

<parameter>table</parameter> が空文字列の場合、結果にはそのデータソースに

関する有効なテーブル型のリスト (&null; を有する TABLE_TYPE

カラム以外の全てのカラム) が含まれます。

</simpara>

</listitem>

</itemizedlist>

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

&odbc.parameter.search;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>table</parameter></term>

<listitem>

<para>

名前。

&odbc.parameter.search;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>types</parameter></term>

<listitem>

<para>

<parameter>table_type</parameter> が空の文字列ではない場合、検索する型に

ついてカンマで区切った値のリストを指定する必要があります。

各値は、シングルクオート(<literal>'</literal>)で括るかまたは括らない形で指定可能です。

例えば、<literal>'TABLE','VIEW'</literal> または <literal>TABLE, VIEW</literal> となります。

データソースが指定したテーブル型をサポートしていない場合、

<function>odbc_tables</function> はその型についていかなる結果も

返しません。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

情報を含んでいる &odbc.result.object-return;。

&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>TABLE_TYPE</literal></simpara></listitem>

<listitem><simpara><literal>REMARKS</literal></simpara></listitem>

</itemizedlist>

&odbc.result.driver-specific;

</para>

<simpara>

結果セットは <literal>TABLE_TYPE</literal>, <literal>TABLE_CAT</literal>,

<literal>TABLE_SCHEM</literal>, <literal>TABLE_NAME</literal> でソートされます。

</simpara>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&odbc.changelog.connection-param;

&odbc.changelog.result-return;

<row>

<entry>8.0.0</entry>

<entry>

<parameter>schema</parameter>, <parameter>table</parameter>,

<parameter>types</parameter> は、nullable になりました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example xml:id="odbc-tables.example.basic">

<title>カタログのテーブル一覧を表示する</title>

<programlisting role="php">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>odbc_tableprivileges</function></member>

<member><function>odbc_columns</function></member>

<member><function>odbc_specialcolumns</function></member>

<member><function>odbc_statistics</function></member>

<member><function>odbc_procedures</function></member>

</simplelist>

</para>

</refsect1>

</refentry>