CBLFullTextIndexConfiguration Class Reference


                    
                    
                    where

A predicate expression defining conditions for indexing documents. Only documents satisfying the predicate are included, enabling partial indexes.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSString *where;


                    
                    
                    ignoreAccents

Set the true value to ignore accents/diacritical marks.

Declaration

Objective-C

@property (nonatomic, readonly) BOOL ignoreAccents;


                    
                    
                    language

The language code which is an ISO-639 language such as “en”, “fr”, etc. Setting the language code affects how word breaks and word stems are parsed. Without setting the value, the current locale’s language will be used. Setting a nil or “” value to disable the language features.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSString *language;


                    
                    
                    -initWithExpression:ignoreAccents:language:

Initializes a full-text index by using an array of expression strings

Declaration

Objective-C

- (nonnull instancetype)initWithExpression:
                            (nonnull NSArray<NSString *> *)expressions
                             ignoreAccents:(BOOL)ignoreAccents
                                  language:(nullable NSString *)language;

Parameters

`expressions`	The array of expression strings.
`ignoreAccents`	The flag to ignore accents/diacritical marks.
`language`	Optional language code which is an ISO-639 language such as “en”, “fr”, etc.

Return Value

The full-text index configuration object.


                    
                    
                    -initWithExpression:where:ignoreAccents:language:

Initializes a full-text index with an array of expression strings and an optional where clause for a partial index.

Declaration

Objective-C

- (nonnull instancetype)initWithExpression:
                            (nonnull NSArray<NSString *> *)expressions
                                     where:(nullable NSString *)where
                             ignoreAccents:(BOOL)ignoreAccents
                                  language:(nullable NSString *)language;

Parameters

`where`	Optional where clause for partial indexing.
`expressions`	The array of expression strings.
`ignoreAccents`	The flag to ignore accents/diacritical marks.
`language`	Optional language code which is an ISO-639 language such as “en”, “fr”, etc.

Return Value

The full-text index configuration object.