Home/ Manual/ uodbc / functions/ odbc_primarykeys

odbc_primarykeys

PHP function Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Gets the primary keys for a table

Description

odbc_primarykeys(Odbc\Connection $odbc, string|null $catalog, string $schema, string $table): Odbc\Result|false

Returns a result object that can be used to fetch the column names that comprise the primary key for a table.

Parameters

odbc: Id
catalog: Catalog
schema: Schema
table

Return Values

Object-return-falseforfailure

The result set has the following columns:

TABLE_CAT
TABLE_SCHEM
TABLE_NAME
COLUMN_NAME
KEY_SEQ
PK_NAME

Driver-specific

The result set is ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME and KEY_SEQ.

Changelog

Version	Description

Examples

List primary Keys of a Column

php

<?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:

output

Array
(
    [TABLE_CAT] => TutorialDB
    [TABLE_SCHEM] => dbo
    [TABLE_NAME] => TEST
    [COLUMN_NAME] => id
    [KEY_SEQ] => 1
    [PK_NAME] => PK__TEST__3213E83FE141F843
)