PHP Conference Japan 2024

odbc_foreignkeys

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

odbc_foreignkeys擷取外鍵清單

說明

odbc_foreignkeys(
    Odbc\Connection $odbc,
    ?字串 $pk_catalog,
    字串 $pk_schema,
    字串 $pk_table,
    字串 $fk_catalog,
    字串 $fk_schema,
    字串 $fk_table
): Odbc\Result|false

擷取指定資料表中的外鍵列表,或擷取其他資料表中參考指定資料表主鍵的外鍵列表。

參數

odbc

ODBC 連線物件,詳情請參閱 odbc_connect()

pk_catalog

主鍵資料表的目錄(在 ODBC 2 術語中稱為「限定詞」)。

pk_schema

主鍵資料表的綱要(在 ODBC 2 術語中稱為「擁有者」)。

pk_table

主鍵資料表。

fk_catalog

外鍵資料表的目錄(在 ODBC 2 術語中稱為「限定詞」)。

fk_schema

外鍵資料表的綱要(在 ODBC 2 術語中稱為「擁有者」)。

fk_table

外鍵資料表。

傳回值

傳回 ODBC 結果物件,失敗時傳回 false

結果集包含以下欄位

  • PKTABLE_CAT
  • PKTABLE_SCHEM
  • PKTABLE_NAME
  • PKCOLUMN_NAME
  • FKTABLE_CAT
  • FKTABLE_SCHEM
  • FKTABLE_NAME
  • FKCOLUMN_NAME
  • KEY_SEQ
  • UPDATE_RULE
  • DELETE_RULE
  • FK_NAME
  • PK_NAME
  • DEFERRABILITY
驅動程式可能會回報額外的欄位。

如果請求與主鍵關聯的外鍵,結果集會依 FKTABLE_CATFKTABLE_SCHEMFKTABLE_NAMEKEY_SEQ 排序。如果請求與外鍵關聯的主鍵,結果集會依 PKTABLE_CATPKTABLE_SCHEMPKTABLE_NAMEKEY_SEQ 排序。

如果 pk_table 包含資料表名稱,odbc_foreignkeys() 會傳回一個結果集,其中包含指定資料表的主鍵以及所有參考它的外鍵。

如果 fk_table 包含資料表名稱,odbc_foreignkeys() 會傳回一個結果集,其中包含指定資料表中的所有外鍵以及它們參考的主鍵(在其他資料表中)。

如果 pk_tablefk_table 都包含資料表名稱,odbc_foreignkeys() 會傳回 fk_table 中指定的資料表中參考 pk_table 中指定的資料表主鍵的外鍵。這最多應該只有一個鍵。

更新日誌

版本 說明
8.4.0 odbc 現在需要 Odbc\Connection 實例;先前需要的是 資源
8.4.0 此函式現在傳回 Odbc\Result 實例;先前傳回的是 資源

參見

新增筆記

使用者貢獻的筆記

此頁面沒有使用者貢獻的筆記。
To Top