Discussion

Whether should trace execution

Discussion

Whether checked out or not

Discussion

Crash on errors

Discussion

Logs errors

Discussion

Dictionary of cached statements

Discussion

Create a FMDatabase object.

An FMDatabase is created with a path to a SQLite database file. This path can be one of these three:

1. A file system path. The file does not have to exist on disk. If it does not exist, it is created for you.
2. An empty string (@""). An empty database is created at a temporary location. This database is deleted with the FMDatabase connection is closed.
3. nil. An in-memory database is created. This database will be destroyed with the FMDatabase connection is closed.

For example, to create/open a database in your Mac OS X tmp folder:

FMDatabase *db = [FMDatabase databaseWithPath:@"/tmp/tmp.db"];

Or, in iOS, you might open a database in the app’s Documents directory:

NSString *docsPath = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)[0];
NSString *dbPath   = [docsPath stringByAppendingPathComponent:@"test.db"];
FMDatabase *db     = [FMDatabase databaseWithPath:dbPath];

(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: http://www.sqlite.org/inmemorydb.html)

Discussion

Initialize a FMDatabase object.

An FMDatabase is created with a path to a SQLite database file. This path can be one of these three:

1. A file system path. The file does not have to exist on disk. If it does not exist, it is created for you.
2. An empty string (@""). An empty database is created at a temporary location. This database is deleted with the FMDatabase connection is closed.
3. nil. An in-memory database is created. This database will be destroyed with the FMDatabase connection is closed.

For example, to create/open a database in your Mac OS X tmp folder:

FMDatabase *db = [FMDatabase databaseWithPath:@"/tmp/tmp.db"];

Or, in iOS, you might open a database in the app’s Documents directory:

NSString *docsPath = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)[0];
NSString *dbPath   = [docsPath stringByAppendingPathComponent:@"test.db"];
FMDatabase *db     = [FMDatabase databaseWithPath:dbPath];

