Skip to content
Browse files

Rename method query -> run-query

  • Loading branch information...
1 parent 4c86983 commit 566117e0d0b73d0dd87ad627639150628a855af6 Thijs Oppermann committed Nov 26, 2009
View
12 cl-sphinx-search.lisp
@@ -228,7 +228,7 @@
Set options and settings of the search to be performed on an object
of this class, and then have it perform one search by calling
- @fun{query}, or add a number of queries using @fun{add-query} and
+ @fun{run-query}, or add a number of queries using @fun{add-query} and
then calling @fun{run-queries}.
Either get a result hash or a list of result hashes back, or an error
@@ -732,7 +732,7 @@
client)
-(defgeneric query (client query &key index comment)
+(defgeneric run-query (client query &key index comment)
(:documentation
"@arg[client]{a @class{sphinx-client}}
@arg[query]{the query to run through @code{searchd}}
@@ -742,7 +742,7 @@
@short{Run a query through @code{searchd}.}
@begin{pre}
- (query client \"test\")
+ (run-query client \"test\")
@end{pre}
Query @code{searchd}. This method runs a single query through @code{searchd}.
@@ -765,7 +765,7 @@
"))
-(defmethod query ((client sphinx-client) query &key (index "*") (comment ""))
+(defmethod run-query ((client sphinx-client) query &key (index "*") (comment ""))
(assert (eql (length (reqs client)) 0))
(add-query client query :index index :comment comment)
(let* ((result (car (run-queries client))))
@@ -807,7 +807,7 @@
@dt[words]{a hash-table containing the matching words with their statistics}
@end{dl}
- @see{query}
+ @see{run-query}
@see{add-query}
"))
@@ -855,7 +855,7 @@
It returns the new length of the query queue, which is also the index
of the newly added query in the queue.
- @see{query}
+ @see{run-query}
@see{run-queries}
"))
View
26 doc/.atdoc.xml
@@ -17,14 +17,14 @@
(run-queries sph))<break/> </pre> </section><break/> <section section="One class">
There is just one class:<break/> <aboutclass>sphinx-client</aboutclass> </section><break/> <section section="Methods">
Setting options/parameters:<break/> <aboutfun>set-server</aboutfun> <aboutfun>set-limits</aboutfun><break/>
- Running queries:<break/> <aboutfun>query</aboutfun> <aboutfun>add-query</aboutfun> <aboutfun>run-queries</aboutfun><break/> </section><break/> <section section="Acknowledgements">
+ Running queries:<break/> <aboutfun>run-query</aboutfun> <aboutfun>add-query</aboutfun> <aboutfun>run-queries</aboutfun><break/> </section><break/> <section section="Acknowledgements">
This port is based on Sphinx.pm version 0.22 (deployed to CPAN <a a="http://search.cpan.org/~jjschutz/Sphinx-Search-0.22/">here</a>), which
itself says:<break/> <pre>
This module is based on Sphinx.pm (not deployed to CPAN) for
Sphinx version 0.9.7-rc1, by Len Kranendonk, which was in turn
based on the Sphinx PHP API. </pre><break/>
Also used was the api for python which was supplied with the source code download for Sphinx Search v0.9.9-rc2, in the <code>api/</code> directory.<break/> <b>Documentation</b><break/> This documentation was generated by <a a="http://www.lichteblau.com/atdoc/doc/">atdoc</a>,
- the documentation generation system written by David Lichteblau.<break/> </section></documentation-string><external-symbols><function-definition id="cl-sphinx-search__fun__set-filter-float-range" name="set-filter-float-range" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>attribute</elt><elt>min</elt><elt>max</elt><elt>&amp;key</elt><elt>exclude</elt><elt>(exclude nil)</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="attribute">the attribute to filter on</arg> <arg arg="min">start of the range to filter on</arg> <arg arg="max">end of the range to filter on</arg> <arg arg="exclude">if set, exclude the given range</arg> <return>client</return> <short>Sets the results to be filtered on the given range.</short><break/> <pre>
+ the documentation generation system written by David Lichteblau.<break/> </section></documentation-string><external-symbols><function-definition id="cl-sphinx-search__fun__set-filter-float-range" name="set-filter-float-range" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>attribute</elt><elt>min</elt><elt>max</elt><elt>&amp;key</elt><elt>exclude</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="attribute">the attribute to filter on</arg> <arg arg="min">start of the range to filter on</arg> <arg arg="max">end of the range to filter on</arg> <arg arg="exclude">if set, exclude the given range</arg> <return>client</return> <short>Sets the results to be filtered on the given range.</short><break/> <pre>
(set-filter-float-range client "filter_attr" 45.231 99)
(set-filter-float-range client "other_attr" 1.32 55.0031 :exclude t) </pre><break/>
Sets the results to be filtered on a range of values for the given
@@ -33,7 +33,7 @@
This may be called multiple times with different attributes to
select on multiple attributes.<break/> If <code>:exclude</code> is set, excludes results that fall within the
given range.<break/> <see id="cl-sphinx-search__fun__set-filter">set-filter</see> <see id="cl-sphinx-search__fun__set-filter-range">set-filter-range</see> <see id="cl-sphinx-search__fun__set-filter-float-range">set-filter-float-range</see> <see id="cl-sphinx-search__fun__set-geo-anchor">set-geo-anchor</see> <see id="cl-sphinx-search__fun__reset-filters">reset-filters</see></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__reset-filters" name="reset-filters" package="cl-sphinx-search"><lambda-list><elt>client</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <return>client</return> <short>Reset the filters.</short><break/>
- Clear all filters, including the geolocation anchor point.<break/> <see id="cl-sphinx-search__fun__set-filter">set-filter</see> <see id="cl-sphinx-search__fun__set-filter-range">set-filter-range</see> <see id="cl-sphinx-search__fun__set-filter-float-range">set-filter-float-range</see> <see id="cl-sphinx-search__fun__set-geo-anchor">set-geo-anchor</see> <see id="cl-sphinx-search__fun__reset-filters">reset-filters</see></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__add-query" name="add-query" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>query</elt><elt>&amp;key</elt><elt>index</elt><elt>comment</elt><elt>(index *)</elt><elt>(comment )</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="query">the query to run through <code>searchd</code></arg> <arg arg="index">the index to use; defaults to "*"</arg> <arg arg="comment">a comment describing this query; default none</arg> <return>length of query queue</return> <short>Add a query to a batch request.</short><break/> <pre>
+ Clear all filters, including the geolocation anchor point.<break/> <see id="cl-sphinx-search__fun__set-filter">set-filter</see> <see id="cl-sphinx-search__fun__set-filter-range">set-filter-range</see> <see id="cl-sphinx-search__fun__set-filter-float-range">set-filter-float-range</see> <see id="cl-sphinx-search__fun__set-geo-anchor">set-geo-anchor</see> <see id="cl-sphinx-search__fun__reset-filters">reset-filters</see></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__add-query" name="add-query" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>query</elt><elt>&amp;key</elt><elt>index</elt><elt>comment</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="query">the query to run through <code>searchd</code></arg> <arg arg="index">the index to use; defaults to "*"</arg> <arg arg="comment">a comment describing this query; default none</arg> <return>length of query queue</return> <short>Add a query to a batch request.</short><break/> <pre>
(add-query client "test")
(add-query client "word" :index "*")
(run-queries client) </pre><break/>
@@ -43,7 +43,7 @@
full-text search and ranking operation only once, but compute
multiple group-by results from its output.<break/>
It returns the new length of the query queue, which is also the index
- of the newly added query in the queue.<break/> <see id="cl-sphinx-search__fun__query">query</see> <see id="cl-sphinx-search__fun__run-queries">run-queries</see><break/></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__reset-overrides" name="reset-overrides" package="cl-sphinx-search"><lambda-list><elt>client</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <return>client</return> <short>Clear all attribute value overrides.</short></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-select" name="set-select" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>select</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="select">the select string</arg> <return>client</return> <short>Set the select clause.</short><break/>
+ of the newly added query in the queue.<break/> <see id="cl-sphinx-search__fun__run-query">run-query</see> <see id="cl-sphinx-search__fun__run-queries">run-queries</see><break/></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__reset-overrides" name="reset-overrides" package="cl-sphinx-search"><lambda-list><elt>client</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <return>client</return> <short>Clear all attribute value overrides.</short></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-select" name="set-select" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>select</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="select">the select string</arg> <return>client</return> <short>Set the select clause.</short><break/>
Sets the select clause, listing specific attributes to fetch, and
expressions to compute and fetch. Clause syntax mimics SQL.<break/>
The select clause is very similar to the part of a typical SQL query between <code>SELECT</code> and <code>FROM</code>. It lets you choose what
@@ -62,18 +62,18 @@
Examples:<break/> <pre>
(set-select sph "*, (user_karma+ln(pageviews))*0.1 AS myweight" )
(set-select sph "exp_years, salary_gbp*{$gbp_usd_rate} AS salary_usd, IF(age&gt;40,1,0) AS over40" )
- (set-select sph "*, AVG(price) AS avgprice" ) </pre></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__query" name="query" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>query</elt><elt>&amp;key</elt><elt>index</elt><elt>comment</elt><elt>(index *)</elt><elt>(comment )</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="query">the query to run through <code>searchd</code></arg> <arg arg="index">the index to use; defaults to "*"</arg> <arg arg="comment">a comment describing this query; default none</arg> <return>nil or a hash containing the query results</return> <short>Run a query through <code>searchd</code>.</short><break/> <pre>
- (query client "test") </pre><break/> Query <code>searchd</code>. This method runs a single query through <code>searchd</code>.<break/>
- It returns the results in a hash with the following keys: <dl> <dt dt="attributes">a hash-table containing attributes</dt> <dt dt="fields">a list of fields</dt> <dt dt="matches">a hash-table containing the matches</dt> <dt dt="status">the status returned by <code>searchd</code></dt> <dt dt="status-message">the status message returned by <code>searchd</code></dt> <dt dt="time">the time <code>searchd</code> took for the query</dt> <dt dt="total">the total matches returned</dt> <dt dt="total-found">the total number of matches found</dt> <dt dt="words">a hash-table containing the matching words with their statistics</dt> </dl><break/> <see id="cl-sphinx-search__fun__add-query">add-query</see> <see id="cl-sphinx-search__fun__run-queries">run-queries</see><break/></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__run-queries" name="run-queries" package="cl-sphinx-search"><lambda-list><elt>client</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <return>nil or a list of hashes</return> <short>Run the queries added with <code>add-query</code> through <code>searchd</code>.</short><break/> <pre>
+ (set-select sph "*, AVG(price) AS avgprice" ) </pre></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__run-queries" name="run-queries" package="cl-sphinx-search"><lambda-list><elt>client</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <return>nil or a list of hashes</return> <short>Run the queries added with <code>add-query</code> through <code>searchd</code>.</short><break/> <pre>
(add-query client "test")
(add-query client "word")
(run-queries client) </pre><break/> Query <code>searchd</code> with the collected queries added with <code>add-query</code>.<break/>
It returns a list of hashes containing the result of each query. Each hash
- has the following keys: <dl> <dt dt="attributes">a hash-table containing attributes</dt> <dt dt="fields">a list of fields</dt> <dt dt="matches">a hash-table containing the matches</dt> <dt dt="status">the status returned by <code>searchd</code></dt> <dt dt="status-message">the status message returned by <code>searchd</code></dt> <dt dt="time">the time <code>searchd</code> took for the query</dt> <dt dt="total">the total matches returned</dt> <dt dt="total-found">the total number of matches found</dt> <dt dt="words">a hash-table containing the matching words with their statistics</dt> </dl><break/> <see id="cl-sphinx-search__fun__query">query</see> <see id="cl-sphinx-search__fun__add-query">add-query</see><break/></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-limits" name="set-limits" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>&amp;key</elt><elt>offset</elt><elt>limit</elt><elt>max</elt><elt>cutoff</elt><elt>(offset 0)</elt><elt>(max 1000)</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="offset">the offset to start returning matches from</arg> <arg arg="limit">how many matches to return starting from <code>offset</code></arg> <arg arg="max">maximum number of matches to return</arg> <arg arg="cutoff">the cutoff to stop searching at</arg> <return>client</return> <short>Set the offset, limit, cutoff and max matches to return.</short><break/> <pre>
+ has the following keys: <dl> <dt dt="attributes">a hash-table containing attributes</dt> <dt dt="fields">a list of fields</dt> <dt dt="matches">a hash-table containing the matches</dt> <dt dt="status">the status returned by <code>searchd</code></dt> <dt dt="status-message">the status message returned by <code>searchd</code></dt> <dt dt="time">the time <code>searchd</code> took for the query</dt> <dt dt="total">the total matches returned</dt> <dt dt="total-found">the total number of matches found</dt> <dt dt="words">a hash-table containing the matching words with their statistics</dt> </dl><break/> <see id="cl-sphinx-search__fun__run-query">run-query</see> <see id="cl-sphinx-search__fun__add-query">add-query</see><break/></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__run-query" name="run-query" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>query</elt><elt>&amp;key</elt><elt>index</elt><elt>comment</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="query">the query to run through <code>searchd</code></arg> <arg arg="index">the index to use; defaults to "*"</arg> <arg arg="comment">a comment describing this query; default none</arg> <return>nil or a hash containing the query results</return> <short>Run a query through <code>searchd</code>.</short><break/> <pre>
+ (run-query client "test") </pre><break/> Query <code>searchd</code>. This method runs a single query through <code>searchd</code>.<break/>
+ It returns the results in a hash with the following keys: <dl> <dt dt="attributes">a hash-table containing attributes</dt> <dt dt="fields">a list of fields</dt> <dt dt="matches">a hash-table containing the matches</dt> <dt dt="status">the status returned by <code>searchd</code></dt> <dt dt="status-message">the status message returned by <code>searchd</code></dt> <dt dt="time">the time <code>searchd</code> took for the query</dt> <dt dt="total">the total matches returned</dt> <dt dt="total-found">the total number of matches found</dt> <dt dt="words">a hash-table containing the matching words with their statistics</dt> </dl><break/> <see id="cl-sphinx-search__fun__add-query">add-query</see> <see id="cl-sphinx-search__fun__run-queries">run-queries</see><break/></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-limits" name="set-limits" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>&amp;key</elt><elt>offset</elt><elt>limit</elt><elt>max</elt><elt>cutoff</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="offset">the offset to start returning matches from</arg> <arg arg="limit">how many matches to return starting from <code>offset</code></arg> <arg arg="max">maximum number of matches to return</arg> <arg arg="cutoff">the cutoff to stop searching at</arg> <return>client</return> <short>Set the offset, limit, cutoff and max matches to return.</short><break/> <pre>
(set-limits client :limit limit)
(set-limits client :offset offset :limit limit)
(set-limits client :offset offset :limit limit :max max-matches) </pre><break/>
- Set limit of matches to return. Defaults to offset 0 and 1000 max matches.</documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-filter-range" name="set-filter-range" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>attribute</elt><elt>min</elt><elt>max</elt><elt>&amp;key</elt><elt>exclude</elt><elt>(exclude nil)</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="attribute">the attribute to filter on</arg> <arg arg="min">start of the range to filter on</arg> <arg arg="max">end of the range to filter on</arg> <arg arg="exclude">if set, exclude the given range</arg> <return>client</return> <short>Sets the results to be filtered on the given range.</short><break/> <pre>
+ Set limit of matches to return. Defaults to offset 0 and 1000 max matches.</documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-filter-range" name="set-filter-range" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>attribute</elt><elt>min</elt><elt>max</elt><elt>&amp;key</elt><elt>exclude</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="attribute">the attribute to filter on</arg> <arg arg="min">start of the range to filter on</arg> <arg arg="max">end of the range to filter on</arg> <arg arg="exclude">if set, exclude the given range</arg> <return>client</return> <short>Sets the results to be filtered on the given range.</short><break/> <pre>
(set-filter-range client "filter_attr" 45 99)
(set-filter-range client "other_attr" 2 8 :exclude t) </pre><break/>
Sets the results to be filtered on a range of values for the given
@@ -82,7 +82,7 @@
This may be called multiple times with different attributes to
select on multiple attributes.<break/> If <code>:exclude</code> is set, excludes results that fall within the
given range.<break/> <see id="cl-sphinx-search__fun__set-filter">set-filter</see> <see id="cl-sphinx-search__fun__set-filter-range">set-filter-range</see> <see id="cl-sphinx-search__fun__set-filter-float-range">set-filter-float-range</see> <see id="cl-sphinx-search__fun__set-geo-anchor">set-geo-anchor</see> <see id="cl-sphinx-search__fun__reset-filters">reset-filters</see></documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__last-warning" name="last-warning" package="cl-sphinx-search"><lambda-list><elt>client</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <return>a string; the last warning message returned from the <code>searchd</code>.</return><break/>
- Get the last warning message sent by searchd.</documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-server" name="set-server" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>&amp;key</elt><elt>host</elt><elt>port</elt><elt>path</elt><elt>(host localhost)</elt><elt>(port 3312)</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="host">the host to connect to when using an INET socket</arg> <arg arg="port">the port to connect to when using an INET socket</arg> <arg arg="path">the path to the unix domain socket when not using INET</arg> <return>client</return> <short>Set the server host:port or path to connect to.</short><break/> <pre>
+ Get the last warning message sent by searchd.</documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-server" name="set-server" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>&amp;key</elt><elt>host</elt><elt>port</elt><elt>path</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="host">the host to connect to when using an INET socket</arg> <arg arg="port">the port to connect to when using an INET socket</arg> <arg arg="path">the path to the unix domain socket when not using INET</arg> <return>client</return> <short>Set the server host:port or path to connect to.</short><break/> <pre>
(set-server client :host host :port port)
(set-server client :path unix-path) </pre><break/> In the first form, sets the <code>host</code> (string) and <code>port</code> (integer)
details for the searchd server using a network (INET) socket.<break/> In the second form, where <code>unix-path</code> is a local filesystem path
@@ -116,7 +116,7 @@
Get the last error message sent by searchd.</documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__max-query-time" name="max-query-time" package="cl-sphinx-search"><lambda-list><elt>client</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <return>a number; the max query time in milliseconds.</return><break/>
Get the max query time.</documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-id-range" name="set-id-range" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>min</elt><elt>max</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="min">minimum id to start searching from</arg> <arg arg="max">maximum id to stop searching at</arg> <return>client</return> <short>Set the id-range to search within (inclusive).</short><break/>
Set the range of id's within which to search. Range is inclusive, so setting
- [0, 450] both 0 and 450 id's will be found.</documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-filter" name="set-filter" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>attribute</elt><elt>values-list</elt><elt>&amp;key</elt><elt>exclude</elt><elt>(exclude nil)</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="attribute">the attribute to filter on</arg> <arg arg="values-list">the numeric values to filter on</arg> <arg arg="exclude">if set, exclude the given values</arg> <return>client</return> <short>Sets the results to be filtered on the given attribute.</short><break/> <pre>
+ [0, 450] both 0 and 450 id's will be found.</documentation-string></function-definition><function-definition id="cl-sphinx-search__fun__set-filter" name="set-filter" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>attribute</elt><elt>values-list</elt><elt>&amp;key</elt><elt>exclude</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="attribute">the attribute to filter on</arg> <arg arg="values-list">the numeric values to filter on</arg> <arg arg="exclude">if set, exclude the given values</arg> <return>client</return> <short>Sets the results to be filtered on the given attribute.</short><break/> <pre>
(set-filter client "filter_attr" '(0 2 4 34 55 77))
(set-filter client "other_attr" '(8 4 2 11) :exclude t) </pre><break/>
Sets the results to be filtered on the given attribute. Only
@@ -132,13 +132,13 @@
the anchor point, use something like:<break/> <pre>
(set-filter-float-range sph "@geodist" 0 5000) </pre><break/>
This will filter the results to be closer than 5 km from the anchor
- point.<break/> <see id="cl-sphinx-search__fun__set-filter">set-filter</see> <see id="cl-sphinx-search__fun__set-filter-range">set-filter-range</see> <see id="cl-sphinx-search__fun__set-filter-float-range">set-filter-float-range</see> <see id="cl-sphinx-search__fun__set-geo-anchor">set-geo-anchor</see> <see id="cl-sphinx-search__fun__reset-filters">reset-filters</see></documentation-string></function-definition></external-symbols><internal-symbols><variable-definition id="cl-sphinx-search__variable__+sph-match-extended+" name="+sph-match-extended+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___pack-overrides" name="%pack-overrides" package="cl-sphinx-search"><lambda-list><elt>overrides</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun___socket" name="%socket" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun___port" name="%port" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__sort-mode" name="sort-mode" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-sort-expr+" name="+sph-sort-expr+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___set-filter-range" name="%set-filter-range" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>type</elt><elt>attr</elt><elt>min</elt><elt>max</elt><elt>&amp;key</elt><elt>(exclude nil)</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__select" name="select" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-match-any+" name="+sph-match-any+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__group-by" name="group-by" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-attr-bool+" name="+sph-attr-bool+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-sort-functions+" name="+sph-sort-functions+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+searchd-command-search+" name="+searchd-command-search+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___parse-response" name="%parse-response" package="cl-sphinx-search"><lambda-list><elt>response</elt><elt>n-requests</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__max-matches" name="max-matches" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><class-definition id="cl-sphinx-search__class__sphinx-client" name="sphinx-client" package="cl-sphinx-search"><cpl><superclass status="EXTERNAL" name="standard-object" package="common-lisp"/><superclass status="INTERNAL" name="slot-object" package="sb-pcl"/><superclass status="EXTERNAL" name="t" package="common-lisp"/></cpl><subclasses/><documentation-string><short>The sphinx-search class.</short><break/> <pre>
+ point.<break/> <see id="cl-sphinx-search__fun__set-filter">set-filter</see> <see id="cl-sphinx-search__fun__set-filter-range">set-filter-range</see> <see id="cl-sphinx-search__fun__set-filter-float-range">set-filter-float-range</see> <see id="cl-sphinx-search__fun__set-geo-anchor">set-geo-anchor</see> <see id="cl-sphinx-search__fun__reset-filters">reset-filters</see></documentation-string></function-definition></external-symbols><internal-symbols><variable-definition id="cl-sphinx-search__variable__+sph-match-extended+" name="+sph-match-extended+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___pack-overrides" name="%pack-overrides" package="cl-sphinx-search"><lambda-list><elt>overrides</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun___socket" name="%socket" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun___port" name="%port" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__sort-mode" name="sort-mode" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-sort-expr+" name="+sph-sort-expr+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___set-filter-range" name="%set-filter-range" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>type</elt><elt>attr</elt><elt>min</elt><elt>max</elt><elt>&amp;key</elt><elt>exclude</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__select" name="select" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-match-any+" name="+sph-match-any+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__group-by" name="group-by" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-attr-bool+" name="+sph-attr-bool+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-sort-functions+" name="+sph-sort-functions+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+searchd-command-search+" name="+searchd-command-search+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___parse-response" name="%parse-response" package="cl-sphinx-search"><lambda-list><elt>response</elt><elt>n-requests</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__max-matches" name="max-matches" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><class-definition id="cl-sphinx-search__class__sphinx-client" name="sphinx-client" package="cl-sphinx-search"><cpl><superclass status="EXTERNAL" name="standard-object" package="common-lisp"/><superclass status="INTERNAL" name="slot-object" package="sb-pcl"/><superclass status="EXTERNAL" name="t" package="common-lisp"/></cpl><subclasses/><documentation-string><short>The sphinx-search class.</short><break/> <pre>
(let ((sph (make-instance 'sphinx-client :host "localhost" :port 3315)))
(add-query sph "test")
(run-queries sph)) </pre><break/>
The interface to the search daemon goes through this class.<break/>
Set options and settings of the search to be performed on an object
- of this class, and then have it perform one search by calling <fun id="cl-sphinx-search__fun__query">query</fun>, or add a number of queries using <fun id="cl-sphinx-search__fun__add-query">add-query</fun> and then calling <fun id="cl-sphinx-search__fun__run-queries">run-queries</fun>.<break/>
+ of this class, and then have it perform one search by calling <fun id="cl-sphinx-search__fun__run-query">run-query</fun>, or add a number of queries using <fun id="cl-sphinx-search__fun__add-query">add-query</fun> and then calling <fun id="cl-sphinx-search__fun__run-queries">run-queries</fun>.<break/>
Either get a result hash or a list of result hashes back, or an error that can be retrieved with the <fun id="cl-sphinx-search__fun__last-error">last-error</fun> function.<break/> <see id="cl-sphinx-search__fun__set-server">set-server</see> <see id="cl-sphinx-search__fun__set-limits">set-limits</see> <see id="cl-sphinx-search__fun__set-id-range">set-id-range</see> <see id="cl-sphinx-search__fun__set-filter">set-filter</see> <see id="cl-sphinx-search__fun__set-filter-range">set-filter-range</see> <see id="cl-sphinx-search__fun__set-filter-float-range">set-filter-float-range</see> <see id="cl-sphinx-search__fun__set-geo-anchor">set-geo-anchor</see> <see id="cl-sphinx-search__fun__set-group-by">set-group-by</see> <see id="cl-sphinx-search__fun__set-group-distinct">set-group-distinct</see> <see id="cl-sphinx-search__fun__set-select">set-select</see> <see id="cl-sphinx-search__fun__reset-filters">reset-filters</see> <see id="cl-sphinx-search__fun__reset-group-by">reset-group-by</see> <see id="cl-sphinx-search__fun__reset-overrides">reset-overrides)</see> <see id="cl-sphinx-search__fun__last-warning">last-warning</see> <see id="cl-sphinx-search__fun__max-query-time">max-query-time</see></documentation-string></class-definition><function-definition id="cl-sphinx-search__fun___host" name="%host" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-sort-attr-desc+" name="+sph-sort-attr-desc+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___pack-float" name="%pack-float" package="cl-sphinx-search"><lambda-list><elt>float-value</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+searchd-command-update+" name="+searchd-command-update+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+searchd-command-keywords+" name="+searchd-command-keywords+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-sort-attr-asc+" name="+sph-sort-attr-asc+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-sort-time-segments+" name="+sph-sort-time-segments+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___encoding" name="%encoding" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-groupby-week+" name="+sph-groupby-week+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-filter-values+" name="+sph-filter-values+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-groupby-year+" name="+sph-groupby-year+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-attr-float+" name="+sph-attr-float+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__geo-anchor" name="geo-anchor" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+searchd-command-excerpt+" name="+searchd-command-excerpt+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-attr-multi+" name="+sph-attr-multi+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___pack-hash" name="%pack-hash" package="cl-sphinx-search"><lambda-list><elt>hash-table</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__group-sort" name="group-sort" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-rank-bm25+" name="+sph-rank-bm25+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-match-all+" name="+sph-match-all+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-attr-bigint+" name="+sph-attr-bigint+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-rank-proximity-bm25+" name="+sph-rank-proximity-bm25+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable___response-length_" name="*response-length*" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-attr-ordinal+" name="+sph-attr-ordinal+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__retry-count" name="retry-count" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__limit" name="limit" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__cutoff" name="cutoff" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__retry-delay" name="retry-delay" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-attr-integer+" name="+sph-attr-integer+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__max-id" name="max-id" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+searchd-ok+" name="+searchd-ok+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___send" name="%send" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>data</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-attr-types+" name="+sph-attr-types+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___get-fields" name="%get-fields" package="cl-sphinx-search"><lambda-list><elt>response</elt><elt>start</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+searchd-retry+" name="+searchd-retry+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-attr-none+" name="+sph-attr-none+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-attr-timestamp+" name="+sph-attr-timestamp+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__min-id" name="min-id" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__group-function" name="group-function" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun___read-from" name="%read-from" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>size</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__match-mode" name="match-mode" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+searchd-warning+" name="+searchd-warning+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+ver-command-excerpt+" name="+ver-command-excerpt+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-match-boolean+" name="+sph-match-boolean+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__status" name="status" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-groupby-day+" name="+sph-groupby-day+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___path" name="%path" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun___pack-list-signed-quads" name="%pack-list-signed-quads" package="cl-sphinx-search"><lambda-list><elt>values-list</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__field-weights" name="field-weights" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__filters" name="filters" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+ver-command-update+" name="+ver-command-update+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__group-distinct" name="group-distinct" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun___get-response-status" name="%get-response-status" package="cl-sphinx-search"><lambda-list><elt>response</elt><elt>start</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-rank-none+" name="+sph-rank-none+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-groupby-attr+" name="+sph-groupby-attr+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-groupby-month+" name="+sph-groupby-month+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___get-matches" name="%get-matches" package="cl-sphinx-search"><lambda-list><elt>response</elt><elt>attribute-names</elt><elt>attributes</elt><elt>start</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+ver-command-search+" name="+ver-command-search+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___pack-filters" name="%pack-filters" package="cl-sphinx-search"><lambda-list><elt>filters</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__offset" name="offset" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><macro-definition id="cl-sphinx-search__fun__define-constant" name="define-constant" package="cl-sphinx-search"><lambda-list><elt>name</elt><elt>value</elt><elt>&amp;optional</elt><elt>doc</elt></lambda-list></macro-definition><function-definition id="cl-sphinx-search__fun__overrides" name="overrides" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun___get-response" name="%get-response" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>&amp;key</elt><elt>client-version</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+ver-command-keywords+" name="+ver-command-keywords+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-match-extended2+" name="+sph-match-extended2+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__sort-by" name="sort-by" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-filter-floatrange+" name="+sph-filter-floatrange+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___connect" name="%connect" package="cl-sphinx-search"><lambda-list><elt>client</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-rank-wordcount+" name="+sph-rank-wordcount+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-groupby-attrpair+" name="+sph-groupby-attrpair+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__reqs" name="reqs" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><function-definition id="cl-sphinx-search__fun__weights" name="weights" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><macro-definition id="cl-sphinx-search__fun__adv-p" name="adv-p" package="cl-sphinx-search"><lambda-list><elt>n</elt></lambda-list></macro-definition><variable-definition id="cl-sphinx-search__variable__+searchd-command-persist+" name="+searchd-command-persist+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__rank-mode" name="rank-mode" package="cl-sphinx-search"><lambda-list><elt>object</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-match-fullscan+" name="+sph-match-fullscan+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun___get-attributes" name="%get-attributes" package="cl-sphinx-search"><lambda-list><elt>response</elt><elt>start</elt></lambda-list></function-definition><variable-definition id="cl-sphinx-search__variable__+sph-sort-extended+" name="+sph-sort-extended+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-match-phrase+" name="+sph-match-phrase+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+sph-filter-range+" name="+sph-filter-range+" package="cl-sphinx-search"/><variable-definition id="cl-sphinx-search__variable__+searchd-error+" name="+searchd-error+" package="cl-sphinx-search"/><function-definition id="cl-sphinx-search__fun__set-override" name="set-override" package="cl-sphinx-search"><lambda-list><elt>client</elt><elt>attribute</elt><elt>type</elt><elt>values</elt></lambda-list><documentation-string><arg arg="client">a <class id="cl-sphinx-search__class__sphinx-client">sphinx-client</class></arg> <arg arg="attribute">the attribute to override</arg> <arg arg="type">the attribute type as defined in Sphinx config</arg> <arg arg="values">an alist mapping document IDs to attribute values</arg> <return>client</return> <short>Set attribute values overrides.</short><break/>
There can be only one override per attribute.<break/> <code>values</code> must be an alist that maps document IDs to attribute
values.<break/> <pre>
View
2 doc/index.html
@@ -5,4 +5,4 @@
Index of packages:
</div><table cellspacing="0" cellpadding="0"><tr><td valign="top" width="60%"><div class="padded"><h2 class="page-title"><a href="pages/cl-sphinx-search.html">
Package
- cl-sphinx-search</a></h2><div style="left: 100px"><div class="indent">This package provides an interface to the search daemon (<i>searchd</i>) for <a href="http://www.sphinxsearch.com/">Sphinx</a>.<br><br> <br><br> <br><br> <br><br> <br><br> </div><div class="indent"><p><i>About this package:</i></p><ul><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e0">About Sphinx</a></li><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e1">Synopsis</a></li><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e2">One class</a></li><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e3">Methods</a></li><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e4">Acknowledgements</a></li></ul></div></div></div></td><td valign="top"><h3><a name="index"></a>Exported Symbol Index</h3><table cellspacing="0" cellpadding="0"><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__last-error.html"><tt>last-error</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__last-warning.html"><tt>last-warning</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__max-query-time.html"><tt>max-query-time</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__query.html"><tt>query</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__reset-filters.html"><tt>reset-filters</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__reset-group-by.html"><tt>reset-group-by</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__reset-overrides.html"><tt>reset-overrides</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-filter.html"><tt>set-filter</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-filter-float-range.html"><tt>set-filter-float-range</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-filter-range.html"><tt>set-filter-range</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-geo-anchor.html"><tt>set-geo-anchor</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-group-by.html"><tt>set-group-by</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-group-distinct.html"><tt>set-group-distinct</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-id-range.html"><tt>set-id-range</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-limits.html"><tt>set-limits</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-select.html"><tt>set-select</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-server.html"><tt>set-server</tt></a>, function</td></tr></table></td></tr></table></div></body></html>
+ cl-sphinx-search</a></h2><div style="left: 100px"><div class="indent">This package provides an interface to the search daemon (<i>searchd</i>) for <a href="http://www.sphinxsearch.com/">Sphinx</a>.<br><br> <br><br> <br><br> <br><br> <br><br> </div><div class="indent"><p><i>About this package:</i></p><ul><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e0">About Sphinx</a></li><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e1">Synopsis</a></li><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e2">One class</a></li><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e3">Methods</a></li><li><a href="pages/cl-sphinx-search.html#d0d0e0e0e0e4">Acknowledgements</a></li></ul></div></div></div></td><td valign="top"><h3><a name="index"></a>Exported Symbol Index</h3><table cellspacing="0" cellpadding="0"><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__last-error.html"><tt>last-error</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__last-warning.html"><tt>last-warning</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__max-query-time.html"><tt>max-query-time</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__reset-filters.html"><tt>reset-filters</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__reset-group-by.html"><tt>reset-group-by</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__reset-overrides.html"><tt>reset-overrides</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__run-query.html"><tt>run-query</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-filter.html"><tt>set-filter</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-filter-float-range.html"><tt>set-filter-float-range</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-filter-range.html"><tt>set-filter-range</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-geo-anchor.html"><tt>set-geo-anchor</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-group-by.html"><tt>set-group-by</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-group-distinct.html"><tt>set-group-distinct</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-id-range.html"><tt>set-id-range</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-limits.html"><tt>set-limits</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-select.html"><tt>set-select</tt></a>, function</td></tr><tr><td valign="top" align="right" nowrap><span class="nonlink"><tt><span style="color: #777777">cl-sphinx-search:</span></tt></span></td><td valign="top"><a href="pages/cl-sphinx-search__fun__set-server.html"><tt>set-server</tt></a>, function</td></tr></table></td></tr></table></div></body></html>
View
6 doc/pages/cl-sphinx-search.html
@@ -22,12 +22,12 @@
There is just one class:<br><br> <div class="def"><a href="cl-sphinx-search__class__sphinx-client.html">
Class
sphinx-client</a></div><div style="margin-left: 3em">The sphinx-search class. <a href="cl-sphinx-search__class__sphinx-client.html#details">...</a></div><br> <h2><a name="d0d0e0e0e0e3"></a>Methods</h2>
- Setting options/parameters:<br><br> <div class="def"><a href="cl-sphinx-search__fun__set-server.html">Function set-server (client &amp;key host port path (host localhost) (port 3312))</a></div><div style="margin-left: 3em">Set the server host:port or path to connect to. <a href="cl-sphinx-search__fun__set-server.html#details">...</a></div><br> <div class="def"><a href="cl-sphinx-search__fun__set-limits.html">Function set-limits (client &amp;key offset limit max cutoff (offset 0) (max 1000))</a></div><div style="margin-left: 3em">Set the offset, limit, cutoff and max matches to return. <a href="cl-sphinx-search__fun__set-limits.html#details">...</a></div><br><br><br>
- Running queries:<br><br> <div class="def"><a href="cl-sphinx-search__fun__query.html">Function query (client query &amp;key index comment (index *) (comment ))</a></div><div style="margin-left: 3em">Run a query through <tt>searchd</tt>. <a href="cl-sphinx-search__fun__query.html#details">...</a></div><br> <div class="def"><a href="cl-sphinx-search__fun__add-query.html">Function add-query (client query &amp;key index comment (index *) (comment ))</a></div><div style="margin-left: 3em">Add a query to a batch request. <a href="cl-sphinx-search__fun__add-query.html#details">...</a></div><br> <div class="def"><a href="cl-sphinx-search__fun__run-queries.html">Function run-queries (client)</a></div><div style="margin-left: 3em">Run the queries added with <tt>add-query</tt> through <tt>searchd</tt>. <a href="cl-sphinx-search__fun__run-queries.html#details">...</a></div><br><br><br> <h2><a name="d0d0e0e0e0e4"></a>Acknowledgements</h2>
+ Setting options/parameters:<br><br> <div class="def"><a href="cl-sphinx-search__fun__set-server.html">Function set-server (client &amp;key host port path)</a></div><div style="margin-left: 3em">Set the server host:port or path to connect to. <a href="cl-sphinx-search__fun__set-server.html#details">...</a></div><br> <div class="def"><a href="cl-sphinx-search__fun__set-limits.html">Function set-limits (client &amp;key offset limit max cutoff)</a></div><div style="margin-left: 3em">Set the offset, limit, cutoff and max matches to return. <a href="cl-sphinx-search__fun__set-limits.html#details">...</a></div><br><br><br>
+ Running queries:<br><br> <div class="def"><a href="cl-sphinx-search__fun__run-query.html">Function run-query (client query &amp;key index comment)</a></div><div style="margin-left: 3em">Run a query through <tt>searchd</tt>. <a href="cl-sphinx-search__fun__run-query.html#details">...</a></div><br> <div class="def"><a href="cl-sphinx-search__fun__add-query.html">Function add-query (client query &amp;key index comment)</a></div><div style="margin-left: 3em">Add a query to a batch request. <a href="cl-sphinx-search__fun__add-query.html#details">...</a></div><br> <div class="def"><a href="cl-sphinx-search__fun__run-queries.html">Function run-queries (client)</a></div><div style="margin-left: 3em">Run the queries added with <tt>add-query</tt> through <tt>searchd</tt>. <a href="cl-sphinx-search__fun__run-queries.html#details">...</a></div><br><br><br> <h2><a name="d0d0e0e0e0e4"></a>Acknowledgements</h2>
This port is based on Sphinx.pm version 0.22 (deployed to CPAN <a href="http://search.cpan.org/~jjschutz/Sphinx-Search-0.22/">here</a>), which
itself says:<br><br> <pre>
This module is based on Sphinx.pm (not deployed to CPAN) for
Sphinx version 0.9.7-rc1, by Len Kranendonk, which was in turn
based on the Sphinx PHP API. </pre><br><br>
Also used was the api for python which was supplied with the source code download for Sphinx Search v0.9.9-rc2, in the <tt>api/</tt> directory.<br><br> <b>Documentation</b><br><br> This documentation was generated by <a href="http://www.lichteblau.com/atdoc/doc/">atdoc</a>,
- the documentation generation system written by David Lichteblau.<br><br> </div></td><td valign="top"><h3><a name="index"></a>Exported Symbol Index</h3><table cellspacing="0" cellpadding="0"><tr><td valign="top"><a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__last-error.html"><tt>last-error</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__last-warning.html"><tt>last-warning</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__max-query-time.html"><tt>max-query-time</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__query.html"><tt>query</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__reset-filters.html"><tt>reset-filters</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__reset-group-by.html"><tt>reset-group-by</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__reset-overrides.html"><tt>reset-overrides</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-filter.html"><tt>set-filter</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-filter-float-range.html"><tt>set-filter-float-range</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-filter-range.html"><tt>set-filter-range</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-geo-anchor.html"><tt>set-geo-anchor</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-group-by.html"><tt>set-group-by</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-group-distinct.html"><tt>set-group-distinct</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-id-range.html"><tt>set-id-range</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-limits.html"><tt>set-limits</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-select.html"><tt>set-select</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-server.html"><tt>set-server</tt></a>, function</td></tr></table></td></tr></table></div></body></html>
+ the documentation generation system written by David Lichteblau.<br><br> </div></td><td valign="top"><h3><a name="index"></a>Exported Symbol Index</h3><table cellspacing="0" cellpadding="0"><tr><td valign="top"><a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__last-error.html"><tt>last-error</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__last-warning.html"><tt>last-warning</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__max-query-time.html"><tt>max-query-time</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__reset-filters.html"><tt>reset-filters</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__reset-group-by.html"><tt>reset-group-by</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__reset-overrides.html"><tt>reset-overrides</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__run-query.html"><tt>run-query</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-filter.html"><tt>set-filter</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-filter-float-range.html"><tt>set-filter-float-range</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-filter-range.html"><tt>set-filter-range</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-geo-anchor.html"><tt>set-geo-anchor</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-group-by.html"><tt>set-group-by</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-group-distinct.html"><tt>set-group-distinct</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-id-range.html"><tt>set-id-range</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-limits.html"><tt>set-limits</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-select.html"><tt>set-select</tt></a>, function</td></tr><tr><td valign="top"><a href="cl-sphinx-search__fun__set-server.html"><tt>set-server</tt></a>, function</td></tr></table></td></tr></table></div></body></html>
View
4 doc/pages/cl-sphinx-search__class__sphinx-client.html
@@ -12,7 +12,7 @@
(run-queries sph)) </pre><br><br>
The interface to the search daemon goes through this class.<br><br>
Set options and settings of the search to be performed on an object
- of this class, and then have it perform one search by calling <a href="cl-sphinx-search__fun__query.html"><tt>query</tt></a>, or add a number of queries using <a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a> and then calling <a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a>.<br><br>
+ of this class, and then have it perform one search by calling <a href="cl-sphinx-search__fun__run-query.html"><tt>run-query</tt></a>, or add a number of queries using <a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a> and then calling <a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a>.<br><br>
Either get a result hash or a list of result hashes back, or an error that can be retrieved with the <a href="cl-sphinx-search__fun__last-error.html"><tt>last-error</tt></a> function.<br><br> </div></div></td><td valign="top" width="5%">
 
- </td><td valign="top" width="35%"><h3>See also</h3><div class="indent"><table cellspacing="0" cellpadding="0"><tr><td><a href="cl-sphinx-search__fun__query.html"><tt>query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__last-error.html"><tt>last-error</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-server.html"><tt>set-server</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-limits.html"><tt>set-limits</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-id-range.html"><tt>set-id-range</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-filter.html"><tt>set-filter</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-filter-range.html"><tt>set-filter-range</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-filter-float-range.html"><tt>set-filter-float-range</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-geo-anchor.html"><tt>set-geo-anchor</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-group-by.html"><tt>set-group-by</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-group-distinct.html"><tt>set-group-distinct</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-select.html"><tt>set-select</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__reset-filters.html"><tt>reset-filters</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__reset-group-by.html"><tt>reset-group-by</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__reset-overrides.html"><tt>reset-overrides)</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__last-warning.html"><tt>last-warning</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__max-query-time.html"><tt>max-query-time</tt></a></td></tr></table></div></td></tr></table></div></body></html>
+ </td><td valign="top" width="35%"><h3>See also</h3><div class="indent"><table cellspacing="0" cellpadding="0"><tr><td><a href="cl-sphinx-search__fun__run-query.html"><tt>run-query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__last-error.html"><tt>last-error</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-server.html"><tt>set-server</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-limits.html"><tt>set-limits</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-id-range.html"><tt>set-id-range</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-filter.html"><tt>set-filter</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-filter-range.html"><tt>set-filter-range</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-filter-float-range.html"><tt>set-filter-float-range</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-geo-anchor.html"><tt>set-geo-anchor</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-group-by.html"><tt>set-group-by</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-group-distinct.html"><tt>set-group-distinct</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__set-select.html"><tt>set-select</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__reset-filters.html"><tt>reset-filters</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__reset-group-by.html"><tt>reset-group-by</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__reset-overrides.html"><tt>reset-overrides)</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__last-warning.html"><tt>last-warning</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__max-query-time.html"><tt>max-query-time</tt></a></td></tr></table></div></td></tr></table></div></body></html>
View
10 doc/pages/cl-sphinx-search__fun___pack-array-signed-quads.html
@@ -1,10 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Function %pack-array-signed-quads</title><link rel="stylesheet" type="text/css" href="../index.css"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body><div id="header"><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="center">
-   
- <b> Common Lisp Sphinx Search API</b></td><td valign="center" align="right"><b>API documentation</b></td></tr></table></div><div class="main"><div class="padded"><p class="noindent">
- Package:
- <a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
- Function
- %pack-array-signed-quads</h2></div><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>%pack-array-signed-quads</tt> (<b>values-list</b>)</div><p style="color: red; font-weight: bold">
- No documentation string. Possibly unimplemented or incomplete.
- </p></div></div></body></html>
View
2 doc/pages/cl-sphinx-search__fun___set-filter-range.html
@@ -5,6 +5,6 @@
Package:
<a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
Function
- %set-filter-range</h2></div><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>%set-filter-range</tt> (<b>client</b> <b>type</b> <b>attr</b> <b>min</b> <b>max</b> <b>&amp;key</b> <b>(exclude nil)</b>)</div><p style="color: red; font-weight: bold">
+ %set-filter-range</h2></div><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>%set-filter-range</tt> (<b>client</b> <b>type</b> <b>attr</b> <b>min</b> <b>max</b> <b>&amp;key</b> <b>exclude</b>)</div><p style="color: red; font-weight: bold">
No documentation string. Possibly unimplemented or incomplete.
</p></div></div></body></html>
View
4 doc/pages/cl-sphinx-search__fun__add-query.html
@@ -5,7 +5,7 @@
Package:
<a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
Function
- add-query</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>add-query</tt> (<b>client</b> <b>query</b> <b>&amp;key</b> <b>index</b> <b>comment</b> <b>(index *)</b> <b>(comment )</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>query</tt> -- the query to run through <tt>searchd</tt></li><li><tt>index</tt> -- the index to use; defaults to &quot;*&quot;</li><li><tt>comment</tt> -- a comment describing this query; default none</li></ul></div><h3>Return Value</h3><div class="indent">length of query queue</div><h3>Details<a name="details"></a></h3><div class="indent"> Add a query to a batch request.<br><br> <pre>
+ add-query</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>add-query</tt> (<b>client</b> <b>query</b> <b>&amp;key</b> <b>index</b> <b>comment</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>query</tt> -- the query to run through <tt>searchd</tt></li><li><tt>index</tt> -- the index to use; defaults to &quot;*&quot;</li><li><tt>comment</tt> -- a comment describing this query; default none</li></ul></div><h3>Return Value</h3><div class="indent">length of query queue</div><h3>Details<a name="details"></a></h3><div class="indent"> Add a query to a batch request.<br><br> <pre>
(add-query client &quot;test&quot;)
(add-query client &quot;word&quot; :index &quot;*&quot;)
(run-queries client) </pre><br><br>
@@ -17,4 +17,4 @@
It returns the new length of the query queue, which is also the index
of the newly added query in the queue.<br><br> <br><br></div></div></td><td valign="top" width="5%">
 
- </td><td valign="top" width="35%"><h3>See also</h3><div class="indent"><table cellspacing="0" cellpadding="0"><tr><td><a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__query.html"><tt>query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a></td></tr></table></div></td></tr></table></div></body></html>
+ </td><td valign="top" width="35%"><h3>See also</h3><div class="indent"><table cellspacing="0" cellpadding="0"><tr><td><a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__run-query.html"><tt>run-query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a></td></tr></table></div></td></tr></table></div></body></html>
View
10 doc/pages/cl-sphinx-search__fun__anchor.html
@@ -1,10 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Function anchor</title><link rel="stylesheet" type="text/css" href="../index.css"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body><div id="header"><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="center">
-   
- <b> Common Lisp Sphinx Search API</b></td><td valign="center" align="right"><b>API documentation</b></td></tr></table></div><div class="main"><div class="padded"><p class="noindent">
- Package:
- <a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
- Function
- anchor</h2></div><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>anchor</tt> (<b>object</b>)</div><p style="color: red; font-weight: bold">
- No documentation string. Possibly unimplemented or incomplete.
- </p></div></div></body></html>
View
10 doc/pages/cl-sphinx-search__fun__mode.html
@@ -1,10 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Function mode</title><link rel="stylesheet" type="text/css" href="../index.css"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body><div id="header"><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="center">
-   
- <b> Common Lisp Sphinx Search API</b></td><td valign="center" align="right"><b>API documentation</b></td></tr></table></div><div class="main"><div class="padded"><p class="noindent">
- Package:
- <a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
- Function
- mode</h2></div><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>mode</tt> (<b>object</b>)</div><p style="color: red; font-weight: bold">
- No documentation string. Possibly unimplemented or incomplete.
- </p></div></div></body></html>
View
10 doc/pages/cl-sphinx-search__fun__ranker.html
@@ -1,10 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Function ranker</title><link rel="stylesheet" type="text/css" href="../index.css"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body><div id="header"><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="center">
-   
- <b> Common Lisp Sphinx Search API</b></td><td valign="center" align="right"><b>API documentation</b></td></tr></table></div><div class="main"><div class="padded"><p class="noindent">
- Package:
- <a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
- Function
- ranker</h2></div><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>ranker</tt> (<b>object</b>)</div><p style="color: red; font-weight: bold">
- No documentation string. Possibly unimplemented or incomplete.
- </p></div></div></body></html>
View
2 doc/pages/cl-sphinx-search__fun__run-queries.html
@@ -12,4 +12,4 @@
It returns a list of hashes containing the result of each query. Each hash
has the following keys: <dl><dt>attributes</dt><dd> : a hash-table containing attributes</dd><dt>fields</dt><dd> : a list of fields</dd><dt>matches</dt><dd> : a hash-table containing the matches</dd><dt>status</dt><dd> : the status returned by <tt>searchd</tt></dd><dt>status-message</dt><dd> : the status message returned by <tt>searchd</tt></dd><dt>time</dt><dd> : the time <tt>searchd</tt> took for the query</dd><dt>total</dt><dd> : the total matches returned</dd><dt>total-found</dt><dd> : the total number of matches found</dd><dt>words</dt><dd> : a hash-table containing the matching words with their statistics</dd></dl><br style="clear: both;"><br><br> <br><br></div></div></td><td valign="top" width="5%">
 
- </td><td valign="top" width="35%"><h3>See also</h3><div class="indent"><table cellspacing="0" cellpadding="0"><tr><td><a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__query.html"><tt>query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a></td></tr></table></div></td></tr></table></div></body></html>
+ </td><td valign="top" width="35%"><h3>See also</h3><div class="indent"><table cellspacing="0" cellpadding="0"><tr><td><a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__run-query.html"><tt>run-query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a></td></tr></table></div></td></tr></table></div></body></html>
View
6 doc/pages/cl-sphinx-search__fun__query.html → ...ges/cl-sphinx-search__fun__run-query.html
@@ -1,12 +1,12 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Function query</title><link rel="stylesheet" type="text/css" href="../index.css"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body><div id="header"><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="center">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Function run-query</title><link rel="stylesheet" type="text/css" href="../index.css"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body><div id="header"><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="center">
  
<b> Common Lisp Sphinx Search API</b></td><td valign="center" align="right"><b>API documentation</b></td></tr></table></div><div class="main"><div class="padded"><p class="noindent">
Package:
<a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
Function
- query</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>query</tt> (<b>client</b> <b>query</b> <b>&amp;key</b> <b>index</b> <b>comment</b> <b>(index *)</b> <b>(comment )</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>query</tt> -- the query to run through <tt>searchd</tt></li><li><tt>index</tt> -- the index to use; defaults to &quot;*&quot;</li><li><tt>comment</tt> -- a comment describing this query; default none</li></ul></div><h3>Return Value</h3><div class="indent">nil or a hash containing the query results</div><h3>Details<a name="details"></a></h3><div class="indent"> Run a query through <tt>searchd</tt>.<br><br> <pre>
- (query client &quot;test&quot;) </pre><br><br> Query <tt>searchd</tt>. This method runs a single query through <tt>searchd</tt>.<br><br>
+ run-query</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>run-query</tt> (<b>client</b> <b>query</b> <b>&amp;key</b> <b>index</b> <b>comment</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>query</tt> -- the query to run through <tt>searchd</tt></li><li><tt>index</tt> -- the index to use; defaults to &quot;*&quot;</li><li><tt>comment</tt> -- a comment describing this query; default none</li></ul></div><h3>Return Value</h3><div class="indent">nil or a hash containing the query results</div><h3>Details<a name="details"></a></h3><div class="indent"> Run a query through <tt>searchd</tt>.<br><br> <pre>
+ (run-query client &quot;test&quot;) </pre><br><br> Query <tt>searchd</tt>. This method runs a single query through <tt>searchd</tt>.<br><br>
It returns the results in a hash with the following keys: <dl><dt>attributes</dt><dd> : a hash-table containing attributes</dd><dt>fields</dt><dd> : a list of fields</dd><dt>matches</dt><dd> : a hash-table containing the matches</dd><dt>status</dt><dd> : the status returned by <tt>searchd</tt></dd><dt>status-message</dt><dd> : the status message returned by <tt>searchd</tt></dd><dt>time</dt><dd> : the time <tt>searchd</tt> took for the query</dd><dt>total</dt><dd> : the total matches returned</dd><dt>total-found</dt><dd> : the total number of matches found</dd><dt>words</dt><dd> : a hash-table containing the matching words with their statistics</dd></dl><br style="clear: both;"><br><br> <br><br></div></div></td><td valign="top" width="5%">
 
</td><td valign="top" width="35%"><h3>See also</h3><div class="indent"><table cellspacing="0" cellpadding="0"><tr><td><a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__add-query.html"><tt>add-query</tt></a></td></tr><tr><td><a href="cl-sphinx-search__fun__run-queries.html"><tt>run-queries</tt></a></td></tr></table></div></td></tr></table></div></body></html>
View
2 doc/pages/cl-sphinx-search__fun__set-filter-float-range.html
@@ -5,7 +5,7 @@
Package:
<a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
Function
- set-filter-float-range</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-filter-float-range</tt> (<b>client</b> <b>attribute</b> <b>min</b> <b>max</b> <b>&amp;key</b> <b>exclude</b> <b>(exclude nil)</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>attribute</tt> -- the attribute to filter on</li><li><tt>min</tt> -- start of the range to filter on</li><li><tt>max</tt> -- end of the range to filter on</li><li><tt>exclude</tt> -- if set, exclude the given range</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Sets the results to be filtered on the given range.<br><br> <pre>
+ set-filter-float-range</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-filter-float-range</tt> (<b>client</b> <b>attribute</b> <b>min</b> <b>max</b> <b>&amp;key</b> <b>exclude</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>attribute</tt> -- the attribute to filter on</li><li><tt>min</tt> -- start of the range to filter on</li><li><tt>max</tt> -- end of the range to filter on</li><li><tt>exclude</tt> -- if set, exclude the given range</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Sets the results to be filtered on the given range.<br><br> <pre>
(set-filter-float-range client &quot;filter_attr&quot; 45.231 99)
(set-filter-float-range client &quot;other_attr&quot; 1.32 55.0031 :exclude t) </pre><br><br>
Sets the results to be filtered on a range of values for the given
View
2 doc/pages/cl-sphinx-search__fun__set-filter-range.html
@@ -5,7 +5,7 @@
Package:
<a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
Function
- set-filter-range</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-filter-range</tt> (<b>client</b> <b>attribute</b> <b>min</b> <b>max</b> <b>&amp;key</b> <b>exclude</b> <b>(exclude nil)</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>attribute</tt> -- the attribute to filter on</li><li><tt>min</tt> -- start of the range to filter on</li><li><tt>max</tt> -- end of the range to filter on</li><li><tt>exclude</tt> -- if set, exclude the given range</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Sets the results to be filtered on the given range.<br><br> <pre>
+ set-filter-range</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-filter-range</tt> (<b>client</b> <b>attribute</b> <b>min</b> <b>max</b> <b>&amp;key</b> <b>exclude</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>attribute</tt> -- the attribute to filter on</li><li><tt>min</tt> -- start of the range to filter on</li><li><tt>max</tt> -- end of the range to filter on</li><li><tt>exclude</tt> -- if set, exclude the given range</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Sets the results to be filtered on the given range.<br><br> <pre>
(set-filter-range client &quot;filter_attr&quot; 45 99)
(set-filter-range client &quot;other_attr&quot; 2 8 :exclude t) </pre><br><br>
Sets the results to be filtered on a range of values for the given
View
2 doc/pages/cl-sphinx-search__fun__set-filter.html
@@ -5,7 +5,7 @@
Package:
<a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
Function
- set-filter</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-filter</tt> (<b>client</b> <b>attribute</b> <b>values-list</b> <b>&amp;key</b> <b>exclude</b> <b>(exclude nil)</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>attribute</tt> -- the attribute to filter on</li><li><tt>values-list</tt> -- the numeric values to filter on</li><li><tt>exclude</tt> -- if set, exclude the given values</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Sets the results to be filtered on the given attribute.<br><br> <pre>
+ set-filter</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-filter</tt> (<b>client</b> <b>attribute</b> <b>values-list</b> <b>&amp;key</b> <b>exclude</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>attribute</tt> -- the attribute to filter on</li><li><tt>values-list</tt> -- the numeric values to filter on</li><li><tt>exclude</tt> -- if set, exclude the given values</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Sets the results to be filtered on the given attribute.<br><br> <pre>
(set-filter client &quot;filter_attr&quot; '(0 2 4 34 55 77))
(set-filter client &quot;other_attr&quot; '(8 4 2 11) :exclude t) </pre><br><br>
Sets the results to be filtered on the given attribute. Only
View
2 doc/pages/cl-sphinx-search__fun__set-limits.html
@@ -5,7 +5,7 @@
Package:
<a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
Function
- set-limits</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-limits</tt> (<b>client</b> <b>&amp;key</b> <b>offset</b> <b>limit</b> <b>max</b> <b>cutoff</b> <b>(offset 0)</b> <b>(max 1000)</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>offset</tt> -- the offset to start returning matches from</li><li><tt>limit</tt> -- how many matches to return starting from <tt>offset</tt></li><li><tt>max</tt> -- maximum number of matches to return</li><li><tt>cutoff</tt> -- the cutoff to stop searching at</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Set the offset, limit, cutoff and max matches to return.<br><br> <pre>
+ set-limits</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-limits</tt> (<b>client</b> <b>&amp;key</b> <b>offset</b> <b>limit</b> <b>max</b> <b>cutoff</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>offset</tt> -- the offset to start returning matches from</li><li><tt>limit</tt> -- how many matches to return starting from <tt>offset</tt></li><li><tt>max</tt> -- maximum number of matches to return</li><li><tt>cutoff</tt> -- the cutoff to stop searching at</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Set the offset, limit, cutoff and max matches to return.<br><br> <pre>
(set-limits client :limit limit)
(set-limits client :offset offset :limit limit)
(set-limits client :offset offset :limit limit :max max-matches) </pre><br><br>
View
2 doc/pages/cl-sphinx-search__fun__set-server.html
@@ -5,7 +5,7 @@
Package:
<a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
Function
- set-server</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-server</tt> (<b>client</b> <b>&amp;key</b> <b>host</b> <b>port</b> <b>path</b> <b>(host localhost)</b> <b>(port 3312)</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>host</tt> -- the host to connect to when using an INET socket</li><li><tt>port</tt> -- the port to connect to when using an INET socket</li><li><tt>path</tt> -- the path to the unix domain socket when not using INET</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Set the server host:port or path to connect to.<br><br> <pre>
+ set-server</h2></div><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="top" width="60%"><div class="padded"><h3>Lambda List</h3><div class="indent"><tt>set-server</tt> (<b>client</b> <b>&amp;key</b> <b>host</b> <b>port</b> <b>path</b>)</div><h3>Arguments</h3><div class="indent"><ul><li><tt>client</tt> -- a <a href="cl-sphinx-search__class__sphinx-client.html"><tt>sphinx-client</tt></a></li><li><tt>host</tt> -- the host to connect to when using an INET socket</li><li><tt>port</tt> -- the port to connect to when using an INET socket</li><li><tt>path</tt> -- the path to the unix domain socket when not using INET</li></ul></div><h3>Return Value</h3><div class="indent">client</div><h3>Details<a name="details"></a></h3><div class="indent"> Set the server host:port or path to connect to.<br><br> <pre>
(set-server client :host host :port port)
(set-server client :path unix-path) </pre><br><br> In the first form, sets the <tt>host</tt> (string) and <tt>port</tt> (integer)
details for the searchd server using a network (INET) socket.<br><br> In the second form, where <tt>unix-path</tt> is a local filesystem path
View
10 doc/pages/cl-sphinx-search__variable__sph.html
@@ -1,10 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Variable sph</title><link rel="stylesheet" type="text/css" href="../index.css"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body><div id="header"><table cellspacing="0" cellpadding="0" width="100%"><tr><td valign="center">
-   
- <b> Common Lisp Sphinx Search API</b></td><td valign="center" align="right"><b>API documentation</b></td></tr></table></div><div class="main"><div class="padded"><p class="noindent">
- Package:
- <a href="cl-sphinx-search.html">cl-sphinx-search</a></p><h2 class="page-title">
- Variable
- sph</h2><p style="color: red; font-weight: bold">
- No documentation string. Possibly unimplemented or incomplete.
- </p></div></div></body></html>
View
4 package.lisp
@@ -8,7 +8,7 @@
(:use :cl :iolib.sockets :babel :cl-pack)
(:export #:set-server
#:set-limits
- #:query
+ #:run-query
#:add-query
#:run-queries
#:last-error
@@ -74,7 +74,7 @@
Running queries:
- @aboutfun{query}
+ @aboutfun{run-query}
@aboutfun{add-query}
@aboutfun{run-queries}

0 comments on commit 566117e

Please sign in to comment.
Something went wrong with that request. Please try again.