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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 288721 $ -->
<refentry xml:id="sphinxclient.query" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SphinxClient::query</refname>
<refpurpose>Execute search query</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>SphinxClient::query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>index</parameter><initializer>"*"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>comment</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Connects to searchd server, runs the given search query with the current settings,
obtains and returns the result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
Query string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
An index name (or names).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>comment</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
On success, <function>SphinxClient::query</function> returns a list of
found matches and additional per-query statistics. The result set is a
hash utilize other structures instead of hash) with the following keys and
values:
<table>
<title>Result set structure</title>
<tgroup cols="2">
<thead>
<row>
<entry>Key</entry>
<entry>Value description</entry>
</row>
</thead>
<tbody>
<row>
<entry>"matches"</entry>
<entry>An array with found document IDs as keys and their weight and
attributes values as values</entry>
</row>
<row>
<entry>"total"</entry>
<entry>Total number of matches found and retrieved (depends on your
settings)</entry>
</row>
<row>
<entry>"total_found"</entry>
<entry>Total number of found documents matching the query</entry>
</row>
<row>
<entry>"words"</entry>
<entry>An array with words (case-folded and stemmed) as keys and
per-word statistics as values</entry>
</row>
<row>
<entry>"error"</entry>
<entry>Query error message reported by searchd</entry>
</row>
<row>
<entry>"warning"</entry>
<entry>Query warning reported by searchd</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="sphinxclient.runqueries" /></member>
<member><xref linkend="sphinxclient.addquery" /></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
-->
|
