Couchbase Lite
Objective-C API for iOS and Mac OS
Properties | List of all members
CBLQuery(FullTextSearch) Category Reference

CBLQuery interface for full-text searches. More...

#import <CBLQuery+FullTextSearch.h>

Properties

NSString * fullTextQuery
 Query string for a full-text search; works only if the view's map function has triggered full- text indexing by emitting strings wrapped by CBLTextKey(). More...
 
BOOL fullTextSnippets
 If set to YES, the query will collect snippets of the text surrounding each match, available via the CBLFullTextQueryRow's -snippetWithWordStart:wordEnd: method. More...
 
BOOL fullTextRanking
 If YES (the default) the full-text query result rows will be sorted by (approximate) relevance. More...
 

Detailed Description

CBLQuery interface for full-text searches.

To use this, the view's map function must have emitted full-text strings as keys using the CBLTextKey() function.

Property Documentation

- (NSString*) fullTextQuery
readwriteatomiccopy

Query string for a full-text search; works only if the view's map function has triggered full- text indexing by emitting strings wrapped by CBLTextKey().

The query string syntax is described in http://sqlite.org/fts3.html#section_3 . The query rows produced by this search will be instances of CBLFullTextQueryRow. NOTE:** Full-text views have no keys, so the key-related query properties will be ignored. They also can't be reduced or grouped, so those properties are ignored too.

Extends class CBLQuery.

- (BOOL) fullTextSnippets
readwriteatomic

If set to YES, the query will collect snippets of the text surrounding each match, available via the CBLFullTextQueryRow's -snippetWithWordStart:wordEnd: method.

Extends class CBLQuery.

- (BOOL) fullTextRanking
readwriteatomic

If YES (the default) the full-text query result rows will be sorted by (approximate) relevance.

If set to NO, the rows will be returned in the order the documents were added to the database, i.e. essentially unordered; this is somewhat faster, so it can be useful if you don't care about the ordering of the rows.

Extends class CBLQuery.


The documentation for this category was generated from the following file: