db2-columns.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.db2-columns" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_columns</refname>
  <refpurpose>
   Возвращает результирующий набор, перечисляющий столбцы и связанные с ними метаданные для таблицы
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>db2_columns</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>qualifier</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>table_name</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>column_name</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>

  <para>
   Returns a result set listing the columns and associated metadata for a
   table.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Ресурс соединения с базой данных IBM DB2, Cloudscape
       или Apache Derby.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>qualifier</parameter></term>
     <listitem>
      <para>
       Квалификатор для баз DB2, работающих на серверах
       OS/390 или z/OS. В остальных случаях указывайте &null;
       или пустую строку.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>schema</parameter></term>
     <listitem>
      <para>
       Схема, содержащая таблицы. Для выбора всех схем
       укажите <literal>'%'</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Имя таблицы или представления. Для выбора всех таблиц
       укажите &null; или пустую строку.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>column_name</parameter></term>
     <listitem>
      <para>
       Имя столбца. Для выбора всех столбцов
       укажите &null; или пустую строку.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает ресурс оператора с результирующим набором,
   содержащим строки, описывающие заданные
   условиями столбцы. Строки содержат следующие поля:
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Имя столбца</entry>
       <entry>Описание</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>TABLE_CAT</entry>
       <entry>Имя каталога. Если таблица не имеет каталогов,
        то это поле будет содержать NULL.</entry>
      </row>
      <row>
       <entry>TABLE_SCHEM</entry>
       <entry>Имя схемы.</entry>
      </row>
      <row>
       <entry>TABLE_NAME</entry>
       <entry>Имя таблицы или представления.</entry>
      </row>
      <row>
       <entry>COLUMN_NAME</entry>
       <entry>Имя столбца.</entry>
      </row>
      <row>
       <entry>DATA_TYPE</entry>
       <entry>Тип данных SQL в виде целого числа.</entry>
      </row>
      <row>
       <entry>TYPE_NAME</entry>
       <entry>Текстовое представление типа данных.</entry>
      </row>
      <row>
       <entry>COLUMN_SIZE</entry>
       <entry>Размер столбца в виде целого числа.</entry>
      </row>
      <row>
       <entry>BUFFER_LENGTH</entry>
       <entry>
        Максимальное количество байт, необходимое для хранения данных из этого столбца.
       </entry>
      </row>
      <row>
       <entry>DECIMAL_DIGITS</entry>
       <entry>
        Количество цифр после запятой, или &null;, если не применимо.
       </entry>
      </row>
      <row>
       <entry>NUM_PREC_RADIX</entry>
       <entry>
        Целое число, равное <literal>10</literal> (если длина
        числа измеряется в десятичных цифрах),
        <literal>2</literal> (если длина измеряется в битах), или
        &null; (если не применимо).
       </entry>
      </row>
      <row>
       <entry>NULLABLE</entry>
       <entry>Целое число, определяющее, может ли столбец принимать значение NULL.</entry>
      </row>
      <row>
       <entry>REMARKS</entry>
       <entry>Описание столбца.</entry>
      </row>
      <row>
       <entry>COLUMN_DEF</entry>
       <entry>Значение поля по умолчанию.</entry>
      </row>
      <row>
       <entry>SQL_DATA_TYPE</entry>
       <entry>Целое число, определяющее длину записи.</entry>
      </row>
      <row>
       <entry>SQL_DATETIME_SUB</entry>
       <entry>
        Возвращает целое число, описывающее подтип данных
        Datrtime или &null;, если не применимо.
       </entry>
      </row>
      <row>
       <entry>CHAR_OCTET_LENGTH</entry>
       <entry>
        Максимальная длина в октетах для символьных типов
        данных. Совпадает с COLUMN_SIZE для однобайтовых
        символьных данных или &null; для несимвольных данных.
       </entry>
      </row>
      <row>
       <entry>ORDINAL_POSITION</entry>
       <entry>Порядковый номер столбца в таблице. Начинаются с 1.</entry>
      </row>
      <row>
       <entry>IS_NULLABLE</entry>
       <entry>
        Строка равная 'YES', если столбец может быть NULL и 'NO',
        если нет.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>

  </para>
 </refsect1>

 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>db2_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_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_special_columns</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:"~/.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
-->