A newer version of this documentation is available.

View Latest

Understanding Queries

      Full Text Search allows queries to be performed on Full Text Indexes. Queries can be performed by means of the Couchbase Web Console, the Couchbase REST API, or the Couchbase SDK.

      Query-Specification Options

      Full Text Search allows a range of query options. These include:

      • Input-text and target-text can be analyzed: this transforms input-text into token-streams, according to different specified criteria, so allowing richer and more finely controlled forms of text-matching.

      • The fuzziness of a query can be specified, so that the scope of matches can be constrained to a particular level of exactitude. A high degree of fuzziness means that a large number of partial matches may be returned.

      • Multiple queries can be specified for simultaneous processing, with one given a higher boost than another; so ensuring that its results are returned at the top of the set.

      • Regular expressions and wildcards can be used in text-specification for search-input.

      • Compound queries can be designed, such that an appropriate conjunction or disjunction of the total result-set can be returned.

      All the above options, and others, are explained in detail on the page Query Types.

      For information on how to execute queries, see Performing Searches.

      Sorting Results

      The results returned from a Full Text Search can be sorted: by id, score, field, and more. Details are provided in Sorting Query Results.

      Query Response Objects

      Every Full Text Search query provides a response object. This contains the query-result; and consists of individual child-objects that respectively contain status, a request-copy, the number of hits (or matches) achieved, and (optionally) facets, which provide aggregation information.

      For full information, see Handling Response Objects.