PHP Conference Japan 2024

odbc_foreignkeys

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

odbc_foreignkeys检索外键列表

描述

odbc_foreignkeys(
    Odbc\Connection $odbc,
    ?string $pk_catalog,
    string $pk_schema,
    string $pk_table,
    string $fk_catalog,
    string $fk_schema,
    string $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 实例;以前,期望一个 resource
8.4.0 此函数现在返回一个 Odbc\Result 实例;以前,返回一个 resource

参见

添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top