reference/uodbc/functions/odbc-columns.xml
902c2b77f827e8d0ecccf4f62fb90065d2f6ef79
...
...
@@ -8,12 +8,12 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>resource</type><methodname>odbc_columns</methodname>
12
-
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
13
-
<methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string</type><parameter>schema</parameter></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>table_name</parameter></methodparam>
16
-
<methodparam choice="opt"><type>string</type><parameter>column_name</parameter></methodparam>
11
+
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_columns</methodname>
12
+
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter><initializer>&null;</initializer></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>table</parameter><initializer>&null;</initializer></methodparam>
16
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>column</parameter><initializer>&null;</initializer></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
Lists all columns in the requested range.
...
...
@@ -24,16 +24,16 @@
24
24
<para>
25
25
<variablelist>
26
26
<varlistentry>
27
-
<term><parameter>connection_id</parameter></term>
27
+
<term><parameter>odbc</parameter></term>
28
28
<listitem>
29
29
&odbc.connection.id;
30
30
</listitem>
31
31
</varlistentry>
32
32
<varlistentry>
33
-
<term><parameter>qualifier</parameter></term>
33
+
<term><parameter>catalog</parameter></term>
34
34
<listitem>
35
35
<para>
36
-
The qualifier.
36
+
&odbc.parameter.catalog;
37
37
</para>
38
38
</listitem>
39
39
</varlistentry>
...
...
@@ -41,33 +41,31 @@
41
41
<term><parameter>schema</parameter></term>
42
42
<listitem>
43
43
<para>
44
-
The owner.
44
+
&odbc.parameter.schema;
45
+
&odbc.parameter.search;
45
46
</para>
46
47
</listitem>
47
48
</varlistentry>
48
49
<varlistentry>
49
-
<term><parameter>table_name</parameter></term>
50
+
<term><parameter>table</parameter></term>
50
51
<listitem>
51
52
<para>
52
53
The table name.
54
+
&odbc.parameter.search;
53
55
</para>
54
56
</listitem>
55
57
</varlistentry>
56
58
<varlistentry>
57
-
<term><parameter>column_name</parameter></term>
59
+
<term><parameter>column</parameter></term>
58
60
<listitem>
59
61
<para>
60
62
The column name.
63
+
&odbc.parameter.search;
61
64
</para>
62
65
</listitem>
63
66
</varlistentry>
64
67
</variablelist>
65
68
</para>
66
-
<para>
67
-
The <parameter>schema</parameter>, <parameter>table_name</parameter>, and
68
-
<parameter>column_name</parameter> accept search patterns ('%' to match
69
-
zero or more characters and '_' to match a single character).
70
-
</para>
71
69
</refsect1>
72
70
<refsect1 role="returnvalues">
73
71
&reftitle.returnvalues;
...
...
@@ -77,37 +75,112 @@
77
75
<para>
78
76
The result set has the following columns:
79
77
<itemizedlist>
80
-
<listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
81
-
<listitem><simpara>TABLE_SCHEM</simpara></listitem>
82
-
<listitem><simpara>TABLE_NAME</simpara></listitem>
83
-
<listitem><simpara>COLUMN_NAME</simpara></listitem>
84
-
<listitem><simpara>DATA_TYPE</simpara></listitem>
85
-
<listitem><simpara>TYPE_NAME</simpara></listitem>
86
-
<listitem><simpara>PRECISION</simpara></listitem>
87
-
<listitem><simpara>LENGTH</simpara></listitem>
88
-
<listitem><simpara>SCALE</simpara></listitem>
89
-
<listitem><simpara>RADIX</simpara></listitem>
90
-
<listitem><simpara>NULLABLE</simpara></listitem>
91
-
<listitem><simpara>REMARKS</simpara></listitem>
78
+
<listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
79
+
<listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
80
+
<listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
81
+
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
82
+
<listitem><simpara><literal>DATA_TYPE</literal></simpara></listitem>
83
+
<listitem><simpara><literal>TYPE_NAME</literal></simpara></listitem>
84
+
<listitem><simpara><literal>COLUMN_SIZE</literal></simpara></listitem>
85
+
<listitem><simpara><literal>BUFFER_LENGTH</literal></simpara></listitem>
86
+
<listitem><simpara><literal>DECIMAL_DIGITS</literal></simpara></listitem>
87
+
<listitem><simpara><literal>NUM_PREC_RADIX</literal></simpara></listitem>
88
+
<listitem><simpara><literal>NULLABLE</literal></simpara></listitem>
89
+
<listitem><simpara><literal>REMARKS</literal></simpara></listitem>
90
+
<listitem><simpara><literal>COLUMN_DEF</literal></simpara></listitem>
91
+
<listitem><simpara><literal>SQL_DATA_TYPE</literal></simpara></listitem>
92
+
<listitem><simpara><literal>SQL_DATETIME_SUB</literal></simpara></listitem>
93
+
<listitem><simpara><literal>CHAR_OCTET_LENGTH</literal></simpara></listitem>
94
+
<listitem><simpara><literal>ORDINAL_POSITION</literal></simpara></listitem>
95
+
<listitem><simpara><literal>IS_NULLABLE</literal></simpara></listitem>
92
96
</itemizedlist>
97
+
&odbc.result.driver-specific;
93
98
</para>
94
-
<para>
95
-
The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and
96
-
TABLE_NAME.
97
-
</para>
99
+
<simpara>
100
+
The result set is ordered by <literal>TABLE_CAT</literal>, <literal>TABLE_SCHEM</literal>,
101
+
<literal>TABLE_NAME</literal> and <literal>ORDINAL_POSITION</literal>.
102
+
</simpara>
103
+
</refsect1>
104
+

