Repository files navigation

An Xcode project to easily build a custom SQLite static library for use in OSX and iOS frameworks and apps.

If you need a specific version of SQLite, or specific SQLite compilation options/features, read on.

January 2, 2025: Update SQLite to 3.47.2 (changelog).

Requirements: iOS 8.0+ / OSX 10.9+, Xcode 7.3+

SQLite Included:3.47.2

==========

1. Download a copy of SQLiteLib.
2. Embed theSQLiteLib.xcodeproj project in your own project.
3. Add the SQLiteLib.sqlitecustom target in theTarget Dependencies section of theBuild Phases tab of your application target.
4. Addlibsqlitecustom.a to theLinked Frameworks and Libraries section of theGeneral tab of your target.

That's it! (You'll probably also want to#include "sqlite3.h" somewhere. SQLiteLib copies this generated file to its project directory.)

You probably shouldn't be using the raw SQLite C API in Swift. There are a bunch of great libraries available that wrap it.

For example: (GRDB.swift).

By default, SQLiteLib builds SQLite with options that match the built-in system version of SQLite on OSX and iOS (as of OSX 10.11.6, iOS 9.3.5),with two exception*.

By default, SQLiteLib compiles SQLite with options that match the built-in OSX/iOS version of SQLite (as of OSX 10.11, iOS 9.3.5), with one exception*.You only need to follow the steps below if you wish to customize the options.

To specify additional options:

1. OpenSQLiteLib-USER.xcconfig
2. ModifyCUSTOM_SQLLIBRARY_CFLAGS to specify the additional options.

For example, to specify SQLITE_ENABLE_PREUPDATE_HOOK, you would modify it like this:

CUSTOM_SQLLIBRARY_CFLAGS = -DSQLITE_ENABLE_PREUPDATE_HOOK

That's it.There is no need to modify any other files.

NOTE: IfSQLiteLib-USER.xcconfig doesn't exist, copy theSQLiteLib-USER.xcconfig.example file and rename it, or build once (which will automatically do this for you). (Reference)

SQLiteLib currently ships with the source for a specific version of SQLite (see above).

If you'd like to compile a newer (or older) version, the process is simple:

1. Download a snapshot of the complete (raw) source tree for SQLite for the version you'd like.
2. Replace the contents of SQLiteLib's "sqlite" subdirectory with the contents of the SQLite raw source tree snapshot.

IMPORTANT:Youmust use the complete raw SQLite source. The amalgamation source willNOT work properly.

SQLiteLib internally builds the amalgamation source using the steps specified in (How To Compile SQLite).

Setting compilation options using the SQLite amalgamation is not guaranteed to work:

The versions of the SQLite amalgamation that are supplied on the download page are normally adequate for most users. However, some projects may want or need to build their own amalgamations. A common reason for building a custom amalgamation is in order to use certain compile-time options to customize the SQLite library. Recall that the SQLite amalgamation contains a lot of C-code that is generated by auxiliary programs and scripts. Many of the compile-time options effect this generated code andmust be supplied to the code generators before the amalgamation is assembled.

The snapshop of the complete (raw) source tree for thecurrent version of SQLite is available on the (SQLite Download Page) under:Alternative Source Code Formats.You'll want the file named "sqlite-src-version.zip".

DoNOT use the file beginning with "sqlite-preprocessed" - it will not work properly.

The built-in OSX/iOS version of SQLite were built with the following compilation options (as of OSX 10.11.6, iOS 9.3.5):

Fetched usingPRAGMA compile_options;

• MacOSX (10.11.6)

  • ENABLE_API_ARMOR
  • ENABLE_FTS3
  • ENABLE_FTS3_PARENTHESIS
  • ENABLE_LOCKING_STYLE=1
  • ENABLE_RTREE
  • ENABLE_UPDATE_DELETE_LIMIT
  • OMIT_AUTORESET
  • OMIT_BUILTIN_TEST
  • OMIT_LOAD_EXTENSION
  • SYSTEM_MALLOC
  • THREADSAFE=2

• iPhoneOS (9.3.5)

  • ENABLE_API_ARMOR
  • ENABLE_FTS3
  • ENABLE_FTS3_PARENTHESIS
  • ENABLE_LOCKING_STYLE=1
  • ENABLE_RTREE
  • ENABLE_UPDATE_DELETE_LIMIT
  • MAX_MMAP_SIZE=0
  • OMIT_AUTORESET
  • OMIT_BUILTIN_TEST
  • OMIT_LOAD_EXTENSION
  • SYSTEM_MALLOC
  • THREADSAFE=2

These settings are reused, with two exceptions.

• SQLiteLib does not useOMIT_LOAD_EXTENSION, allowing applications to load SQLite extensions.

• SQLiteLib usesSQLITE_ENABLE_LOCKING_STYLE=1 on OSX,but on iOS, SQLiteLib compiles withENABLE_LOCKING_STYLE=0.

  The reason for this is that the SQLite code uses a deprecated function (gethostuuid()).

  D. Richard Hipp (SQLite architect), suggests working around this on iOS using-DSQLITE_ENABLE_LOCKING_STYLE=0:

  "The SQLITE_ENABLE_LOCKING_STYLE thing is an apple-only extension thatboosts performance when SQLite is used on a network filesystem. Thisis important on MacOS because some users think it is a good idea toput their home directory on a network filesystem.

  I'm guessing this is not really a factor on iOS."

  This removes the code that uses the deprecated function, but doesn't get rid of the warning that "gethostuuid() is disabled".

  To prevent this warning, SQLiteLib separately specifies-Wno-#warnings when building for iOS.

All of these base settings are configured in the SQLiteLib.xcconfig file.It is strongly recommended that you do not edit this file. If you'd like to specify additional compilation options, seethe instructions above.

SQLiteLib generates intermediate files in${DERIVED_SOURCES_DIR}.

The generated SQLite amalgamation files are copied to:

-${BUILT_PRODUCTS_DIR}/sqlite3.c

-${PROJECT_DIR}/sqlite3.h

You can include theSQLite EncryptionExtension if you have a license to do so.

To include it in the generated amalgamation, locate the SEE files on your system. In yourSQLiteLib-USER.xcconfig file, add the following entries:

SQLITE_SEE_CODE = /path/to/your/see-code/see.c

These will then be merged into the generated amalgamation

Xcode (verified in Version 7.3.1 (7D1014)) will always show "sqlite3.c" as red/missing, even after a build.

This is a UI issue in Xcode - the path is properly set in the project.pbxproj file to be "Relative to Build Products", and the build should succeed.

SQLiteLib.xcconfig line 6: Unable to find included file "SQLiteLib-USER.xcconfig"

SQLiteLib's project will automatically generate this from the base templateSQLiteLib-USER.xcconfig.example on first build, or you may copy and rename it yourself.

(Future builds will not display the warning. The warning does not affect functionality.)