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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 288721 $ -->
<refentry xml:id="sphinxclient.setlimits" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SphinxClient::setLimits</refname>
<refpurpose>Set offset and limit of the result set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SphinxClient::setLimits</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>limit</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>max_matches</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cutoff</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Sets <parameter>offset</parameter> into server-side result set and amount
of matches to return to client starting from that offset
(<parameter>limit</parameter>). Can additionally control maximum
server-side result set size for current query
(<parameter>max_matches</parameter>) and the threshold amount of matches
to stop searching at (<parameter>cutoff</parameter>).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
Result set offset.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
<para>
Amount of matches to return.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_matches</parameter></term>
<listitem>
<para>
Controls how much matches searchd will keep in RAM while searching.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cutoff</parameter></term>
<listitem>
<para>
Used for advanced performance control. It tells searchd to forcibly
stop search query once <parameter>cutoff</parameter> matches have been
found and processed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->
|
