odbc_primarykeys
(PHP 4, PHP 5, PHP 7)
odbc_primarykeys — Gets the primary keys for a table
Description
odbc_primarykeys ( resource $connection_id , string $catalog , string $schema , string $table ) : resource|false
Returns a result identifier that can be used to fetch the column names that comprise the primary key for a table.
Parameters
-
connection_id -
The ODBC connection identifier, see odbc_connect() for details.
-
catalog -
The catalog ('qualifier' in ODBC 2 parlance).
-
schema -
The schema ('owner' in ODBC 2 parlance).
-
table
Return Values
Returns an ODBC result identifier or false on failure.
The result set has the following columns:
TABLE_CATTABLE_SCHEMTABLE_NAMECOLUMN_NAMEKEY_SEQPK_NAME
The result set is ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME and KEY_SEQ.
Examples
Example #1 List primary Keys of a Column
<?php
$conn = odbc_connect($dsn, $user, $pass);
$primarykeys = odbc_primarykeys($conn, 'TutorialDB', 'dbo', 'TEST');
while (($row = odbc_fetch_array($primarykeys))) {
print_r($row);
break; // further rows omitted for brevity
}
?> The above example will output something similar to:
Array
(
[TABLE_CAT] => TutorialDB
[TABLE_SCHEM] => dbo
[TABLE_NAME] => TEST
[COLUMN_NAME] => id
[KEY_SEQ] => 1
[PK_NAME] => PK__TEST__3213E83FE141F843
)
See Also
- odbc_tables() - Get the list of table names stored in a specific data source
- odbc_foreignkeys() - Retrieves a list of foreign keys
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.odbc-primarykeys.php