mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
902c2b77f8
Closes GH-286. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352189 c90b9560-bf6c-de11-be94-00142212c4b1
144 lines
4 KiB
XML
144 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.odbc-primarykeys" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>odbc_primarykeys</refname>
|
|
<refpurpose>Gets the primary keys for a table</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>
|
|
Returns a result identifier that can be used to fetch the column names
|
|
that comprise the primary key for a table.
|
|
</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>
|
|
Returns an ODBC result identifier&return.falseforfailure;.
|
|
</para>
|
|
<para>
|
|
The result set has the following columns:
|
|
<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>
|
|
The result set is ordered by <literal>TABLE_CAT</literal>, <literal>TABLE_SCHEM</literal>,
|
|
<literal>TABLE_NAME</literal> and <literal>KEY_SEQ</literal>.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example xml:id="odbc-primarykeys.example.basic">
|
|
<title>List primary Keys of a Column</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
|
|
-->
|