外部キーのリストを取得する

説明

odbc_foreignkeys ( resource $connection_id , string $pk_qualifier , string $pk_owner , string $pk_table , string $fk_qualifier , string $fk_owner , string $fk_table ) : resource

指定したテーブルの外部キーのリスト、または指定したテーブルの主キーを参照する他のテーブルの外部キーのリストを取得します。

パラメータ

connection_id: ODBC 接続 ID。詳細は odbc_connect() を参照ください。
pk_qualifier: 主キーの修飾子。
pk_owner: 主キーの所有者。
pk_table: 主キーのテーブル。
fk_qualifier: 外部キーの修飾子。
fk_owner: 外部キーの所有者。
fk_table: 外部キーのテーブル。

返り値

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

結果は、以下のようなカラムを持つものとなります。

PKTABLE_QUALIFIER
PKTABLE_OWNER
PKTABLE_NAME
PKCOLUMN_NAME
FKTABLE_QUALIFIER
FKTABLE_OWNER
FKTABLE_NAME
FKCOLUMN_NAME
KEY_SEQ
UPDATE_RULE
DELETE_RULE
FK_NAME
PK_NAME

pk_table がテーブル名を有している場合、 odbc_foreignkeys() は指定したテーブルの主キーおよびそのキーを参照する全ての外部キーのリストを結果として返します。

fk_table がテーブル名を有している場合、 odbc_foreignkeys() は指定したテーブルにある全ての外部キーおよびそのキーが参照する(他のテーブルの)主キーのリストを結果として返します。

pk_table および fk_table が共にテーブル名を有している場合、 odbc_foreignkeys() は pk_table で指定されたテーブルの主キーを参照する fk_table で指定されたテーブルの外部キーを返します。返されるキーは最大でも一つだけです。