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
|
<?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>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>
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>
&odbc.result.object-return-falseforfailure;
</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="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
-->
|
