array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.db2-foreign-keys.php', 1 => 'db2_foreign_keys', ), 'up' => array ( 0 => 'ref.ibm-db2.php', 1 => 'IBM DB2 Funções', ), 'prev' => array ( 0 => 'function.db2-field-width.php', 1 => 'db2_field_width', ), 'next' => array ( 0 => 'function.db2-free-result.php', 1 => 'db2_free_result', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/ibm_db2/functions/db2-foreign-keys.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PECL ibm_db2 >= 1.0.0)
db2_foreign_keys — Returns a result set listing the foreign keys for a table
$connection
,$qualifier
,$schema
,$table_name
Returns a result set listing the foreign keys for a table.
connection
A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
qualifier
A qualifier for DB2 databases running on OS/390 or z/OS servers. For
other databases, pass null
or an empty string.
schema
The schema which contains the tables. If schema
is null
, db2_foreign_keys() matches the schema for
the current connection.
table_name
The name of the table.
Returns a statement resource with a result set containing rows describing the foreign keys for the specified table. The result set is composed of the following columns:
Column name | Description |
---|---|
PKTABLE_CAT | Name of the catalog for the table containing the primary key. The value is NULL if this table does not have catalogs. |
PKTABLE_SCHEM | Name of the schema for the table containing the primary key. |
PKTABLE_NAME | Name of the table containing the primary key. |
PKCOLUMN_NAME | Name of the column containing the primary key. |
FKTABLE_CAT | Name of the catalog for the table containing the foreign key. The value is NULL if this table does not have catalogs. |
FKTABLE_SCHEM | Name of the schema for the table containing the foreign key. |
FKTABLE_NAME | Name of the table containing the foreign key. |
FKCOLUMN_NAME | Name of the column containing the foreign key. |
KEY_SEQ | 1-indexed position of the column in the key. |
UPDATE_RULE | Integer value representing the action applied to the foreign key when the SQL operation is UPDATE. |
DELETE_RULE | Integer value representing the action applied to the foreign key when the SQL operation is DELETE. |
FK_NAME | The name of the foreign key. |
PK_NAME | The name of the primary key. |
DEFERRABILITY | An integer value representing whether the foreign key deferrability is SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE, or SQL_NOT_DEFERRABLE. |