-
Notifications
You must be signed in to change notification settings - Fork 70
/
odbc-statistics.xml
186 lines (179 loc) · 5.89 KB
/
odbc-statistics.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 902c2b77f827e8d0ecccf4f62fb90065d2f6ef79 Maintainer: zors1 Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.odbc-statistics" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_statistics</refname>
<refpurpose>Получает статистику о таблице</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_statistics</methodname>
<methodparam><type>resource</type><parameter>odbc</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>unique</parameter></methodparam>
<methodparam><type>int</type><parameter>accuracy</parameter></methodparam>
</methodsynopsis>
<para>
Получает статистику о таблице и её индексах.
</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;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>table</parameter></term>
<listitem>
<para>
Имя таблицы.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique</parameter></term>
<listitem>
<para>
Тип индекса.
Одна из констант <constant>SQL_INDEX_UNIQUE</constant> или
<constant>SQL_INDEX_ALL</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>accuracy</parameter></term>
<listitem>
<para>
Одна из констант <constant>SQL_ENSURE</constant> или
<constant>SQL_QUICK</constant>. Последняя запрашивает у драйвера
получение <literal>CARDINALITY</literal> и <literal>PAGES</literal>,
только если они легко доступны с сервера.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает идентификатор результата ODBC&return.falseforfailure;.
</para>
<para>
В результирующем наборе имеются следующие столбцы:
<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>NON_UNIQUE</literal></simpara></listitem>
<listitem><simpara><literal>INDEX_QUALIFIER</literal></simpara></listitem>
<listitem><simpara><literal>INDEX_NAME</literal></simpara></listitem>
<listitem><simpara><literal>TYPE</literal></simpara></listitem>
<listitem><simpara><literal>ORDINAL_POSITION</literal></simpara></listitem>
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
<listitem><simpara><literal>ASC_OR_DESC</literal></simpara></listitem>
<listitem><simpara><literal>CARDINALITY</literal></simpara></listitem>
<listitem><simpara><literal>PAGES</literal></simpara></listitem>
<listitem><simpara><literal>FILTER_CONDITION</literal></simpara></listitem>
</itemizedlist>
&odbc.result.driver-specific;
</para>
<simpara>
Результирующий набор упорядочивается по <literal>NON_UNIQUE</literal>,
<literal>TYPE</literal>, <literal>INDEX_QUALIFIER</literal>,
<literal>INDEX_NAME</literal> и <literal>ORDINAL_POSITION</literal>.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="odbc-statistics.example.basic">
<title>Вывод статистики о таблице</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = odbc_connect($dsn, $user, $pass);
$statistics = odbc_statistics($conn, 'TutorialDB', 'dbo', 'TEST', SQL_INDEX_UNIQUE, SQL_QUICK);
while (($row = odbc_fetch_array($statistics))) {
print_r($row);
break; // последующие строки опущены для краткости
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[TABLE_CAT] => TutorialDB
[TABLE_SCHEM] => dbo
[TABLE_NAME] => TEST
[NON_UNIQUE] =>
[INDEX_QUALIFIER] =>
[INDEX_NAME] =>
[TYPE] => 0
[ORDINAL_POSITION] =>
[COLUMN_NAME] =>
[ASC_OR_DESC] =>
[CARDINALITY] => 15
[PAGES] => 3
[FILTER_CONDITION] =>
)
]]>
</screen>
</example>
</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
-->