Files
php-doc-ru/reference/ibm_db2/functions/db2-procedure-columns.xml
2023-04-11 11:45:36 +03:00

264 lines
10 KiB
XML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.db2-procedure-columns" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>db2_procedure_columns</refname>
<refpurpose>Возвращает набор результатов со списком параметров хранимой процедуры</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>db2_procedure_columns</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>qualifier</parameter></methodparam>
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
<methodparam><type>string</type><parameter>procedure</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
Возвращает набор результатов, в котором перечислены параметры для одной или нескольких хранимых процедур.
</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> и <literal>%</literal> в качестве подстановочных знаков.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>procedure</parameter></term>
<listitem>
<para>
Название процедуры. Параметр принимает шаблон поиска,
содержащий <literal>_</literal> и <literal>%</literal> в качестве подстановочных знаков.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
Имя параметра. Параметр принимает шаблон поиска,
содержащий <literal>_</literal> и <literal>%</literal> в качестве подстановочных знаков.
Если параметр равен &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>PROCEDURE_CAT</entry>
<entry>
Каталог, содержащий таблицу. Значение &null;, если в этой таблице нет каталогов.
</entry>
</row>
<row>
<entry>PROCEDURE_SCHEM</entry>
<entry>Имя схемы, содержащей хранимую процедуру.</entry>
</row>
<row>
<entry>PROCEDURE_NAME</entry>
<entry>Название процедуры.</entry>
</row>
<row>
<entry>COLUMN_NAME</entry>
<entry>Название параметра.</entry>
</row>
<row>
<entry>COLUMN_TYPE</entry>
<entry>
<para>
Целочисленное значение, представляющее тип параметра:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Возвращаемое значение</entry>
<entry>Тип параметра</entry>
</row>
</thead>
<tbody>
<row>
<entry>1 (SQL_PARAM_INPUT)</entry>
<entry>Входной (IN) параметр.</entry>
</row>
<row>
<entry>2 (SQL_PARAM_INPUT_OUTPUT)</entry>
<entry>Входной параметр/параметр вывода (INOUT).</entry>
</row>
<row>
<entry>3 (SQL_PARAM_OUTPUT)</entry>
<entry>Параметр (OUT) вывода.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</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>
Возвращает целочисленное значение, представляющее код подтипа datetime
или &null; для типов данных SQL, к которым это не относится.
</entry>
</row>
<row>
<entry>CHAR_OCTET_LENGTH</entry>
<entry>
Максимальная длина в октетах для параметра символьного типа данных,
который соответствует COLUMN_SIZE для однобайтовых данных набора символов
или &null; для несимвольных типов данных.
</entry>
</row>
<row>
<entry>ORDINAL_POSITION</entry>
<entry>
Индекс параметра (начиная с 1) в операторе CALL.
</entry>
</row>
<row>
<entry>IS_NULLABLE</entry>
<entry>
Строковое значение, где "YES" означает, что параметр принимает или возвращает значения &null;
и "NO" означает, что параметр не принимает и не возвращает значения &null;.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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_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
-->