db2_primary_keys

(PECL ibm_db2:1.0-1.6.2)

db2_primary_keys — Returns a result set listing primary keys for a table

Description

resource db2_primary_keys ( resource $connection , string $qualifier , string $schema , string $table-name )

Returns a result set listing the primary keys for a table.

Parameters

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_primary_keys() matches the schema for the current connection.

table-name

The name of the table.

Return Values

Returns a statement resource with a result set containing rows describing the primary keys for the specified table. The result set is composed of the following columns:

Column name	Description
TABLE_CAT	Name of the catalog for the table containing the primary key. The value is NULL if this table does not have catalogs.
TABLE_SCHEM	Name of the schema for the table containing the primary key.
TABLE_NAME	Name of the table containing the primary key.
COLUMN_NAME	Name of the column containing the primary key.
KEY_SEQ	1-indexed position of the column in the key.
PK_NAME	The name of the primary key.

See Also

• db2_column_privileges()
• db2_columns()
• db2_foreign_keys()
• db2_procedure_columns()
• db2_procedures()
• db2_special_columns()
• db2_statistics()
• db2_table_privileges()
• db2_tables()