Do we need to set -DSQLITE_HAS_CODEC manually?

[b95505017]

As the document says that -DSQLITE_HAS_CODEC need to be set manually in the Other C Flags. It looks like the compilation success without this flag. What issue should I notice in this case?

[R4N]

Hi @b95505017

Thanks for your interest in SQLCipher.swift.

You'll need the SQLITE_HAS_CODEC flag in your consuming project to enable SQLCipher encryption.

For Objective-C based projects, you'll want to use the Other C Flag -DSQLITE_HAS_CODEC.

For Swift based projects, you'll want to use the SQLITE_HAS_CODEC=1 Preprocessor Macro.

If you don't set the appropriate build setting based on your target language, you should get a compilation failure when attempting to use sqlite3_key along the lines of:

Cannot find 'sqlite3_key' in scope

and SQLCipher encryption won't be enabled.

The README Build Settings section of this project mentions these two different settings depending on your project's language.

In the documentation page you linked from our website, it's not as clear that you'll only need to set the appropriate build setting based on target language (for Swift Package Manager integration). We'll adjust that to make it clearer.

It's good to test and verify that SQLCipher is properly linked/integrated/enabled. We have recommendations at the bottom of the documentation page you linked: https://www.zetetic.net/sqlcipher/sqlcipher-apple-community/#testing-and-verification

[b95505017]

I didn't get any compilation failure when leaving Other C flag empty, any reason?

[R4N]

@b95505017

I didn't get any compilation failure when leaving Other C flag empty, any reason?

Are you calling sqlite3_key somewhere in your project's code to key your database? The compilation error will only occur when your project attempts to use sqlite3_key without the appropriate (SQLITE_HAS_CODEC) build setting based on your target language.

If your project's target language is Swift, you'll only need to set the Preprocessor Macro SQLITE_HAS_CODEC=1 for both debug and release as mentioned in my previous comment.