mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
902c2b77f8
Closes GH-286. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352189 c90b9560-bf6c-de11-be94-00142212c4b1
155 lines
4.9 KiB
XML
155 lines
4.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.odbc-specialcolumns" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>odbc_specialcolumns</refname>
|
|
<refpurpose>Retrieves special columns</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_specialcolumns</methodname>
|
|
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>type</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>
|
|
<methodparam><type>int</type><parameter>scope</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>nullable</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retrieves either the optimal set of columns that uniquely identifies a
|
|
row in the table, or columns that are automatically updated when any
|
|
value in the row is updated by a transaction.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>odbc</parameter></term>
|
|
<listitem>
|
|
&odbc.connection.id;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>type</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
When the type argument is <constant>SQL_BEST_ROWID</constant>,
|
|
<function>odbc_specialcolumns</function> returns the
|
|
column or columns that uniquely identify each row in the table.
|
|
</simpara>
|
|
<simpara>
|
|
When the type argument is <constant>SQL_ROWVER</constant>,
|
|
<function>odbc_specialcolumns</function> returns the column or columns in the
|
|
specified table, if any, that are automatically updated by the data source
|
|
when any value in the row is updated by any transaction.
|
|
</simpara>
|
|
</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>
|
|
The table.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>scope</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The scope, which orders the result set.
|
|
One of <constant>SQL_SCOPE_CURROW</constant>, <constant>SQL_SCOPE_TRANSACTION</constant>
|
|
or <constant>SQL_SCOPE_SESSION</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>nullable</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Determines whether to return special columns that can have a NULL value.
|
|
One of <constant>SQL_NO_NULLS</constant> or <constant>SQL_NULLABLE </constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an ODBC result identifier or &false; on
|
|
failure.
|
|
</para>
|
|
<para>
|
|
The result set has the following columns:
|
|
<itemizedlist>
|
|
<listitem><simpara><literal>SCOPE</literal></simpara></listitem>
|
|
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
|
|
<listitem><simpara><literal>DATA_TYPE</literal></simpara></listitem>
|
|
<listitem><simpara><literal>TYPE_NAME</literal></simpara></listitem>
|
|
<listitem><simpara><literal>COLUMN_SIZE</literal></simpara></listitem>
|
|
<listitem><simpara><literal>BUFFER_LENGTH</literal></simpara></listitem>
|
|
<listitem><simpara><literal>DECIMAL_DIGITS</literal></simpara></listitem>
|
|
<listitem><simpara><literal>PSEUDO_COLUMN</literal></simpara></listitem>
|
|
</itemizedlist>
|
|
&odbc.result.driver-specific;
|
|
</para>
|
|
<simpara>
|
|
The result set is ordered by <literal>SCOPE</literal>.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>odbc_tables</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
|
|
-->
|