YapDatabaseFullTextSearchTransaction

@interface YapDatabaseFullTextSearchTransaction
    : YapDatabaseExtensionTransaction

Welcome to YapDatabase!

The project page has a wealth of documentation if you have any questions. https://github.com/yapstudios/YapDatabase

If you’re new to the project you may want to check out the wiki https://github.com/yapstudios/YapDatabase/wiki

YapDatabaseFullTextSearch is an extension for performing text based search. Internally it uses sqlite’s FTS module which was contributed by Google.

After registering the extension, you can access this class within a regular transaction. For example:

[databaseConnection readWithBlock:^(YapDatabaseReadTransaction *transaction){

 [[transaction ext:@"mySearch"] enumerateKeysMatching:@"birthday party"
                                           usingBlock:^(NSString *collection, NSString *key, BOOL *stop){
     // matching row...
 }]

}];

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateKeysMatching:(NSString *)query
                   usingBlock:(void (NS_NOESCAPE^)(NSString *collection, NSString *key, BOOL *stop))block;

    Swift

    func enumerateKeys(matching query: String, using block: (String, String, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateKeysAndMetadataMatching:(NSString *)query
                              usingBlock:(void (NS_NOESCAPE^)(NSString *collection, NSString *key, __nullable id metadata, BOOL *stop))block;

    Swift

    func enumerateKeysAndMetadata(matching query: String, using block: (String, String, Any?, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateKeysAndObjectsMatching:(NSString *)query
                             usingBlock:(void (NS_NOESCAPE^)(NSString *collection, NSString *key, id object, BOOL *stop))block;

    Swift

    func enumerateKeysAndObjects(matching query: String, using block: (String, String, Any, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateRowsMatching:(NSString *)query
                   usingBlock:(void (NS_NOESCAPE^)(NSString *collection, NSString *key, id object, __nullable id metadata, BOOL *stop))block;

    Swift

    func enumerateRows(matching query: String, using block: (String, String, Any, Any?, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateBm25OrderedKeysMatching:(NSString *)query
                             withWeights:(nullable NSArray<NSNumber *> *)weights
                              usingBlock:(void (NS_NOESCAPE^)(NSString *collection, NSString *key, BOOL *stop))block;

    Swift

    func enumerateBm25OrderedKeys(matching query: String, withWeights weights: [NSNumber]?, using block: (String, String, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateBm25OrderedKeysAndMetadataMatching:(NSString *)query
                                        withWeights:(nullable NSArray<NSNumber *> *)weights
                                         usingBlock:(void (NS_NOESCAPE^)(NSString *collection, NSString *key, __nullable id metadata, BOOL *stop))block;

    Swift

    func enumerateBm25OrderedKeysAndMetadata(matching query: String, withWeights weights: [NSNumber]?, using block: (String, String, Any?, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateBm25OrderedKeysAndObjectsMatching:(NSString *)query
                                       withWeights:(nullable NSArray<NSNumber *> *)weights
                                        usingBlock:(void (NS_NOESCAPE^)(NSString *collection, NSString *key, id object, BOOL *stop))block;

    Swift

    func enumerateBm25OrderedKeysAndObjects(matching query: String, withWeights weights: [NSNumber]?, using block: (String, String, Any, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateBm25OrderedRowsMatching:(NSString *)query
                             withWeights:(nullable NSArray<NSNumber *> *)weights
                              usingBlock:(void (NS_NOESCAPE^)(NSString *collection, NSString *key, id object, __nullable id metadata, BOOL *stop))block;

    Swift

    func enumerateBm25OrderedRows(matching query: String, withWeights weights: [NSNumber]?, using block: (String, String, Any, Any?, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateKeysMatching:(NSString *)query
           withSnippetOptions:(nullable YapDatabaseFullTextSearchSnippetOptions *)options
                   usingBlock:
            (void (NS_NOESCAPE^)(NSString *snippet, NSString *collection, NSString *key, BOOL *stop))block;

    Swift

    func enumerateKeys(matching query: String, with options: YapDatabaseFullTextSearchSnippetOptions?, using block: (String, String, String, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateKeysAndMetadataMatching:(NSString *)query
                      withSnippetOptions:(nullable YapDatabaseFullTextSearchSnippetOptions *)options
                              usingBlock:
            (void (NS_NOESCAPE^)(NSString *snippet, NSString *collection, NSString *key, __nullable id metadata, BOOL *stop))block;

    Swift

    func enumerateKeysAndMetadata(matching query: String, with options: YapDatabaseFullTextSearchSnippetOptions?, using block: (String, String, String, Any?, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateKeysAndObjectsMatching:(NSString *)query
                     withSnippetOptions:(nullable YapDatabaseFullTextSearchSnippetOptions *)options
                             usingBlock:
            (void (NS_NOESCAPE^)(NSString *snippet, NSString *collection, NSString *key, id object, BOOL *stop))block;

    Swift

    func enumerateKeysAndObjects(matching query: String, with options: YapDatabaseFullTextSearchSnippetOptions?, using block: (String, String, String, Any, UnsafeMutablePointer<ObjCBool>) -> Void)

  • Undocumented

    Declaration

    Objective-C

    - (void)enumerateRowsMatching:(NSString *)query
           withSnippetOptions:(nullable YapDatabaseFullTextSearchSnippetOptions *)options
                   usingBlock:
            (void (NS_NOESCAPE^)(NSString *snippet, NSString *collection, NSString *key, id object, __nullable id metadata, BOOL *stop))block;

    Swift

    func enumerateRows(matching query: String, with options: YapDatabaseFullTextSearchSnippetOptions?, using block: (String, String, String, Any, Any?, UnsafeMutablePointer<ObjCBool>) -> Void)