CBLDatabaseConfiguration

@interface CBLDatabaseConfiguration : NSObject <NSCopying>

Configuration for opening a database.

  • Path to the directory to store the database in. If the directory doesn’t already exist it will be created when the database is opened. The default directory will be in Application Support. You won’t usually need to change this.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *directory;

  • The conflict resolver for this database. The default value is nil, which means the default algorithm will be used, where the revision with more history wins. An individual document can override this for itself by setting its own property.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) id<CBLConflictResolver>
    conflictResolver;

  • A key to encrypt the database with. If the database does not exist and is being created, it will use this key, and the same key must be given every time it’s opened.

    • The primary form of key is an NSData object 32 bytes in length: this is interpreted as a raw AES-256 key. To create a key, generate random data using a secure cryptographic randomizer like SecRandomCopyBytes or CCRandomGenerateBytes.
    • Alternatively, the value may be an NSString containing a password. This will be run through 64,000 rounds of the PBKDF algorithm to securely convert it into an AES-256 key.
    • A default nil value, of course, means the database is unencrypted.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable)
    CBLEncryptionKey *encryptionKey;

  • File protection/encryption options (iOS only.) Defaults to whatever file protection settings you’ve specified in your app’s entitlements. Specifying a nonzero value here overrides those settings for the database files. If file protection is at the highest level, NSDataWritingFileProtectionCompleteUnlessOpen or NSDataWritingFileProtectionComplete, it will not be possible to read or write the database when the device is locked. This can make it impossible to run replications in the background or respond to push notifications. The default value is NSDataWritingFileProtectionCompleteUntilFirstUserAuthentication which is the same default protection level as the iOS application data.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSDataWritingOptions fileProtection;

  • Initializes the CBLDatabaseConfiguration object.

    Declaration

    Objective-C

    - (nonnull instancetype)init;