YapDatabaseFullTextSearchHandler

@interface YapDatabaseFullTextSearchHandler : NSObject

The handler block handles extracting the column values for indexing by the FTS module.

When you add or update rows in the databse the FTS block is invoked. Your block can inspect the row and determine if it contains any text columns that should be indexed. If not, the block can simply return. Otherwise the block should extract any text values, and add them to the given dictionary.

After the block returns, the dictionary parameter will be inspected, and any set values will be automatically passed to sqlite’s FTS module for indexing.

You should choose a block type that takes the minimum number of required parameters. The extension can make various optimizations based on the required parameters of the block.


                    
                    
                    +withKeyBlock:

Undocumented

Declaration

Objective-C

+ (instancetype)withKeyBlock:(YapDatabaseFullTextSearchWithKeyBlock)block;

Swift

class func withKeyBlock(_ block: @escaping YapDatabaseFullTextSearchWithKeyBlock) -> Self


                    
                    
                    +withObjectBlock:

Undocumented

Declaration

Objective-C

+ (instancetype)withObjectBlock:(YapDatabaseFullTextSearchWithObjectBlock)block;

Swift

class func withObjectBlock(_ block: @escaping YapDatabaseFullTextSearchWithObjectBlock) -> Self


                    
                    
                    +withMetadataBlock:

Undocumented

Declaration

Objective-C

+ (instancetype)withMetadataBlock:(YapDatabaseFullTextSearchWithMetadataBlock)block;

Swift

class func withMetadataBlock(_ block: @escaping YapDatabaseFullTextSearchWithMetadataBlock) -> Self


                    
                    
                    +withRowBlock:

Undocumented

Declaration

Objective-C

+ (instancetype)withRowBlock:(YapDatabaseFullTextSearchWithRowBlock)block;

Swift

class func withRowBlock(_ block: @escaping YapDatabaseFullTextSearchWithRowBlock) -> Self


                    
                    
                    +withOptions:keyBlock:

Undocumented

Declaration

Objective-C

+ (instancetype)withOptions:(YapDatabaseBlockInvoke)ops keyBlock:(YapDatabaseFullTextSearchWithKeyBlock)block;

Swift

class func withOptions(_ ops: YapDatabaseBlockInvoke, keyBlock block: @escaping YapDatabaseFullTextSearchWithKeyBlock) -> Self


                    
                    
                    +withOptions:objectBlock:

Undocumented

Declaration

Objective-C

+ (instancetype)withOptions:(YapDatabaseBlockInvoke)ops objectBlock:(YapDatabaseFullTextSearchWithObjectBlock)block;

Swift

class func withOptions(_ ops: YapDatabaseBlockInvoke, objectBlock block: @escaping YapDatabaseFullTextSearchWithObjectBlock) -> Self


                    
                    
                    +withOptions:metadataBlock:

Undocumented

Declaration

Objective-C

+ (instancetype)withOptions:(YapDatabaseBlockInvoke)ops metadataBlock:(YapDatabaseFullTextSearchWithMetadataBlock)block;

Swift

class func withOptions(_ ops: YapDatabaseBlockInvoke, metadataBlock block: @escaping YapDatabaseFullTextSearchWithMetadataBlock) -> Self


                    
                    
                    +withOptions:rowBlock:

Undocumented

Declaration

Objective-C

+ (instancetype)withOptions:(YapDatabaseBlockInvoke)ops rowBlock:(YapDatabaseFullTextSearchWithRowBlock)block;

Swift

class func withOptions(_ ops: YapDatabaseBlockInvoke, rowBlock block: @escaping YapDatabaseFullTextSearchWithRowBlock) -> Self


                    
                    
                    block

Undocumented

Declaration

Objective-C

@property (nonatomic, strong, readonly) YapDatabaseFullTextSearchBlock block

Swift

var block: Any { get }


                    
                    
                    blockType

Undocumented

Declaration

Objective-C

@property (nonatomic, assign, readonly) YapDatabaseBlockType           blockType

Swift

var blockType: YapDatabaseBlockType { get }


                    
                    
                    blockInvokeOptions

Undocumented

Declaration

Objective-C

@property (nonatomic, assign, readonly) YapDatabaseBlockInvoke         blockInvokeOptions

Swift

var blockInvokeOptions: YapDatabaseBlockInvoke { get }