105
+
<refsect1 role="changelog">
106
+
&reftitle.changelog;
107
+
<informaltable>
108
+
<tgroup cols="2">
109
+
<thead>
110
+
<row>
111
+
<entry>&Version;</entry>
112
+
<entry>&Description;</entry>
113
+
</row>
114
+
</thead>
115
+
<tbody>
116
+
<row>
117
+
<entry>8.0.0</entry>
118
+
<entry>
119
+
<parameter>schema</parameter>, <parameter>table</parameter> and <parameter>column</parameter>
120
+
are now nullable.
121
+
</entry>
122
+
</row>
123
+
</tbody>
124
+
</tgroup>
125
+
</informaltable>
126
+
</refsect1>
127
+

128
+
<refsect1 role="examples">
129
+
&reftitle.examples;
130
+
<example xml:id="odbc-columns.example.basic">
131
+
<title>List Columns of a Table</title>
132
+
<programlisting role="php">
133
+
<![CDATA[
134
+
<?php
135
+
$conn = odbc_connect($dsn, $user, $pass);
136
+
$columns = odbc_columns($conn, 'TutorialDB', 'dbo', 'test', '%');
137
+
while (($row = odbc_fetch_array($columns))) {
138
+
print_r($row);
139
+
break; // further rows omitted for brevity
140
+
}
141
+
?>
142
+
]]>
143
+
</programlisting>
144
+
&example.outputs.similar;
145
+
<screen>
146
+
<![CDATA[
147
+
Array
148
+
(
149
+
[TABLE_CAT] => TutorialDB
150
+
[TABLE_SCHEM] => dbo
151
+
[TABLE_NAME] => TEST
152
+
[COLUMN_NAME] => id
153
+
[DATA_TYPE] => 4
154
+
[TYPE_NAME] => int
155
+
[COLUMN_SIZE] => 10
156
+
[BUFFER_LENGTH] => 4
157
+
[DECIMAL_DIGITS] => 0
158
+
[NUM_PREC_RADIX] => 10
159
+
[NULLABLE] => 0
160
+
[REMARKS] =>
161
+
[COLUMN_DEF] =>
162
+
[SQL_DATA_TYPE] => 4
163
+
[SQL_DATETIME_SUB] =>
164
+
[CHAR_OCTET_LENGTH] =>
165
+
[ORDINAL_POSITION] => 1
166
+
[IS_NULLABLE] => NO
167
+
)
168
+
]]>
169
+
</screen>
170
+
</example>
98
171
</refsect1>
172
+

99
173
<refsect1 role="seealso">
100
174
&reftitle.seealso;
101
175
<para>
102
176
<simplelist>
103
-
<member><function>odbc_columnprivileges</function> to retrieve associated
104
-
privileges</member>
177
+
<member><function>odbc_columnprivileges</function></member>
178
+
<member><function>odbc_procedurecolumns</function></member>
105
179
</simplelist>
106
180
</para>
107
181
</refsect1>
108
182

109
183
</refentry>
110
-

111
184
<!-- Keep this comment at the end of the file
112
185
Local variables:
113
186
mode: sgml
114
187



Tools (Spanish Manual)