odbc_specialcolumns

(PHP 4, PHP 5, PHP 7, PHP 8)

odbc_specialcolumns特殊カラムを取得する

説明

odbc_specialcolumns(
    resource $odbc,
    int $type,
    ?string $catalog,
    string $schema,
    string $table,
    int $scope,
    int $nullable
): resource|false

テーブルのレコードを特定する最適なカラムの組合せ、 またはレコードの値がトランザクションにより更新される際に自動的に更新されるカラムを取得します。

パラメータ

odbc

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

type
引数 type が SQL_BEST_ROWID の場合、 odbc_specialcolumns() はテーブルの各レコードを特定するカラムを返します。 引数 type が SQL_ROWVER の場合、 odbc_specialcolumns() はカラムから値を取得する ことにより指定したテーブルでレコードを特定できる最適なカラムまたはカラムの組を返します。
catalog

カタログ(ODBC 2 の用語では '修飾子')。

schema

スキーマ (ODBC 2 の用語では '所有者')。

table

テーブル。

scope

スコープ。これは結果セットを並べかえる際に使用します。 SQL_SCOPE_CURROW, SQL_SCOPE_TRANSACTION, SQL_SCOPE_SESSION のいずれかを指定します。

nullable

NULL を持つ特別なカラムを返却するかどうかを指定します。 SQL_NO_NULLS, SQL_NULLABLE のいずれかを指定します。

戻り値

ODBC 結果 ID または失敗した場合に false を返します。

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

  • SCOPE
  • COLUMN_NAME
  • DATA_TYPE
  • TYPE_NAME
  • COLUMN_SIZE
  • BUFFER_LENGTH
  • DECIMAL_DIGITS
  • PSEUDO_COLUMN
ドライバは追加のカラムを返すことが出来ます。

結果セットは SCOPE でソートされます。

参考

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

関連キーワード:  カラム, 取得, specialcolumns, テーブル, type, レコード, 特定, セット, int, string