Browse files

Document errors and warnings from Sphinx

  • Loading branch information...
1 parent ca79532 commit 33eed755b17853b80a405dcb43b2db18769c9baa @mtodd mtodd committed Nov 23, 2010
Showing with 19 additions and 0 deletions.
  1. +19 −0 ts/en/searching.textile
@@ -20,6 +20,7 @@ h2. Searching
* "Search Counts":#counts
* "Avoiding Nil Results":#nils
* "Automatic Wildcards":#star
+* "Errors":#errors
* "Advanced Options":#advanced
<h3 id="basic">Basic Searching</h3>
@@ -404,6 +405,24 @@ 'pancakes waffles', :star => true
# => becomes '*pancakes* *waffles*'
{% endhighlight %}
+<h3 id="errors">Errors</h3>
+At times, Sphinx will return no results, but sometimes that's because there was a problem with the actual query provided. When this happens, Sphinx includes the error message in the results.
+You can access errors with @error@ and test for errors with @error?@.
+If an error is encountered, ThinkingSphinx will log it and then raise a @ThinkingSphinx::SphinxError@ exception. You can tell ThinkingSphinx to ignore errors (though it will still log them) by passing in @:ignore_errors => true@ or setting the property in your index with @set_property :ignore_errors => true@.
+For example:
+{% highlight ruby %}
+r = '@doesntexist foo', :match_mode => :extended,
+ :ignore_errors => true
+r.error? # => true
+{% endhighlight %}
+Sphinx also issues warnings that you can test for with @warning?@ and inspect with @warning@. No exception is raised on warnings.
<h3 id="advanced">Advanced Options</h3>
Thinking Sphinx also accepts the following advanced Sphinx arguments:

0 comments on commit 33eed75

Please sign in to comment.