(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: http://www.sqlite.org/inmemorydb.html)

Discussion

Opening a new database connection

The database is opened for reading and writing, and is created if it does not already exist.

Discussion

Opening a new database connection with flags and an optional virtual file system (VFS)

Discussion

Closing a database connection

Discussion

Test to see if we have a good connection to the database.

This will confirm whether:

• is database open
• if open, it will try a simple SELECT statement and confirm that it succeeds.

Discussion

Execute single update statement

This method executes a single SQL update statement (i.e. any SQL that does not return results, such as UPDATE, INSERT, or DELETE. This method employs sqlite3_prepare_v2, sqlite3_bind to bind values to ? placeholders in the SQL with the optional list of parameters, and sqlite_step to perform the update.

The optional values provided to this method should be objects (e.g. NSString, NSNumber, NSNull, NSDate, and NSData objects), not fundamental data types (e.g. int, long, NSInteger, etc.). This method automatically handles the aforementioned object types, and all other object types will be interpreted as text values using the object’s description method.

Discussion

Execute single update statement

Discussion

Execute single update statement

This method executes a single SQL update statement (i.e. any SQL that does not return results, such as UPDATE, INSERT, or DELETE. This method employs sqlite3_prepare_v2, sqlite3_bind to bind values to ? placeholders in the SQL with the optional list of parameters, and sqlite_step to perform the update.

The optional values provided to this method should be objects (e.g. NSString, NSNumber, NSNull, NSDate, and NSData objects), not fundamental data types (e.g. int, long, NSInteger, etc.). This method automatically handles the aforementioned object types, and all other object types will be interpreted as text values using the object’s description method.

Discussion

Execute single update statement

This method executes a single SQL update statement (i.e. any SQL that does not return results, such as UPDATE, INSERT, or DELETE. This method employs sqlite3_prepare_v2 and sqlite_step to perform the update. Unlike the other executeUpdate methods, this uses printf-style formatters (e.g. %s, %d, etc.) to build the SQL. Do not use ? placeholders in the SQL if you use this method.

[db executeUpdateWithFormat:@"INSERT INTO test (name) VALUES (%@)", @"Gus"];

[db executeUpdate:@"INSERT INTO test (name) VALUES (?)", @"Gus"];

Discussion

Execute single update statement

This method executes a single SQL update statement (i.e. any SQL that does not return results, such as UPDATE, INSERT, or DELETE. This method employs sqlite3_prepare_v2 and sqlite3_bind binding any ? placeholders in the SQL with the optional list of parameters.

The optional values provided to this method should be objects (e.g. NSString, NSNumber, NSNull, NSDate, and NSData objects), not fundamental data types (e.g. int, long, NSInteger, etc.). This method automatically handles the aforementioned object types, and all other object types will be interpreted as text values using the object’s description method.

Discussion

Execute single update statement

This method executes a single SQL update statement (i.e. any SQL that does not return results, such as UPDATE, INSERT, or DELETE. This method employs sqlite3_prepare_v2 and sqlite3_bind binding any ? placeholders in the SQL with the optional list of parameters.

The optional values provided to this method should be objects (e.g. NSString, NSNumber, NSNull, NSDate, and NSData objects), not fundamental data types (e.g. int, long, NSInteger, etc.). This method automatically handles the aforementioned object types, and all other object types will be interpreted as text values using the object’s description method.

This is similar to executeUpdate:withArgumentsInArray:, except that this also accepts a pointer to a NSError pointer, so that errors can be returned.

In Swift 2, this throws errors, as if it were defined as follows:

func executeUpdate(sql: String!, values: [AnyObject]!) throws -> Bool

Discussion

Execute single update statement

This method executes a single SQL update statement (i.e. any SQL that does not return results, such as UPDATE, INSERT, or DELETE. This method employs sqlite3_prepare_v2 and sqlite_step to perform the update. Unlike the other executeUpdate methods, this uses printf-style formatters (e.g. %s, %d, etc.) to build the SQL.

The optional values provided to this method should be objects (e.g. NSString, NSNumber, NSNull, NSDate, and NSData objects), not fundamental data types (e.g. int, long, NSInteger, etc.). This method automatically handles the aforementioned object types, and all other object types will be interpreted as text values using the object’s description method.

Discussion

Execute single update statement

This method executes a single SQL update statement (i.e. any SQL that does not return results, such as UPDATE, INSERT, or DELETE. This method employs sqlite3_prepare_v2 and sqlite_step to perform the update. Unlike the other executeUpdate methods, this uses printf-style formatters (e.g. %s, %d, etc.) to build the SQL.

The optional values provided to this method should be objects (e.g. NSString, NSNumber, NSNull, NSDate, and NSData objects), not fundamental data types (e.g. int, long, NSInteger, etc.). This method automatically handles the aforementioned object types, and all other object types will be interpreted as text values using the object’s description method.

Discussion

Execute multiple SQL statements

This executes a series of SQL statements that are combined in a single string (e.g. the SQL generated by the sqlite3 command line .dump command). This accepts no value parameters, but rather simply expects a single string with multiple SQL statements, each terminated with a semicolon. This uses sqlite3_exec.

Discussion

Execute multiple SQL statements with callback handler

This executes a series of SQL statements that are combined in a single string (e.g. the SQL generated by the sqlite3 command line .dump command). This accepts no value parameters, but rather simply expects a single string with multiple SQL statements, each terminated with a semicolon. This uses sqlite3_exec.

Discussion

Last insert rowid

Each entry in an SQLite table has a unique 64-bit signed integer key called the “rowid”. The rowid is always available as an undeclared column named ROWID, OID, or _ROWID_ as long as those names are not also used by explicitly declared columns. If the table has a column of type INTEGER PRIMARY KEY then that column is another alias for the rowid.

This routine returns the rowid of the most recent successful INSERT into the database from the database connection in the first argument. As of SQLite version 3.7.7, this routines records the last insert rowid of both ordinary tables and virtual tables. If no successful INSERTs have ever occurred on that database connection, zero is returned.

Discussion

The number of rows changed by prior SQL statement.

This function returns the number of database rows that were changed or inserted or deleted by the most recently completed SQL statement on the database connection specified by the first parameter. Only changes that are directly specified by the INSERT, UPDATE, or DELETE statement are counted.

Discussion

Execute select statement

Executing queries returns an FMResultSet object if successful, and nil upon failure. Like executing updates, there is a variant that accepts an NSError ** parameter. Otherwise you should use the lastErrorMessage and lastErrorMessage methods to determine why a query failed.

In order to iterate through the results of your query, you use a while() loop. You also need to “step” (via [FMResultSet next]) from one record to the other.

This method employs sqlite3_bind for any optional value parameters. This properly escapes any characters that need escape sequences (e.g. quotation marks), which eliminates simple SQL errors as well as protects against SQL injection attacks. This method natively handles NSString, NSNumber, NSNull, NSDate, and NSData objects. All other object types will be interpreted as text values using the object’s description method.

Discussion

Execute select statement

Executing queries returns an FMResultSet object if successful, and nil upon failure. Like executing updates, there is a variant that accepts an NSError ** parameter. Otherwise you should use the lastErrorMessage and lastErrorMessage methods to determine why a query failed.

In order to iterate through the results of your query, you use a while() loop. You also need to “step” (via [FMResultSet next]) from one record to the other.

[db executeQueryWithFormat:@"SELECT * FROM test WHERE name=%@", @"Gus"];

[db executeQuery:@"SELECT * FROM test WHERE name=?", @"Gus"];

Discussion

Execute select statement

Executing queries returns an FMResultSet object if successful, and nil upon failure. Like executing updates, there is a variant that accepts an NSError ** parameter. Otherwise you should use the lastErrorMessage and lastErrorMessage methods to determine why a query failed.

In order to iterate through the results of your query, you use a while() loop. You also need to “step” (via [FMResultSet next]) from one record to the other.

Discussion

Execute select statement

Executing queries returns an FMResultSet object if successful, and nil upon failure. Like executing updates, there is a variant that accepts an NSError ** parameter. Otherwise you should use the lastErrorMessage and lastErrorMessage methods to determine why a query failed.

In order to iterate through the results of your query, you use a while() loop. You also need to “step” (via [FMResultSet next]) from one record to the other.

This is similar to executeQuery:withArgumentsInArray:, except that this also accepts a pointer to a NSError pointer, so that errors can be returned.

In Swift 2, this throws errors, as if it were defined as follows:

func executeQuery(sql: String!, values: [AnyObject]!) throws -> FMResultSet!

Discussion

Execute select statement

Executing queries returns an FMResultSet object if successful, and nil upon failure. Like executing updates, there is a variant that accepts an NSError ** parameter. Otherwise you should use the lastErrorMessage and lastErrorMessage methods to determine why a query failed.

In order to iterate through the results of your query, you use a while() loop. You also need to “step” (via [FMResultSet next]) from one record to the other.

Discussion

Begin a transaction

Discussion

Begin a deferred transaction

Discussion

Commit a transaction

Commit a transaction that was initiated with either beginTransaction or with beginDeferredTransaction.

Discussion

Rollback a transaction

Rollback a transaction that was initiated with either beginTransaction or with beginDeferredTransaction.

Discussion

Identify whether currently in a transaction or not

Discussion

Clear cached statements

Discussion

Close all open result sets

Discussion

Whether database has any open result sets

Discussion

Return whether should cache statements or not

Discussion

Set whether should cache statements or not

Discussion

Set encryption key.

Discussion

Reset encryption key

Discussion

Set encryption key using keyData.

Discussion

Reset encryption key using keyData.

Discussion

The path of the database file

Discussion

The underlying SQLite handle

Discussion

Last error message

Returns the English-language text that describes the most recent failed SQLite API call associated with a database connection. If a prior API call failed but the most recent API call succeeded, this return value is undefined.

Discussion

Last error code

Returns the numeric result code or extended result code for the most recent failed SQLite API call associated with a database connection. If a prior API call failed but the most recent API call succeeded, this return value is undefined.

Discussion

Had error

Discussion

Last error

Discussion

Start save point

Discussion

Release save point

Discussion

Roll back to save point

Discussion

Start save point

Discussion

Test to see if the library is threadsafe

Discussion

Run-time library version numbers

Discussion

Adds SQL functions or aggregates or to redefine the behavior of existing SQL functions or aggregates.

For example:

[queue inDatabase:^(FMDatabase *adb) {

    [adb executeUpdate:@"create table ftest (foo text)"];
    [adb executeUpdate:@"insert into ftest values ('hello')"];
    [adb executeUpdate:@"insert into ftest values ('hi')"];
    [adb executeUpdate:@"insert into ftest values ('not h!')"];
    [adb executeUpdate:@"insert into ftest values ('definitely not h!')"];

    [adb makeFunctionNamed:@"StringStartsWithH" maximumArguments:1 withBlock:^(sqlite3_context *context, int aargc, sqlite3_value **aargv) {
        if (sqlite3_value_type(aargv[0]) == SQLITE_TEXT) {
            @autoreleasepool {
                const char *c = (const char *)sqlite3_value_text(aargv[0]);
                NSString *s = [NSString stringWithUTF8String:c];
                sqlite3_result_int(context, [s hasPrefix:@"h"]);
            }
        }
        else {
            NSLog(@"Unknown formart for StringStartsWithH (%d) %s:%d", sqlite3_value_type(aargv[0]), __FUNCTION__, __LINE__);
            sqlite3_result_null(context);
        }
    }];

    int rowCount = 0;
    FMResultSet *ars = [adb executeQuery:@"select * from ftest where StringStartsWithH(foo)"];
    while ([ars next]) {
        rowCount++;
        NSLog(@"Does %@ start with 'h'?", [rs stringForColumnIndex:0]);
    }
    FMDBQuickCheck(rowCount == 2);
}];

Discussion

Generate an NSDateFormatter that won’t be broken by permutations of timezones or locales.

Use this method to generate values to set the dateFormat property.

Example:

myDB.dateFormat = [FMDatabase storeableDateFormat:@"yyyy-MM-dd HH:mm:ss"];

Discussion

Test whether the database has a date formatter assigned.

Discussion

Set to a date formatter to use string dates with sqlite instead of the default UNIX timestamps.

Discussion

Convert the supplied NSString to NSDate, using the current database formatter.

Discussion

Convert the supplied NSDate to NSString, using the current database formatter.