odbc_tables

(PHP 4, PHP 5, PHP 7)

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

説明

odbc_tables ( resource $connection_id [, string $qualifier [, string $owner [, string $name [, string $types ]]]] ) : resource

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

限定子、所有者、テーブル名を数えるために、 qualifier、owner、 name、table_type について以下のような特別な記号が使用可能です。

  • qualifier がパーセント記号 (%) のみで、 owner および name が空文字列であった場合、結果にはそのデータソースに関する 有効な限定子のリスト (NULL を有する TABLE_QUALIFIER カラム以外の 全てのカラム)が含まれます。
  • owner がパーセント記号 (%) のみで、 qualifier および name が空文字列の場合、結果にはその データソースに関する有効な所有者のリスト (NULL を有する TABLE_OWNER カラム以外の全てのカラム) が含まれます。
  • table_type がパーセント記号 (%) のみで、 qualifier、owner、 name が空文字列の場合、結果にはそのデータソースに 関する有効なテーブル型のリスト (NULL を有する TABLE_TYPE カラム以外の全てのカラム) が含まれます。

パラメータ

connection_id

ODBC 接続 ID。詳細は odbc_connect() を参照ください。

qualifier

修飾子。

owner

所有者。 検索パターン (ゼロ以上の文字にマッチする '%' や単一の文字にマッチする '_') を指定可能です。

name

名前。 検索パターン (ゼロ以上の文字にマッチする '%' や単一の文字にマッチする '_') を指定可能です。

types

table_type が空の文字列ではない場合、検索する型に ついてカンマで区切った値のリストを指定する必要があります。 各値は、シングルクオート(')で括るかまたは括らない形で指定可能です。 例えば、"'TABLE','VIEW'" または "TABLE, VIEW" となります。データソースが が指定したテーブル型をサポートしていない場合、 odbc_tables() はその型についていかなる結果も 返しません。

返り値

情報を含んでいる ODBC 結果 ID を返します。 失敗した場合に FALSE を返します。

結果セットのカラムは次のようになります。

  • TABLE_QUALIFIER
  • TABLE_OWNER
  • TABLE_NAME
  • TABLE_TYPE
  • REMARKS

結果セットは TABLE_TYPE、TABLE_QUALIFIER、TABLE_OWNER、TABLE_NAME の順番になります。

参考