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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-tables" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_tables</refname>
<refpurpose>Get the list of table names stored in a specific data source</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_tables</methodname>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>catalog</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</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>types</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Lists all tables in the requested range.
</para>
<para>
To support enumeration of qualifiers, owners, and table types,
the following special semantics for the
<parameter>catalog</parameter>, <parameter>schema</parameter>,
<parameter>table</parameter>, and
<parameter>table_type</parameter> are available:
<itemizedlist>
<listitem>
<simpara>
If <parameter>catalog</parameter> is a single percent
character (%) and <parameter>schema</parameter> and
<parameter>table</parameter> are empty strings, then the result
set contains a list of valid qualifiers for the data
source. (All columns except the TABLE_QUALIFIER column contain
NULLs.)
</simpara>
</listitem>
<listitem>
<simpara>
If <parameter>schema</parameter> is a single percent character
(%) and <parameter>catalog</parameter> and
<parameter>table</parameter> are empty strings, then the result
set contains a list of valid owners for the data source. (All
columns except the TABLE_OWNER column contain
NULLs.)
</simpara>
</listitem>
<listitem>
<simpara>
If <parameter>table_type</parameter> is a single percent
character (%) and <parameter>catalog</parameter>,
<parameter>schema</parameter> and <parameter>table</parameter>
are empty strings, then the result set contains a list of
valid table types for the data source. (All columns except the
TABLE_TYPE column contain NULLs.)
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>odbc</parameter></term>
<listitem>
&odbc.connection.id;
</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;
&odbc.parameter.search;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>table</parameter></term>
<listitem>
<para>
The name.
&odbc.parameter.search;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>types</parameter></term>
<listitem>
<para>
If <parameter>table_type</parameter> is not an empty string, it
must contain a list of comma-separated values for the types of
interest; each value may be enclosed in single quotes (<literal>'</literal>) or
unquoted. For example, <literal>'TABLE','VIEW'</literal> or <literal>TABLE, VIEW</literal>. If the
data source does not support a specified table type,
<function>odbc_tables</function> does not return any results for
that type.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&odbc.result.object-return; containing the information
&return.falseforfailure;.
</para>
<para>
The result set has the following columns:
<itemizedlist>
<listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
<listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
<listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
<listitem><simpara><literal>TABLE_TYPE</literal></simpara></listitem>
<listitem><simpara><literal>REMARKS</literal></simpara></listitem>
</itemizedlist>
&odbc.result.driver-specific;
</para>
<simpara>
The result set is ordered by <literal>TABLE_TYPE</literal>, <literal>TABLE_CAT</literal>,
<literal>TABLE_SCHEM</literal> and <literal>TABLE_NAME</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;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>schema</parameter>, <parameter>table</parameter> and <parameter>types</parameter>
are now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="odbc-tables.example.basic">
<title>List Tables in a Catalog</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = odbc_connect($dsn, $user, $pass);
$tables = odbc_tables($conn, 'SalesOrders', 'dbo', '%', 'TABLE');
while (($row = odbc_fetch_array($tables))) {
print_r($row);
break; // further rows omitted for brevity
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[TABLE_CAT] => SalesOrders
[TABLE_SCHEM] => dbo
[TABLE_NAME] => Orders
[TABLE_TYPE] => TABLE
[REMARKS] =>
)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>odbc_tableprivileges</function></member>
<member><function>odbc_columns</function></member>
<member><function>odbc_specialcolumns</function></member>
<member><function>odbc_statistics</function></member>
<member><function>odbc_procedures</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
-->
|
