-
Notifications
You must be signed in to change notification settings - Fork 79
Expand file tree
/
Copy pathodbc-specialcolumns.xml
More file actions
176 lines (171 loc) · 6.21 KB
/
odbc-specialcolumns.xml
File metadata and controls
176 lines (171 loc) · 6.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ed1aff13602c94f86344bdd7c4fbc31f5a71bf84 Maintainer: zors1 Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.odbc-specialcolumns" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_specialcolumns</refname>
<refpurpose>Извлекает особые столбцы</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_specialcolumns</methodname>
<methodparam><type>Odbc\Connection</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>
Функция извлекает либо оптимальный набор столбцов, который однозначно определяет
строку в таблице, либо столбцы, которые автоматически обновляются, когда
любое значение в строке обновляется транзакцией.
</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>
С аргументом <constant>SQL_BEST_ROWID</constant>
функция <function>odbc_specialcolumns</function> возвращает столбец или столбцы,
которые однозначно идентифицируют каждую строку в таблице.
</simpara>
<simpara>
С аргументом <constant>SQL_ROWVER</constant>
функция <function>odbc_specialcolumns</function> возвращает столбец или столбцы
в заданной таблице, если таблица содержит эти столбцы, которые автоматически
обновляются источником данных, когда любое значение в строке обновляется
любой транзакцией.
</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>
Таблица.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>scope</parameter></term>
<listitem>
<para>
Область, которая упорядочивает результирующий набор. Константа из следующего списка:
<constant>SQL_SCOPE_CURROW</constant>,
<constant>SQL_SCOPE_TRANSACTION</constant>
или <constant>SQL_SCOPE_SESSION</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nullable</parameter></term>
<listitem>
<para>
Определяет, возвращать ли специальные столбцы, в которых разрешается хранить
значение NULL. Константа <constant>SQL_NO_NULLS</constant> или
<constant>SQL_NULLABLE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&odbc.result.object-return-falseforfailure;
ошибки.
</para>
<para>
Набор результатов содержит следующие столбцы:
<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>
Набор результатов упорядочивается по столбцу <literal>SCOPE</literal>.
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
&odbc.changelog.result-return;
</tbody>
</tgroup>
</informaltable>
</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
-->