odbc_primarykeys

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

odbc_primarykeysListe les colonnes utilisées dans une clé primaire

Description

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

Retourne un objet résultat pouvant être utilisé pour récupérer les noms des colonnes qui composent la clé primaire d'une table.

Liste de paramètres

odbc

L'objet de connexion ODBC, voir la documentation de la fonction odbc_connect() pour plus de détails.

catalog

Le catalogue ('calificatif' dans le jargon ODBC 2).

schema

Le schéma ('propriétaire' dans le jargon ODBC 2).

table

Valeurs de retour

Renvoie un objet de résultat ODBC ou false si une erreur survient.

Le jeu de résultat contient les colonnes suivantes :

  • TABLE_CAT
  • TABLE_SCHEM
  • TABLE_NAME
  • COLUMN_NAME
  • KEY_SEQ
  • PK_NAME
Les pilotes peuvent signaler des colonnes supplémentaires.

Le jeu de résultat est ordonné par TABLE_CAT, TABLE_SCHEM, TABLE_NAME et KEY_SEQ.

Historique

Version Description
8.4.0 odbc attend désormais une instance de Odbc\Connection; auparavant, un resource était attendu.
8.4.0 Cette fonction retourne désormais une instance de Odbc\Result; auparavant, un resource était retourné.

Exemples

Exemple #1 Lister les Clés primaire d'une Colonne

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

Résultat de l'exemple ci-dessus est similaire à :

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

Voir aussi