SQLForeignKeys － 获取外键列的列表

用途

SQLForeignKeys() 返回关于指定表的外键的信息。此信息在 SQL 结果集中返回，可以使用用来检索查询生成的结果集的函数来处理此结果集。忽略 PKCatalogName、NameLength1、PKSchemaName、NameLength2、FKCatalogName、NameLength4、FKSchemaName 和 NameLength5。返回的结果集的第 1、2、5、6、12 和 13 列总是长度为零的字符串。返回的结果集的第 10、11和 14 列总是零。

语法

SQLRETURN   SQLForeignKeys  (
                  SQLHSTMT          StatementHandle,  /* hstmt */
                  SQLCHAR      *FAR PKCatalogName,    /* szPkCatalogName */
                  SQLSMALLINT       NameLength1,      /* cbPkCatalogName */
                  SQLCHAR      *FAR PKSchemaName,     /* szPkSchemaName */
                  SQLSMALLINT       NameLength2,      /* cbPkSchemaName */
                  SQLCHAR      *FAR PKTableName,      /* szPkTableName */
                  SQLSMALLINT       NameLength3,      /* cbPkTableName */
                  SQLCHAR      *FAR FKCatalogName,    /* szFkCatalogName */
                  SQLSMALLINT       NameLength4       /* cbFkCatalogName */
                  SQLCHAR      *FAR FKSchemaName,     /* szFkSchemaName */
                  SQLSMALLINT       NameLength5,      /* cbFkSchemaName */
                  SQLCHAR      *FAR FKTableName,      /* szFkTableName */
                  SQLSMALLINT       NameLength6);     /* cbFkTableName */
 

函数自变量

表 58. SQLForeignKeys 自变量

用法

如果 PKTableName 包含表名，且 FKTableName 是空字符串，则 SQLForeignKeys() 返回一个结果集，此结果集包含指定表的主键以及所有引用该表的外键（在其它表中）。

如果 FKTableName 包含一个表名，而 PKTableName 是空字符串，则 SQLForeignKeys() 返回一个结果集，此结果集包含指定表中的所有外键以及它们所引用的主键 （在其它表中）。

如果 PKTableName 和 FKTableName 都包含表名，则 SQLForeignKeys() 返回在 FKTableName 中指定的表中的外键，这些外键引用在 PKTableName 中指定的表的主键。最多只应有一个键。

如果请求与主键相关联的外键，则结果集按 FKTABLE_NAME 和 ORDINAL_POSITION 排序。如果请求与外键相关联的主键，则结果集按 PKTABLE_NAME 和 ORDINAL_POSITION 排序。

用最大长度属性 128 声明目录函数结果集的 VARCHAR 列，以便与 SQL92 限制一致。

虽然可以添加新列，将来的发行版中也可以更改现有列的名称，但当前列的位置不会改变。

结果集包含以下列：

第 1 列 PKTABLE_CAT（VARCHAR(128)）

这始终是长度为零的字符串。

第 2 列 PKTABLE_SCHEM（VARCHAR(128)）

这始终是长度为零的字符串。

第 3 列 PKTABLE_NAME（VARCHAR(128) 且不为 NULL）

包含主键的表的名称。

第 4 列 PKCOLUMN_NAME（VARCHAR(128) 且不为 NULL）

主键列名。

第 5 列 FKTABLE_CAT（VARCHAR(128)）

这始终是长度为零的字符串。

第 6 列 FKTABLE_SCHEM（VARCHAR(128)）

这始终是长度为零的字符串。

第 7 列 FKTABLE_NAME（VARCHAR(128) 且不为 NULL）

包含外键的表的名称。

第 8 列 FKCOLUMN_NAME（VARCHAR(128) 且不为 NULL）

外键列名。

第 9 列 ORDINAL_POSITION（SMALLINT 且不为 NULL）

键中列的原始位置，从 1 开始。

第 10 列 UPDATE_RULE（SMALLINT）

这始终是零。

第 11 列 DELETE_RULE（SMALLINT）

这始终是零。

第 12 列 FK_NAME（VARCHAR(128)）

这始终是长度为零的字符串。

第 13 列 PK_NAME（VARCHAR(128)）

这始终是长度为零的字符串。

第 14 列 DEFERRABILITY（SMALLINT）

这始终是零。

DB2 CLI 使用的列名遵循 X/Open CLI CAE 规范样式。列类型、内容和顺序与对 ODBC 中的 SQLForeignKeys() 结果集定义的列类型、内容和顺序完全相同。

返回码

• SQL_SUCCESS
• SQL_SUCCESS_WITH_INFO
• SQL_ERROR
• SQL_INVALID_HANDLE

诊断

表 59. SQLForeign SQLSTATE

限制

无。

相关参考

• DB2 CLI 函数描述的关键
• DB2 CLI 函数摘要
• SQLPrimaryKeys － 获取表的主键列