File: odbc-columns.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (130 lines) | stat: -rw-r--r-- 3,861 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.odbc-columns" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_columns</refname>
  <refpurpose>Lists the column names in specified tables</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>odbc_columns</methodname>
   <methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>schema</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>column_name</parameter></methodparam>
  </methodsynopsis>
  <para>
   Lists all columns in the requested range.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection_id</parameter></term>
     <listitem>
      &odbc.connection.id;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>qualifier</parameter></term>
     <listitem>
      <para>
       The qualifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>schema</parameter></term>
     <listitem>
      <para>
       The owner.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       The table name.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>column_name</parameter></term>
     <listitem>
      <para>
       The column name.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <para>
   The <parameter>schema</parameter>, <parameter>table_name</parameter>, and
   <parameter>column_name</parameter> accept search patterns ('%' to match
   zero or more characters and '_' to match a single character).
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an ODBC result identifier&return.falseforfailure;.
  </para>
  <para>
   The result set has the following columns:
   <itemizedlist>
    <listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
    <listitem><simpara>TABLE_SCHEM</simpara></listitem>
    <listitem><simpara>TABLE_NAME</simpara></listitem>
    <listitem><simpara>COLUMN_NAME</simpara></listitem>
    <listitem><simpara>DATA_TYPE</simpara></listitem>
    <listitem><simpara>TYPE_NAME</simpara></listitem>
    <listitem><simpara>PRECISION</simpara></listitem>
    <listitem><simpara>LENGTH</simpara></listitem>
    <listitem><simpara>SCALE</simpara></listitem>
    <listitem><simpara>RADIX</simpara></listitem>
    <listitem><simpara>NULLABLE</simpara></listitem>
    <listitem><simpara>REMARKS</simpara></listitem>
   </itemizedlist>
  </para>
  <para>
   The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and
   TABLE_NAME.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>odbc_columnprivileges</function> to retrieve associated
    privileges</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
-->