reference/uodbc/functions/odbc-statistics.xml
902c2b77f827e8d0ecccf4f62fb90065d2f6ef79
...
...
@@ -9,11 +9,11 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>odbc_statistics</methodname>
13
-
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>qualifier</parameter></methodparam>
15
-
<methodparam><type>string</type><parameter>owner</parameter></methodparam>
16
-
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
12
+
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_statistics</methodname>
13
+
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
14
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter></methodparam>
15
+
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
16
+
<methodparam><type>string</type><parameter>table</parameter></methodparam>
17
17
<methodparam><type>int</type><parameter>unique</parameter></methodparam>
18
18
<methodparam><type>int</type><parameter>accuracy</parameter></methodparam>
19
19
</methodsynopsis>
...
...
@@ -27,29 +27,29 @@
27
27
<para>
28
28
<variablelist>
29
29
<varlistentry>
30
-
<term><parameter>connection_id</parameter></term>
30
+
<term><parameter>odbc</parameter></term>
31
31
<listitem>
32
32
&odbc.connection.id;
33
33
</listitem>
34
34
</varlistentry>
35
35
<varlistentry>
36
-
<term><parameter>qualifier</parameter></term>
36
+
<term><parameter>catalog</parameter></term>
37
37
<listitem>
38
38
<para>
39
-
The qualifier.
39
+
&odbc.parameter.catalog;
40
40
</para>
41
41
</listitem>
42
42
</varlistentry>
43
43
<varlistentry>
44
-
<term><parameter>owner</parameter></term>
44
+
<term><parameter>schema</parameter></term>
45
45
<listitem>
46
46
<para>
47
-
The owner.
47
+
&odbc.parameter.schema;
48
48
</para>
49
49
</listitem>
50
50
</varlistentry>
51
51
<varlistentry>
52
-
<term><parameter>table_name</parameter></term>
52
+
<term><parameter>table</parameter></term>
53
53
<listitem>
54
54
<para>
55
55
The table name.
...
...
@@ -60,7 +60,8 @@
60
60
<term><parameter>unique</parameter></term>
61
61
<listitem>
62
62
<para>
63
-
The unique attribute.
63
+
The type of the index.
64
+
One of <constant>SQL_INDEX_UNIQUE</constant> or <constant>SQL_INDEX_ALL</constant>.
64
65
</para>
65
66
</listitem>
66
67
</varlistentry>
...
...
@@ -68,7 +69,9 @@
68
69
<term><parameter>accuracy</parameter></term>
69
70
<listitem>
70
71
<para>
71
-
The accuracy.
72
+
One of <constant>SQL_ENSURE</constant> or <constant>SQL_QUICK</constant>.
73
+
The latter requests that the driver retrieve the <literal>CARDINALITY</literal> and
74
+
<literal>PAGES</literal> only if they are readily available from the server.
72
75
</para>
73
76
</listitem>
74
77
</varlistentry>
...
...
@@ -84,29 +87,78 @@
84
87
<para>
85
88
The result set has the following columns:
86
89
<itemizedlist>
87
-
<listitem><simpara>TABLE_QUALIFIER</simpara></listitem>
88
-
<listitem><simpara>TABLE_OWNER</simpara></listitem>
89
-
<listitem><simpara>TABLE_NAME</simpara></listitem>
90
-
<listitem><simpara>NON_UNIQUE</simpara></listitem>
91
-
<listitem><simpara>INDEX_QUALIFIER</simpara></listitem>
92
-
<listitem><simpara>INDEX_NAME</simpara></listitem>
93
-
<listitem><simpara>TYPE</simpara></listitem>
94
-
<listitem><simpara>SEQ_IN_INDEX</simpara></listitem>
95
-
<listitem><simpara>COLUMN_NAME</simpara></listitem>
96
-
<listitem><simpara>COLLATION</simpara></listitem>
97
-
<listitem><simpara>CARDINALITY</simpara></listitem>
98
-
<listitem><simpara>PAGES</simpara></listitem>
99
-
<listitem><simpara>FILTER_CONDITION</simpara></listitem>
90
+
<listitem><simpara><literal>TABLE_CAT</literal></simpara></listitem>
91
+
<listitem><simpara><literal>TABLE_SCHEM</literal></simpara></listitem>
92
+
<listitem><simpara><literal>TABLE_NAME</literal></simpara></listitem>
93
+
<listitem><simpara><literal>NON_UNIQUE</literal></simpara></listitem>
94
+
<listitem><simpara><literal>INDEX_QUALIFIER</literal></simpara></listitem>
95
+
<listitem><simpara><literal>INDEX_NAME</literal></simpara></listitem>
96
+
<listitem><simpara><literal>TYPE</literal></simpara></listitem>
97
+
<listitem><simpara><literal>ORDINAL_POSITION</literal></simpara></listitem>
98
+
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
99
+
<listitem><simpara><literal>ASC_OR_DESC</literal></simpara></listitem>
100
+
<listitem><simpara><literal>CARDINALITY</literal></simpara></listitem>
101
+
<listitem><simpara><literal>PAGES</literal></simpara></listitem>
102
+
<listitem><simpara><literal>FILTER_CONDITION</literal></simpara></listitem>
100
103
</itemizedlist>
104
+
&odbc.result.driver-specific;
101
105
</para>
102
106
<simpara>
103
-
The result set is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER,
104
-
INDEX_NAME and SEQ_IN_INDEX.
107
+
The result set is ordered by <literal>NON_UNIQUE</literal>, <literal>TYPE</literal>, <literal>INDEX_QUALIFIER</literal>,
108
+
<literal>INDEX_NAME</literal> and <literal>ORDINAL_POSITION</literal>.
105
109
</simpara>
106
110
</refsect1>
107
111

