db2_primary_keys
PHP function
Edit on GitHub ✎
(PECL ibm_db2 >= 1.0.0)
Returns a result set listing primary keys for a table
Description
db2_primary_keys(resource $connection, string|null $qualifier, string|null $schema, string $table_name): resource
Returns a result set listing the primary keys for a table.
Parameters
connectionA valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
qualifierA qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass null or an empty string.
schemaThe schema which contains the tables. If
schemais null,db2_primary_keys()matches the schema for the current connection.table_nameThe 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. |