mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
94901ac701
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@190589 c90b9560-bf6c-de11-be94-00142212c4b1
279 lines
7.8 KiB
XML
279 lines
7.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
|
<refentry id="function.db2-special-columns">
|
|
<refnamediv>
|
|
<refname>db2_special_columns</refname>
|
|
<refpurpose>
|
|
Returns a result set listing the unique row identifier columns for a table
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>db2_special_columns</methodname>
|
|
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>qualifier</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>scope</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
Returns a result set listing the unique row identifier columns for a table.
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>qualifier</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A qualifier for DB2 databases running on OS/390 or z/OS servers. For
|
|
other databases, pass &null; or an empty string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>schema</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The schema which contains the tables.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>table_name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The name of the table.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>scope</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Integer value representing the minimum duration for which the
|
|
unique row identifier is valid. This can be one of the following
|
|
values:
|
|
<informaltable>
|
|
<tgroup cols="3">
|
|
<thead>
|
|
<row>
|
|
<entry>Integer value</entry>
|
|
<entry>SQL constant</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>0</entry>
|
|
<entry>SQL_SCOPE_CURROW</entry>
|
|
<entry>Row identifier is valid only while the cursor is positioned
|
|
on the row.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>1</entry>
|
|
<entry>SQL_SCOPE_TRANSACTION</entry>
|
|
<entry>Row identifier is valid for the duration of the
|
|
transaction.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>2</entry>
|
|
<entry>SQL_SCOPE_SESSION</entry>
|
|
<entry>Row identifier is valid for the duration of the
|
|
connection.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a statement resource with a result set containing rows with unique
|
|
row identifier information for a table. The rows are composed of the
|
|
following columns:
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Column name</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>SCOPE</entry>
|
|
<entry>
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="3">
|
|
<thead>
|
|
<row>
|
|
<entry>Integer value</entry>
|
|
<entry>SQL constant</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>0</entry>
|
|
<entry>SQL_SCOPE_CURROW</entry>
|
|
<entry>Row identifier is valid only while the cursor is positioned
|
|
on the row.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>1</entry>
|
|
<entry>SQL_SCOPE_TRANSACTION</entry>
|
|
<entry>Row identifier is valid for the duration of the
|
|
transaction.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>2</entry>
|
|
<entry>SQL_SCOPE_SESSION</entry>
|
|
<entry>Row identifier is valid for the duration of the
|
|
connection.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>COLUMN_NAME</entry>
|
|
<entry>Name of the unique column.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>DATA_TYPE</entry>
|
|
<entry>SQL data type for the column.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>TYPE_NAME</entry>
|
|
<entry>Character string representation of the SQL data type for the
|
|
column.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>COLUMN_SIZE</entry>
|
|
<entry>An integer value representing the size of the column.</entry>
|
|
</row>
|
|
<row>
|
|
<entry>BUFFER_LENGTH</entry>
|
|
<entry>
|
|
Maximum number of bytes necessary to store data from this column.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>DECIMAL_DIGITS</entry>
|
|
<entry>
|
|
The scale of the column, or &null; where scale is not applicable.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>NUM_PREC_RADIX</entry>
|
|
<entry>
|
|
An integer value of either <literal>10</literal> (representing
|
|
an exact numeric data type), <literal>2</literal> (representing an
|
|
approximate numeric data type), or &null; (representing a data type for
|
|
which radix is not applicable).
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>PSEUDO_COLUMN</entry>
|
|
<entry>Always returns 1.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<!-- Use when examples exist
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>db2_special_columns</function> example</title>
|
|
<para>
|
|
Any text that describes the purpose of the example, or
|
|
what goes on in the example should go here (inside the
|
|
<example> tag, not out
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
if ($anexample === true) {
|
|
echo 'Use the PEAR Coding Standards';
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Use the PEAR Coding Standards
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>db2_column_privileges</function></member>
|
|
<member><function>db2_columns</function></member>
|
|
<member><function>db2_foreign_keys</function></member>
|
|
<member><function>db2_primary_keys</function></member>
|
|
<member><function>db2_procedure_columns</function></member>
|
|
<member><function>db2_procedures</function></member>
|
|
<member><function>db2_statistics</function></member>
|
|
<member><function>db2_table_privileges</function></member>
|
|
<member><function>db2_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:"../../../../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
|
|
-->
|