108
-
</refentry>
112
+
<refsect1 role="examples">
113
+
&reftitle.examples;
114
+
<example xml:id="odbc-statistics.example.basic">
115
+
<title>List Statistics of a Table</title>
116
+
<programlisting role="php">
117
+
<![CDATA[
118
+
<?php
119
+
$conn = odbc_connect($dsn, $user, $pass);
120
+
$statistics = odbc_statistics($conn, 'TutorialDB', 'dbo', 'TEST', SQL_INDEX_UNIQUE, SQL_QUICK);
121
+
while (($row = odbc_fetch_array($statistics))) {
122
+
print_r($row);
123
+
break; // further rows omitted for brevity
124
+
}
125
+
?>
126
+
]]>
127
+
</programlisting>
128
+
&example.outputs.similar;
129
+
<screen>
130
+
<![CDATA[
131
+
Array
132
+
(
133
+
[TABLE_CAT] => TutorialDB
134
+
[TABLE_SCHEM] => dbo
135
+
[TABLE_NAME] => TEST
136
+
[NON_UNIQUE] =>
137
+
[INDEX_QUALIFIER] =>
138
+
[INDEX_NAME] =>
139
+
[TYPE] => 0
140
+
[ORDINAL_POSITION] =>
141
+
[COLUMN_NAME] =>
142
+
[ASC_OR_DESC] =>
143
+
[CARDINALITY] => 15
144
+
[PAGES] => 3
145
+
[FILTER_CONDITION] =>
146
+
)
147
+
]]>
148
+
</screen>
149
+
</example>
150
+
</refsect1>
109
151

152
+
<refsect1 role="seealso">
153
+
&reftitle.seealso;
154
+
<para>
155
+
<simplelist>
156
+
<member><function>odbc_tables</function></member>
157
+
</simplelist>
158
+
</para>
159
+
</refsect1>
160
+

161
+
</refentry>
110
162
<!-- Keep this comment at the end of the file
111
163
Local variables:
112
164
mode: sgml
113
165