Files
doc-fr/reference/uodbc/functions/odbc-primarykeys.xml
T
2021-09-24 04:13:47 +01:00

150 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 902c2b77f827e8d0ecccf4f62fb90065d2f6ef79 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.odbc-primarykeys" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_primarykeys</refname>
<refpurpose>Liste les colonnes utilisées dans une clé primaire</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_primarykeys</methodname>
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter></methodparam>
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
<methodparam><type>string</type><parameter>table</parameter></methodparam>
</methodsynopsis>
<para>
Liste les colonnes utilisées dans une clé primaire de la table
<parameter>table</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>odbc</parameter></term>
<listitem>
&odbc.connection.id;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>catalog</parameter></term>
<listitem>
<para>
&odbc.parameter.catalog;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>schema</parameter></term>
<listitem>
<para>
&odbc.parameter.schema;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>table</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un identifiant de résultat ODBC&return.falseforfailure;.
</para>
<para>
Le jeu de résultat contient les colonnes suivantes :
<itemizedlist>
<listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
<listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
<listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
<listitem><simpara><literal>KEY_SEQ</literal></simpara></listitem>
<listitem><simpara><literal>PK_NAME</literal></simpara></listitem>
</itemizedlist>
&odbc.result.driver-specific;
</para>
<simpara>
Le jeu de résultat est ordonné par <literal>TABLE_CAT</literal>, <literal>TABLE_SCHEM</literal>,
<literal>TABLE_NAME</literal> et <literal>KEY_SEQ</literal>.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="odbc-primarykeys.example.basic">
<title>Lister les Clés primaire d'une Colonne</title>
<programlisting role="php">
<![CDATA[
<?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
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[TABLE_CAT] => TutorialDB
[TABLE_SCHEM] => dbo
[TABLE_NAME] => TEST
[COLUMN_NAME] => id
[KEY_SEQ] => 1
[PK_NAME] => PK__TEST__3213E83FE141F843
)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>odbc_tables</function></member>
<member><function>odbc_foreignkeys</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->