#import <Foundation/Foundation.h>
|
#import "FMResultSet.h"
|
#import "FMDatabasePool.h"
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
#if ! __has_feature(objc_arc)
|
#define FMDBAutorelease(__v) ([__v autorelease]);
|
#define FMDBReturnAutoreleased FMDBAutorelease
|
|
#define FMDBRetain(__v) ([__v retain]);
|
#define FMDBReturnRetained FMDBRetain
|
|
#define FMDBRelease(__v) ([__v release]);
|
|
#define FMDBDispatchQueueRelease(__v) (dispatch_release(__v));
|
#else
|
// -fobjc-arc
|
#define FMDBAutorelease(__v)
|
#define FMDBReturnAutoreleased(__v) (__v)
|
|
#define FMDBRetain(__v)
|
#define FMDBReturnRetained(__v) (__v)
|
|
#define FMDBRelease(__v)
|
|
// If OS_OBJECT_USE_OBJC=1, then the dispatch objects will be treated like ObjC objects
|
// and will participate in ARC.
|
// See the section on "Dispatch Queues and Automatic Reference Counting" in "Grand Central Dispatch (GCD) Reference" for details.
|
#if OS_OBJECT_USE_OBJC
|
#define FMDBDispatchQueueRelease(__v)
|
#else
|
#define FMDBDispatchQueueRelease(__v) (dispatch_release(__v));
|
#endif
|
#endif
|
|
#if !__has_feature(objc_instancetype)
|
#define instancetype id
|
#endif
|
|
/**
|
Callback block used by @c executeStatements:withResultBlock:
|
*/
|
typedef int(^FMDBExecuteStatementsCallbackBlock)(NSDictionary *resultsDictionary);
|
|
/**
|
Enumeration used in checkpoint methods.
|
*/
|
typedef NS_ENUM(int, FMDBCheckpointMode) {
|
FMDBCheckpointModePassive = 0, // SQLITE_CHECKPOINT_PASSIVE,
|
FMDBCheckpointModeFull = 1, // SQLITE_CHECKPOINT_FULL,
|
FMDBCheckpointModeRestart = 2, // SQLITE_CHECKPOINT_RESTART,
|
FMDBCheckpointModeTruncate = 3 // SQLITE_CHECKPOINT_TRUNCATE
|
};
|
|
#pragma clang diagnostic push
|
#pragma clang diagnostic ignored "-Wobjc-interface-ivars"
|
|
/** A SQLite ([https://sqlite.org/](https://sqlite.org/)) Objective-C wrapper.
|
|
Usage
|
|
The three main classes in FMDB are:
|
|
- @c FMDatabase - Represents a single SQLite database. Used for executing SQL statements.
|
|
- @c FMResultSet - Represents the results of executing a query on an @c FMDatabase .
|
|
- @c FMDatabaseQueue - If you want to perform queries and updates on multiple threads, you'll want to use this class.
|
|
See also
|
|
- @c FMDatabasePool - A pool of @c FMDatabase objects
|
|
- @c FMStatement - A wrapper for @c sqlite_stmt
|
|
External links
|
|
- [FMDB on GitHub](https://github.com/ccgus/fmdb) including introductory documentation
|
- [SQLite web site](https://sqlite.org/)
|
- [FMDB mailing list](http://groups.google.com/group/fmdb)
|
- [SQLite FAQ](https://sqlite.org/faq.html)
|
|
@warning Do not instantiate a single @c FMDatabase object and use it across multiple threads. Instead, use @c FMDatabaseQueue .
|
|
*/
|
|
@interface FMDatabase : NSObject
|
|
///-----------------
|
/// @name Properties
|
///-----------------
|
|
/** Whether should trace execution */
|
|
@property (atomic, assign) BOOL traceExecution;
|
|
/** Whether checked out or not */
|
|
@property (atomic, assign) BOOL checkedOut;
|
|
/** Crash on errors */
|
|
@property (atomic, assign) BOOL crashOnErrors;
|
|
/** Logs errors */
|
|
@property (atomic, assign) BOOL logsErrors;
|
|
/** Dictionary of cached statements */
|
|
@property (atomic, retain, nullable) NSMutableDictionary *cachedStatements;
|
|
///---------------------
|
/// @name Initialization
|
///---------------------
|
|
/** Create a @c FMDatabase object.
|
|
An @c 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 zero-length string. An empty database is created at a temporary location. This database is deleted with the @c FMDatabase connection is closed.
|
|
3. @c nil . An in-memory database is created. This database will be destroyed with the @c FMDatabase connection is closed.
|
|
For example, to open a database in the app's “Application Support” directory:
|
|
@code
|
NSURL *folder = [[NSFileManager defaultManager] URLForDirectory:NSApplicationSupportDirectory inDomain:NSUserDomainMask appropriateForURL:nil create:true error:&error];
|
NSURL *fileURL = [folder URLByAppendingPathComponent:@"test.db"];
|
FMDatabase *db = [FMDatabase databaseWithPath:fileURL.path];
|
@endcode
|
|
(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: [https://sqlite.org/inmemorydb.html](https://sqlite.org/inmemorydb.html))
|
|
@param inPath Path of database file
|
|
@return @c FMDatabase object if successful; @c nil if failure.
|
|
*/
|
|
+ (instancetype)databaseWithPath:(NSString * _Nullable)inPath;
|
|
/** Create a @c FMDatabase object.
|
|
An @c FMDatabase is created with a path to a SQLite database file. This path can be one of these three:
|
|
1. A file system URL. The file does not have to exist on disk. If it does not exist, it is created for you.
|
|
2. @c nil . An in-memory database is created. This database will be destroyed with the @c FMDatabase connection is closed.
|
|
For example, to open a database in the app's “Application Support” directory:
|
|
@code
|
NSURL *folder = [[NSFileManager defaultManager] URLForDirectory:NSApplicationSupportDirectory inDomain:NSUserDomainMask appropriateForURL:nil create:true error:&error];
|
NSURL *fileURL = [folder URLByAppendingPathComponent:@"test.db"];
|
FMDatabase *db = [FMDatabase databaseWithURL:fileURL];
|
@endcode
|
|
(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: [https://sqlite.org/inmemorydb.html](https://sqlite.org/inmemorydb.html))
|
|
@param url The local file URL (not remote URL) of database file
|
|
@return @c FMDatabase object if successful; @c nil if failure.
|
|
*/
|
|
+ (instancetype)databaseWithURL:(NSURL * _Nullable)url;
|
|
/** Initialize a @c FMDatabase object.
|
|
An @c 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. A zero-length string. An empty database is created at a temporary location. This database is deleted with the @c FMDatabase connection is closed.
|
|
3. @c nil . An in-memory database is created. This database will be destroyed with the @c FMDatabase connection is closed.
|
|
For example, to open a database in the app's “Application Support” directory:
|
|
@code
|
NSURL *folder = [[NSFileManager defaultManager] URLForDirectory:NSApplicationSupportDirectory inDomain:NSUserDomainMask appropriateForURL:nil create:true error:&error];
|
NSURL *fileURL = [folder URLByAppendingPathComponent:@"test.db"];
|
FMDatabase *db = [[FMDatabase alloc] initWithPath:fileURL.path];
|
@endcode
|
|
|
(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: [https://sqlite.org/inmemorydb.html](https://sqlite.org/inmemorydb.html))
|
|
@param path Path of database file.
|
|
@return @c FMDatabase object if successful; @c nil if failure.
|
|
*/
|
|
- (instancetype)initWithPath:(NSString * _Nullable)path;
|
|
/** Initialize a @c FMDatabase object.
|
|
An @c FMDatabase is created with a local file URL to a SQLite database file. This path can be one of these three:
|
|
1. A file system URL. The file does not have to exist on disk. If it does not exist, it is created for you.
|
|
2. @c nil . An in-memory database is created. This database will be destroyed with the @c FMDatabase connection is closed.
|
|
For example, to open a database in the app's “Application Support” directory:
|
|
@code
|
NSURL *folder = [[NSFileManager defaultManager] URLForDirectory:NSApplicationSupportDirectory inDomain:NSUserDomainMask appropriateForURL:nil create:true error:&error];
|
NSURL *fileURL = [folder URLByAppendingPathComponent:@"test.db"];
|
FMDatabase *db = [[FMDatabase alloc] initWithURL:fileURL];
|
@endcode
|
|
(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: [https://sqlite.org/inmemorydb.html](https://sqlite.org/inmemorydb.html))
|
|
@param url The file @c NSURL of database file.
|
|
@return @c FMDatabase object if successful; @c nil if failure.
|
|
*/
|
|
- (instancetype)initWithURL:(NSURL * _Nullable)url;
|
|
///-----------------------------------
|
/// @name Opening and closing database
|
///-----------------------------------
|
|
/// Is the database open or not?
|
|
@property (nonatomic) BOOL isOpen;
|
|
/** Opening a new database connection
|
|
The database is opened for reading and writing, and is created if it does not already exist.
|
|
@return @c YES if successful, @c NO on error.
|
|
@see [sqlite3_open()](https://sqlite.org/c3ref/open.html)
|
@see openWithFlags:
|
@see close
|
*/
|
|
- (BOOL)open;
|
|
/** Opening a new database connection with flags and an optional virtual file system (VFS)
|
|
@param flags One of the following three values, optionally combined with the @c SQLITE_OPEN_NOMUTEX , @c SQLITE_OPEN_FULLMUTEX , @c SQLITE_OPEN_SHAREDCACHE , @c SQLITE_OPEN_PRIVATECACHE , and/or @c SQLITE_OPEN_URI flags:
|
|
@code
|
SQLITE_OPEN_READONLY
|
@endcode
|
|
The database is opened in read-only mode. If the database does not already exist, an error is returned.
|
|
@code
|
SQLITE_OPEN_READWRITE
|
@endcode
|
|
The database is opened for reading and writing if possible, or reading only if the file is write protected by the operating system. In either case the database must already exist, otherwise an error is returned.
|
|
@code
|
SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
|
@endcode
|
|
The database is opened for reading and writing, and is created if it does not already exist. This is the behavior that is always used for @c open method.
|
|
@return @c YES if successful, @c NO on error.
|
|
@see [sqlite3_open_v2()](https://sqlite.org/c3ref/open.html)
|
@see open
|
@see close
|
*/
|
|
- (BOOL)openWithFlags:(int)flags;
|
|
/** Opening a new database connection with flags and an optional virtual file system (VFS)
|
|
@param flags One of the following three values, optionally combined with the @c SQLITE_OPEN_NOMUTEX , `SQLITE_OPEN_FULLMUTEX`, `SQLITE_OPEN_SHAREDCACHE`, @c SQLITE_OPEN_PRIVATECACHE , and/or @c SQLITE_OPEN_URI flags:
|
|
@code
|
SQLITE_OPEN_READONLY
|
@endcode
|
|
The database is opened in read-only mode. If the database does not already exist, an error is returned.
|
|
@code
|
SQLITE_OPEN_READWRITE
|
@endcode
|
|
The database is opened for reading and writing if possible, or reading only if the file is write protected by the operating system. In either case the database must already exist, otherwise an error is returned.
|
|
@code
|
SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
|
@endcode
|
|
The database is opened for reading and writing, and is created if it does not already exist. This is the behavior that is always used for @c open method.
|
|
@param vfsName If vfs is given the value is passed to the vfs parameter of sqlite3_open_v2.
|
|
@return @c YES if successful, @c NO on error.
|
|
@see [sqlite3_open_v2()](https://sqlite.org/c3ref/open.html)
|
@see open
|
@see close
|
*/
|
|
- (BOOL)openWithFlags:(int)flags vfs:(NSString * _Nullable)vfsName;
|
|
/** Closing a database connection
|
|
@return @c YES if success, @c NO on error.
|
|
@see [sqlite3_close()](https://sqlite.org/c3ref/close.html)
|
@see open
|
@see openWithFlags:
|
*/
|
|
- (BOOL)close;
|
|
/** 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 @c SELECT statement and confirm that it succeeds.
|
|
@return @c YES if everything succeeds, @c NO on failure.
|
*/
|
|
@property (nonatomic, readonly) BOOL goodConnection;
|
|
|
///----------------------
|
/// @name Perform updates
|
///----------------------
|
|
/** Execute single update statement
|
|
This method executes a single SQL update statement (i.e. any SQL that does not return results, such as @c UPDATE , @c INSERT , or @c DELETE . This method employs [`sqlite3_prepare_v2`](https://sqlite.org/c3ref/prepare.html), [`sqlite3_bind`](https://sqlite.org/c3ref/bind_blob.html) to bind values to `?` placeholders in the SQL with the optional list of parameters, and [`sqlite_step`](https://sqlite.org/c3ref/step.html) to perform the update.
|
|
The optional values provided to this method should be objects (e.g. @c NSString , @c NSNumber , @c NSNull , @c NSDate , and @c NSData objects), not fundamental data types (e.g. @c int , @c long , @c 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 @c description method.
|
|
@param sql The SQL to be performed, with optional `?` placeholders. This can be followed by iptional parameters to bind to `?` placeholders in the SQL statement. These should be Objective-C objects (e.g. @c NSString , @c NSNumber , etc.), not fundamental C data types (e.g. @c int , etc.).
|
|
@param outErr A reference to the @c NSError pointer to be updated with an auto released @c NSError object if an error if an error occurs. If @c nil , no @c NSError object will be returned.
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see lastError
|
@see lastErrorCode
|
@see lastErrorMessage
|
@see [`sqlite3_bind`](https://sqlite.org/c3ref/bind_blob.html)
|
*/
|
|
- (BOOL)executeUpdate:(NSString*)sql withErrorAndBindings:(NSError * _Nullable __autoreleasing *)outErr, ...;
|
|
/** Execute single update statement
|
|
@see executeUpdate:withErrorAndBindings:
|
|
@warning **Deprecated**: Please use `<executeUpdate:withErrorAndBindings>` instead.
|
*/
|
|
- (BOOL)update:(NSString*)sql withErrorAndBindings:(NSError * _Nullable __autoreleasing *)outErr, ... __deprecated_msg("Use executeUpdate:withErrorAndBindings: instead");;
|
|
/** Execute single update statement
|
|
This method executes a single SQL update statement (i.e. any SQL that does not return results, such as @c UPDATE , @c INSERT , or @c DELETE . This method employs [`sqlite3_prepare_v2`](https://sqlite.org/c3ref/prepare.html), [`sqlite3_bind`](https://sqlite.org/c3ref/bind_blob.html) to bind values to `?` placeholders in the SQL with the optional list of parameters, and [`sqlite_step`](https://sqlite.org/c3ref/step.html) to perform the update.
|
|
The optional values provided to this method should be objects (e.g. @c NSString , @c NSNumber , @c NSNull , @c NSDate , and @c NSData objects), not fundamental data types (e.g. @c int , @c long , @c 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 @c description method.
|
|
@param sql The SQL to be performed, with optional `?` placeholders, followed by optional parameters to bind to `?` placeholders in the SQL statement. These should be Objective-C objects (e.g. @c NSString , @c NSNumber , etc.), not fundamental C data types (e.g. @c int , etc.).
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see lastError
|
@see lastErrorCode
|
@see lastErrorMessage
|
@see [`sqlite3_bind`](https://sqlite.org/c3ref/bind_blob.html)
|
|
@note This technique supports the use of `?` placeholders in the SQL, automatically binding any supplied value parameters to those placeholders. This approach is more robust than techniques that entail using @c stringWithFormat to manually build SQL statements, which can be problematic if the values happened to include any characters that needed to be quoted.
|
|
@note You cannot use this method from Swift due to incompatibilities between Swift and Objective-C variadic implementations. Consider using `<executeUpdate:values:>` instead.
|
*/
|
|
- (BOOL)executeUpdate:(NSString*)sql, ...;
|
|
/** Execute single update statement
|
|
This method executes a single SQL update statement (i.e. any SQL that does not return results, such as @c UPDATE , @c INSERT , or @c DELETE . This method employs [`sqlite3_prepare_v2`](https://sqlite.org/c3ref/prepare.html) and [`sqlite_step`](https://sqlite.org/c3ref/step.html) to perform the update. Unlike the other @c 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.
|
|
@param format The SQL to be performed, with `printf`-style escape sequences, followed by optional parameters to bind to use in conjunction with the `printf`-style escape sequences in the SQL statement.
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see executeUpdate:
|
@see lastError
|
@see lastErrorCode
|
@see lastErrorMessage
|
|
@note This method does not technically perform a traditional printf-style replacement. What this method actually does is replace the printf-style percent sequences with a SQLite `?` placeholder, and then bind values to that placeholder. Thus the following command
|
|
@code
|
[db executeUpdateWithFormat:@"INSERT INTO test (name) VALUES (%@)", @"Gus"];
|
@endcode
|
|
is actually replacing the `%@` with `?` placeholder, and then performing something equivalent to `<executeUpdate:>`
|
|
@code
|
[db executeUpdate:@"INSERT INTO test (name) VALUES (?)", @"Gus"];
|
@endcode
|
|
There are two reasons why this distinction is important. First, the printf-style escape sequences can only be used where it is permissible to use a SQLite `?` placeholder. You can use it only for values in SQL statements, but not for table names or column names or any other non-value context. This method also cannot be used in conjunction with `pragma` statements and the like. Second, note the lack of quotation marks in the SQL. The `VALUES` clause was _not_ `VALUES ('%@')` (like you might have to do if you built a SQL statement using @c NSString method @c stringWithFormat ), but rather simply `VALUES (%@)`.
|
*/
|
|
- (BOOL)executeUpdateWithFormat:(NSString *)format, ... NS_FORMAT_FUNCTION(1,2);
|
|
/** Execute single update statement
|
|
This method executes a single SQL update statement (i.e. any SQL that does not return results, such as @c UPDATE , @c INSERT , or @c DELETE . This method employs [`sqlite3_prepare_v2`](https://sqlite.org/c3ref/prepare.html) and [`sqlite3_bind`](https://sqlite.org/c3ref/bind_blob.html) binding any `?` placeholders in the SQL with the optional list of parameters.
|
|
The optional values provided to this method should be objects (e.g. @c NSString , @c NSNumber , @c NSNull , @c NSDate , and @c NSData objects), not fundamental data types (e.g. @c int , @c long , @c 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 @c description method.
|
|
@param sql The SQL to be performed, with optional `?` placeholders.
|
|
@param arguments A @c NSArray of objects to be used when binding values to the `?` placeholders in the SQL statement.
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see executeUpdate:values:error:
|
@see lastError
|
@see lastErrorCode
|
@see lastErrorMessage
|
*/
|
|
- (BOOL)executeUpdate:(NSString*)sql withArgumentsInArray:(NSArray *)arguments;
|
|
/** Execute single update statement
|
|
This method executes a single SQL update statement (i.e. any SQL that does not return results, such as @c UPDATE , @c INSERT , or @c DELETE . This method employs [`sqlite3_prepare_v2`](https://sqlite.org/c3ref/prepare.html) and [`sqlite3_bind`](https://sqlite.org/c3ref/bind_blob.html) binding any `?` placeholders in the SQL with the optional list of parameters.
|
|
The optional values provided to this method should be objects (e.g. @c NSString , @c NSNumber , @c NSNull , @c NSDate , and @c NSData objects), not fundamental data types (e.g. @c int , @c long , @c 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 @c description method.
|
|
This is similar to @c executeUpdate:withArgumentsInArray: , except that this also accepts a pointer to a @c NSError pointer, so that errors can be returned.
|
|
In Swift, this throws errors, as if it were defined as follows:
|
|
@code
|
func executeUpdate(sql: String, values: [Any]?) throws -> Bool { }
|
@endcode
|
|
@param sql The SQL to be performed, with optional `?` placeholders.
|
|
@param values A @c NSArray of objects to be used when binding values to the `?` placeholders in the SQL statement.
|
|
@param error A @c NSError object to receive any error object (if any).
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see lastError
|
@see lastErrorCode
|
@see lastErrorMessage
|
|
*/
|
|
- (BOOL)executeUpdate:(NSString*)sql values:(NSArray * _Nullable)values error:(NSError * _Nullable __autoreleasing *)error;
|
|
/** Execute single update statement
|
|
This method executes a single SQL update statement (i.e. any SQL that does not return results, such as @c UPDATE , @c INSERT , or @c DELETE . This method employs [`sqlite3_prepare_v2`](https://sqlite.org/c3ref/prepare.html) and [`sqlite_step`](https://sqlite.org/c3ref/step.html) to perform the update. Unlike the other @c 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. @c NSString , @c NSNumber , @c NSNull , @c NSDate , and @c NSData objects), not fundamental data types (e.g. @c int , @c long , @c 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 @c description method.
|
|
@param sql The SQL to be performed, with optional `?` placeholders.
|
|
@param arguments A @c NSDictionary of objects keyed by column names that will be used when binding values to the `?` placeholders in the SQL statement.
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see lastError
|
@see lastErrorCode
|
@see lastErrorMessage
|
*/
|
|
- (BOOL)executeUpdate:(NSString*)sql withParameterDictionary:(NSDictionary *)arguments;
|
|
|
/** Execute single update statement
|
|
This method executes a single SQL update statement (i.e. any SQL that does not return results, such as @c UPDATE , @c INSERT , or @c DELETE . This method employs [`sqlite3_prepare_v2`](https://sqlite.org/c3ref/prepare.html) and [`sqlite_step`](https://sqlite.org/c3ref/step.html) to perform the update. Unlike the other @c 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. @c NSString , @c NSNumber , @c NSNull , @c NSDate , and @c NSData objects), not fundamental data types (e.g. @c int , @c long , @c 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 @c description method.
|
|
@param sql The SQL to be performed, with optional `?` placeholders.
|
|
@param args A `va_list` of arguments.
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see lastError
|
@see lastErrorCode
|
@see lastErrorMessage
|
*/
|
|
- (BOOL)executeUpdate:(NSString*)sql withVAList: (va_list)args;
|
|
/** 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 @c sqlite3_exec .
|
|
@param sql The SQL to be performed
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see executeStatements:withResultBlock:
|
@see [sqlite3_exec()](https://sqlite.org/c3ref/exec.html)
|
|
*/
|
|
- (BOOL)executeStatements:(NSString *)sql;
|
|
/** 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`.
|
|
@param sql The SQL to be performed.
|
@param block A block that will be called for any result sets returned by any SQL statements.
|
Note, if you supply this block, it must return integer value, zero upon success (this would be a good opportunity to use @c SQLITE_OK ),
|
non-zero value upon failure (which will stop the bulk execution of the SQL). If a statement returns values, the block will be called with the results from the query in NSDictionary *resultsDictionary.
|
This may be @c nil if you don't care to receive any results.
|
|
@return @c YES upon success; @c NO upon failure. If failed, you can call @c lastError ,
|
@c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see executeStatements:
|
@see [sqlite3_exec()](https://sqlite.org/c3ref/exec.html)
|
|
*/
|
|
- (BOOL)executeStatements:(NSString *)sql withResultBlock:(__attribute__((noescape)) FMDBExecuteStatementsCallbackBlock _Nullable)block;
|
|
/** 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 @c 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 @c INSERT statements have ever occurred on that database connection, zero is returned.
|
|
@return The rowid of the last inserted row.
|
|
@see [sqlite3_last_insert_rowid()](https://sqlite.org/c3ref/last_insert_rowid.html)
|
|
*/
|
|
@property (nonatomic, readonly) int64_t lastInsertRowId;
|
|
/** 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 @c INSERT , @c UPDATE , or @c DELETE statement are counted.
|
|
@return The number of rows changed by prior SQL statement.
|
|
@see [sqlite3_changes()](https://sqlite.org/c3ref/changes.html)
|
|
*/
|
|
@property (nonatomic, readonly) int changes;
|
|
|
///-------------------------
|
/// @name Retrieving results
|
///-------------------------
|
|
/** Execute select statement
|
|
Executing queries returns an @c FMResultSet object if successful, and @c nil upon failure. Like executing updates, there is a variant that accepts an `NSError **` parameter. Otherwise you should use the @c lastErrorMessage and @c 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`](https://sqlite.org/c3ref/bind_blob.html) 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 @c NSString , @c NSNumber , @c NSNull , @c NSDate , and @c NSData objects. All other object types will be interpreted as text values using the object's @c description method.
|
|
@param sql The SELECT statement to be performed, with optional `?` placeholders, followed by optional parameters to bind to `?` placeholders in the SQL statement. These should be Objective-C objects (e.g. @c NSString , @c NSNumber , etc.), not fundamental C data types (e.g. @c int , etc.).
|
|
@return A @c FMResultSet for the result set upon success; @c nil upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see FMResultSet
|
@see [`FMResultSet next`](<[FMResultSet next]>)
|
@see [`sqlite3_bind`](https://sqlite.org/c3ref/bind_blob.html)
|
|
@note You cannot use this method from Swift due to incompatibilities between Swift and Objective-C variadic implementations. Consider using `<executeQuery:values:>` instead.
|
*/
|
|
- (FMResultSet * _Nullable)executeQuery:(NSString*)sql, ...;
|
|
/** Execute select statement
|
|
Executing queries returns an @c FMResultSet object if successful, and @c nil upon failure. Like executing updates, there is a variant that accepts an `NSError **` parameter. Otherwise you should use the @c lastErrorMessage and @c 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.
|
|
@param format The SQL to be performed, with `printf`-style escape sequences, followed by ptional parameters to bind to use in conjunction with the `printf`-style escape sequences in the SQL statement.
|
|
@return A @c FMResultSet for the result set upon success; @c nil upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see executeQuery:
|
@see FMResultSet
|
@see [`FMResultSet next`](<[FMResultSet next]>)
|
|
@note This method does not technically perform a traditional printf-style replacement. What this method actually does is replace the printf-style percent sequences with a SQLite `?` placeholder, and then bind values to that placeholder. Thus the following command
|
|
@code
|
[db executeQueryWithFormat:@"SELECT * FROM test WHERE name=%@", @"Gus"];
|
@endcode
|
|
is actually replacing the `%@` with `?` placeholder, and then performing something equivalent to `<executeQuery:>`
|
|
@code
|
[db executeQuery:@"SELECT * FROM test WHERE name=?", @"Gus"];
|
@endcode
|
|
There are two reasons why this distinction is important. First, the printf-style escape sequences can only be used where it is permissible to use a SQLite `?` placeholder. You can use it only for values in SQL statements, but not for table names or column names or any other non-value context. This method also cannot be used in conjunction with `pragma` statements and the like. Second, note the lack of quotation marks in the SQL. The @c WHERE clause was _not_ `WHERE name='%@'` (like you might have to do if you built a SQL statement using @c NSString method @c stringWithFormat ), but rather simply `WHERE name=%@`.
|
|
*/
|
|
- (FMResultSet * _Nullable)executeQueryWithFormat:(NSString*)format, ... NS_FORMAT_FUNCTION(1,2);
|
|
/** Execute select statement
|
|
Executing queries returns an @c FMResultSet object if successful, and @c nil upon failure. Like executing updates, there is a variant that accepts an `NSError **` parameter. Otherwise you should use the @c lastErrorMessage and @c 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.
|
|
@param sql The SELECT statement to be performed, with optional `?` placeholders.
|
|
@param arguments A @c NSArray of objects to be used when binding values to the `?` placeholders in the SQL statement.
|
|
@return A @c FMResultSet for the result set upon success; @c nil upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see -executeQuery:values:error:
|
@see FMResultSet
|
@see [`FMResultSet next`](<[FMResultSet next]>)
|
*/
|
|
- (FMResultSet * _Nullable)executeQuery:(NSString *)sql withArgumentsInArray:(NSArray *)arguments;
|
|
/** Execute select statement
|
|
Executing queries returns an @c FMResultSet object if successful, and @c nil upon failure. Like executing updates, there is a variant that accepts an `NSError **` parameter. Otherwise you should use the @c lastErrorMessage and @c 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 @c NSError pointer, so that errors can be returned.
|
|
In Swift, this throws errors, as if it were defined as follows:
|
|
`func executeQuery(sql: String, values: [Any]?) throws -> FMResultSet!`
|
|
@param sql The SELECT statement to be performed, with optional `?` placeholders.
|
|
@param values A @c NSArray of objects to be used when binding values to the `?` placeholders in the SQL statement.
|
|
@param error A @c NSError object to receive any error object (if any).
|
|
@return A @c FMResultSet for the result set upon success; @c nil upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see FMResultSet
|
@see [`FMResultSet next`](<[FMResultSet next]>)
|
|
@note When called from Swift, only use the first two parameters, `sql` and `values`. This but throws the error.
|
|
*/
|
|
- (FMResultSet * _Nullable)executeQuery:(NSString *)sql values:(NSArray * _Nullable)values error:(NSError * _Nullable __autoreleasing *)error;
|
|
/** Execute select statement
|
|
Executing queries returns an @c FMResultSet object if successful, and @c nil upon failure. Like executing updates, there is a variant that accepts an `NSError **` parameter. Otherwise you should use the @c lastErrorMessage and @c 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.
|
|
@param sql The SELECT statement to be performed, with optional `?` placeholders.
|
|
@param arguments A @c NSDictionary of objects keyed by column names that will be used when binding values to the `?` placeholders in the SQL statement.
|
|
@return A @c FMResultSet for the result set upon success; @c nil upon failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see FMResultSet
|
@see [`FMResultSet next`](<[FMResultSet next]>)
|
*/
|
|
- (FMResultSet * _Nullable)executeQuery:(NSString *)sql withParameterDictionary:(NSDictionary * _Nullable)arguments;
|
|
|
// Documentation forthcoming.
|
- (FMResultSet * _Nullable)executeQuery:(NSString *)sql withVAList:(va_list)args;
|
|
/// Prepare SQL statement.
|
///
|
/// @param sql SQL statement to prepare, generally with `?` placeholders.
|
|
- (FMResultSet *)prepare:(NSString *)sql;
|
|
///-------------------
|
/// @name Transactions
|
///-------------------
|
|
/** Begin a transaction
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see commit
|
@see rollback
|
@see beginDeferredTransaction
|
@see isInTransaction
|
|
@warning Unlike SQLite's `BEGIN TRANSACTION`, this method currently performs
|
an exclusive transaction, not a deferred transaction. This behavior
|
is likely to change in future versions of FMDB, whereby this method
|
will likely eventually adopt standard SQLite behavior and perform
|
deferred transactions. If you really need exclusive tranaction, it is
|
recommended that you use @c beginExclusiveTransaction, instead, not
|
only to make your intent explicit, but also to future-proof your code.
|
|
*/
|
|
- (BOOL)beginTransaction;
|
|
/** Begin a deferred transaction
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see commit
|
@see rollback
|
@see beginTransaction
|
@see isInTransaction
|
*/
|
|
- (BOOL)beginDeferredTransaction;
|
|
/** Begin an immediate transaction
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see commit
|
@see rollback
|
@see beginTransaction
|
@see isInTransaction
|
*/
|
|
- (BOOL)beginImmediateTransaction;
|
|
/** Begin an exclusive transaction
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see commit
|
@see rollback
|
@see beginTransaction
|
@see isInTransaction
|
*/
|
|
- (BOOL)beginExclusiveTransaction;
|
|
/** Commit a transaction
|
|
Commit a transaction that was initiated with either `<beginTransaction>` or with `<beginDeferredTransaction>`.
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see beginTransaction
|
@see beginDeferredTransaction
|
@see rollback
|
@see isInTransaction
|
*/
|
|
- (BOOL)commit;
|
|
/** Rollback a transaction
|
|
Rollback a transaction that was initiated with either `<beginTransaction>` or with `<beginDeferredTransaction>`.
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see beginTransaction
|
@see beginDeferredTransaction
|
@see commit
|
@see isInTransaction
|
*/
|
|
- (BOOL)rollback;
|
|
/** Identify whether currently in a transaction or not
|
|
@see beginTransaction
|
@see beginDeferredTransaction
|
@see commit
|
@see rollback
|
*/
|
|
@property (nonatomic, readonly) BOOL isInTransaction;
|
|
- (BOOL)inTransaction __deprecated_msg("Use isInTransaction property instead");
|
|
|
///----------------------------------------
|
/// @name Cached statements and result sets
|
///----------------------------------------
|
|
/** Clear cached statements */
|
|
- (void)clearCachedStatements;
|
|
/** Close all open result sets */
|
|
- (void)closeOpenResultSets;
|
|
/** Whether database has any open result sets
|
|
@return @c YES if there are open result sets; @c NO if not.
|
*/
|
|
@property (nonatomic, readonly) BOOL hasOpenResultSets;
|
|
/** Whether should cache statements or not
|
*/
|
|
@property (nonatomic) BOOL shouldCacheStatements;
|
|
/** Interupt pending database operation
|
|
This method causes any pending database operation to abort and return at its earliest opportunity
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
*/
|
|
- (BOOL)interrupt;
|
|
///-------------------------
|
/// @name Encryption methods
|
///-------------------------
|
|
/** Set encryption key.
|
|
@param key The key to be used.
|
|
@return @c YES if success, @c NO on error.
|
|
@see https://www.zetetic.net/sqlcipher/
|
|
@warning You need to have purchased the sqlite encryption extensions for this method to work.
|
*/
|
|
- (BOOL)setKey:(NSString*)key;
|
|
/** Reset encryption key
|
|
@param key The key to be used.
|
|
@return @c YES if success, @c NO on error.
|
|
@see https://www.zetetic.net/sqlcipher/
|
|
@warning You need to have purchased the sqlite encryption extensions for this method to work.
|
*/
|
|
- (BOOL)rekey:(NSString*)key;
|
|
/** Set encryption key using `keyData`.
|
|
@param keyData The @c NSData to be used.
|
|
@return @c YES if success, @c NO on error.
|
|
@see https://www.zetetic.net/sqlcipher/
|
|
@warning You need to have purchased the sqlite encryption extensions for this method to work.
|
*/
|
|
- (BOOL)setKeyWithData:(NSData *)keyData;
|
|
/** Reset encryption key using `keyData`.
|
|
@param keyData The @c NSData to be used.
|
|
@return @c YES if success, @c NO on error.
|
|
@see https://www.zetetic.net/sqlcipher/
|
|
@warning You need to have purchased the sqlite encryption extensions for this method to work.
|
*/
|
|
- (BOOL)rekeyWithData:(NSData *)keyData;
|
|
|
///------------------------------
|
/// @name General inquiry methods
|
///------------------------------
|
|
/** The path of the database file.
|
*/
|
|
@property (nonatomic, readonly, nullable) NSString *databasePath;
|
|
/** The file URL of the database file.
|
*/
|
|
@property (nonatomic, readonly, nullable) NSURL *databaseURL;
|
|
/** The underlying SQLite handle .
|
|
@return The `sqlite3` pointer.
|
|
*/
|
|
@property (nonatomic, readonly) void *sqliteHandle;
|
|
|
///-----------------------------
|
/// @name Retrieving error codes
|
///-----------------------------
|
|
/** 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.
|
|
@return @c NSString of the last error message.
|
|
@see [sqlite3_errmsg()](https://sqlite.org/c3ref/errcode.html)
|
@see lastErrorCode
|
@see lastError
|
|
*/
|
|
- (NSString*)lastErrorMessage;
|
|
/** 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.
|
|
@return Integer value of the last error code.
|
|
@see [sqlite3_errcode()](https://sqlite.org/c3ref/errcode.html)
|
@see lastErrorMessage
|
@see lastError
|
|
*/
|
|
- (int)lastErrorCode;
|
|
/** Last extended error code
|
|
Returns the numeric 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.
|
|
@return Integer value of the last extended error code.
|
|
@see [sqlite3_errcode()](https://sqlite.org/c3ref/errcode.html)
|
@see [2. Primary Result Codes versus Extended Result Codes](https://sqlite.org/rescode.html#primary_result_codes_versus_extended_result_codes)
|
@see [5. Extended Result Code List](https://sqlite.org/rescode.html#extrc)
|
@see lastErrorMessage
|
@see lastError
|
|
*/
|
|
- (int)lastExtendedErrorCode;
|
|
/** Had error
|
|
@return @c YES if there was an error, @c NO if no error.
|
|
@see lastError
|
@see lastErrorCode
|
@see lastErrorMessage
|
|
*/
|
|
- (BOOL)hadError;
|
|
/** Last error
|
|
@return @c NSError representing the last error.
|
|
@see lastErrorCode
|
@see lastErrorMessage
|
|
*/
|
|
- (NSError *)lastError;
|
|
|
// description forthcoming
|
@property (nonatomic) NSTimeInterval maxBusyRetryTimeInterval;
|
|
|
///------------------
|
/// @name Save points
|
///------------------
|
|
/** Start save point
|
|
@param name Name of save point.
|
|
@param outErr A @c NSError object to receive any error object (if any).
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see releaseSavePointWithName:error:
|
@see rollbackToSavePointWithName:error:
|
*/
|
|
- (BOOL)startSavePointWithName:(NSString*)name error:(NSError * _Nullable __autoreleasing *)outErr;
|
|
/** Release save point
|
|
@param name Name of save point.
|
|
@param outErr A @c NSError object to receive any error object (if any).
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see startSavePointWithName:error:
|
@see rollbackToSavePointWithName:error:
|
|
*/
|
|
- (BOOL)releaseSavePointWithName:(NSString*)name error:(NSError * _Nullable __autoreleasing *)outErr;
|
|
/** Roll back to save point
|
|
@param name Name of save point.
|
@param outErr A @c NSError object to receive any error object (if any).
|
|
@return @c YES on success; @c NO on failure. If failed, you can call @c lastError , @c lastErrorCode , or @c lastErrorMessage for diagnostic information regarding the failure.
|
|
@see startSavePointWithName:error:
|
@see releaseSavePointWithName:error:
|
|
*/
|
|
- (BOOL)rollbackToSavePointWithName:(NSString*)name error:(NSError * _Nullable __autoreleasing *)outErr;
|
|
/** Start save point
|
|
@param block Block of code to perform from within save point.
|
|
@return The NSError corresponding to the error, if any. If no error, returns @c nil .
|
|
@see startSavePointWithName:error:
|
@see releaseSavePointWithName:error:
|
@see rollbackToSavePointWithName:error:
|
|
*/
|
|
- (NSError * _Nullable)inSavePoint:(__attribute__((noescape)) void (^)(BOOL *rollback))block;
|
|
|
///-----------------
|
/// @name Checkpoint
|
///-----------------
|
|
/** Performs a WAL checkpoint
|
|
@param checkpointMode The checkpoint mode for @c sqlite3_wal_checkpoint_v2
|
@param error The @c NSError corresponding to the error, if any.
|
@return @c YES on success, otherwise @c NO .
|
*/
|
- (BOOL)checkpoint:(FMDBCheckpointMode)checkpointMode error:(NSError * _Nullable *)error;
|
|
/** Performs a WAL checkpoint
|
|
@param checkpointMode The checkpoint mode for @c sqlite3_wal_checkpoint_v2
|
@param name The db name for @c sqlite3_wal_checkpoint_v2
|
@param error The @c NSError corresponding to the error, if any.
|
@return @c YES on success, otherwise @c NO .
|
*/
|
- (BOOL)checkpoint:(FMDBCheckpointMode)checkpointMode name:(NSString * _Nullable)name error:(NSError * _Nullable *)error;
|
|
/** Performs a WAL checkpoint
|
|
@param checkpointMode The checkpoint mode for sqlite3_wal_checkpoint_v2
|
@param name The db name for sqlite3_wal_checkpoint_v2
|
@param error The NSError corresponding to the error, if any.
|
@param logFrameCount If not @c NULL , then this is set to the total number of frames in the log file or to -1 if the checkpoint could not run because of an error or because the database is not in WAL mode.
|
@param checkpointCount If not @c NULL , then this is set to the total number of checkpointed frames in the log file (including any that were already checkpointed before the function was called) or to -1 if the checkpoint could not run due to an error or because the database is not in WAL mode.
|
@return @c YES on success, otherwise @c NO .
|
*/
|
- (BOOL)checkpoint:(FMDBCheckpointMode)checkpointMode name:(NSString * _Nullable)name logFrameCount:(int * _Nullable)logFrameCount checkpointCount:(int * _Nullable)checkpointCount error:(NSError * _Nullable *)error;
|
|
///----------------------------
|
/// @name SQLite library status
|
///----------------------------
|
|
/** Test to see if the library is threadsafe
|
|
@return @c NO if and only if SQLite was compiled with mutexing code omitted due to the @c SQLITE_THREADSAFE compile-time option being set to 0.
|
|
@see [sqlite3_threadsafe()](https://sqlite.org/c3ref/threadsafe.html)
|
*/
|
|
+ (BOOL)isSQLiteThreadSafe;
|
|
/** Examine/set limits
|
|
@param type The type of limit. See https://sqlite.org/c3ref/c_limit_attached.html
|
@param newLimit The new limit value. Use -1 if you don't want to change the limit, but rather only want to check it.
|
|
@return Regardless, returns previous value.
|
|
@see [sqlite3_limit()](https://sqlite.org/c3ref/limit.html)
|
*/
|
|
- (int)limitFor:(int)type value:(int)newLimit;
|
|
/** Run-time library version numbers
|
|
@return The sqlite library version string.
|
|
@see [sqlite3_libversion()](https://sqlite.org/c3ref/libversion.html)
|
*/
|
|
+ (NSString*)sqliteLibVersion;
|
|
/// The FMDB version number as a string in the form of @c "2.7.8" .
|
///
|
/// If you want to compare version number strings, you can use NSNumericSearch option:
|
///
|
/// @code
|
/// NSComparisonResult result = [[FMDatabase FMDBUserVersion] compare:@"2.11.0" options:NSNumericSearch];
|
/// @endcode
|
///
|
/// @returns The version number string.
|
|
+ (NSString*)FMDBUserVersion;
|
|
/** The FMDB version
|
|
This returns the FMDB as hexadecimal value, e.g., @c 0x0243 for version 2.4.3.
|
|
@warning This routine will not work if any component of the version number exceeds 15.
|
For example, if it is version @c 2.17.3 , this will max out at @c 0x2f3.
|
For this reason, we would recommend using @c FMDBUserVersion and with @c NSNumericSearch option, e.g.
|
|
@code
|
NSComparisonResult result = [[FMDatabase FMDBUserVersion] compare:@"2.11.0" options:NSNumericSearch];
|
@endcode
|
|
@returns The version number in hexadecimal, e.g., @c 0x0243 for version 2.4.3. If any component exceeds what can be
|
can be represented in four bits, we'll max it out at @c 0xf .
|
*/
|
|
+ (SInt32)FMDBVersion __deprecated_msg("Use FMDBUserVersion instead");
|
|
///------------------------
|
/// @name Make SQL function
|
///------------------------
|
|
/** Adds SQL functions or aggregates or to redefine the behavior of existing SQL functions or aggregates.
|
|
For example:
|
|
@code
|
[db makeFunctionNamed:@"RemoveDiacritics" arguments:1 block:^(void *context, int argc, void **argv) {
|
SqliteValueType type = [self.db valueType:argv[0]];
|
if (type == SqliteValueTypeNull) {
|
[self.db resultNullInContext:context];
|
return;
|
}
|
if (type != SqliteValueTypeText) {
|
[self.db resultError:@"Expected text" context:context];
|
return;
|
}
|
NSString *string = [self.db valueString:argv[0]];
|
NSString *result = [string stringByFoldingWithOptions:NSDiacriticInsensitiveSearch locale:nil];
|
[self.db resultString:result context:context];
|
}];
|
|
FMResultSet *rs = [db executeQuery:@"SELECT * FROM employees WHERE RemoveDiacritics(first_name) LIKE 'jose'"];
|
NSAssert(rs, @"Error %@", [db lastErrorMessage]);
|
@endcode
|
|
@param name Name of function.
|
|
@param arguments Maximum number of parameters.
|
|
@param block The block of code for the function.
|
|
@see [sqlite3_create_function()](https://sqlite.org/c3ref/create_function.html)
|
*/
|
|
- (void)makeFunctionNamed:(NSString *)name arguments:(int)arguments block:(void (^)(void *context, int argc, void * _Nonnull * _Nonnull argv))block;
|
|
- (void)makeFunctionNamed:(NSString *)name maximumArguments:(int)count withBlock:(void (^)(void *context, int argc, void * _Nonnull * _Nonnull argv))block __deprecated_msg("Use makeFunctionNamed:arguments:block:");
|
|
- (SqliteValueType)valueType:(void *)argv;
|
|
/**
|
Get integer value of parameter in custom function.
|
|
@param value The argument whose value to return.
|
@return The integer value.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (int)valueInt:(void *)value;
|
|
/**
|
Get long value of parameter in custom function.
|
|
@param value The argument whose value to return.
|
@return The long value.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (long long)valueLong:(void *)value;
|
|
/**
|
Get double value of parameter in custom function.
|
|
@param value The argument whose value to return.
|
@return The double value.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (double)valueDouble:(void *)value;
|
|
/**
|
Get @c NSData value of parameter in custom function.
|
|
@param value The argument whose value to return.
|
@return The data object.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (NSData * _Nullable)valueData:(void *)value;
|
|
/**
|
Get string value of parameter in custom function.
|
|
@param value The argument whose value to return.
|
@return The string value.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (NSString * _Nullable)valueString:(void *)value;
|
|
/**
|
Return null value from custom function.
|
|
@param context The context to which the null value will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultNullInContext:(void *)context NS_SWIFT_NAME(resultNull(context:));
|
|
/**
|
Return integer value from custom function.
|
|
@param value The integer value to be returned.
|
@param context The context to which the value will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultInt:(int) value context:(void *)context;
|
|
/**
|
Return long value from custom function.
|
|
@param value The long value to be returned.
|
@param context The context to which the value will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultLong:(long long)value context:(void *)context;
|
|
/**
|
Return double value from custom function.
|
|
@param value The double value to be returned.
|
@param context The context to which the value will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultDouble:(double)value context:(void *)context;
|
|
/**
|
Return @c NSData object from custom function.
|
|
@param data The @c NSData object to be returned.
|
@param context The context to which the value will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultData:(NSData *)data context:(void *)context;
|
|
/**
|
Return string value from custom function.
|
|
@param value The string value to be returned.
|
@param context The context to which the value will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultString:(NSString *)value context:(void *)context;
|
|
/**
|
Return error string from custom function.
|
|
@param error The error string to be returned.
|
@param context The context to which the error will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultError:(NSString *)error context:(void *)context;
|
|
/**
|
Return error code from custom function.
|
|
@param errorCode The integer error code to be returned.
|
@param context The context to which the error will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultErrorCode:(int)errorCode context:(void *)context;
|
|
/**
|
Report memory error in custom function.
|
|
@param context The context to which the error will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultErrorNoMemoryInContext:(void *)context NS_SWIFT_NAME(resultErrorNoMemory(context:));
|
|
/**
|
Report that string or BLOB is too long to represent in custom function.
|
|
@param context The context to which the error will be returned.
|
|
@see makeFunctionNamed:arguments:block:
|
*/
|
- (void)resultErrorTooBigInContext:(void *)context NS_SWIFT_NAME(resultErrorTooBig(context:));
|
|
///---------------------
|
/// @name Date formatter
|
///---------------------
|
|
/** Generate an @c NSDateFormatter that won't be broken by permutations of timezones or locales.
|
|
Use this method to generate values to set the dateFormat property.
|
|
Example:
|
|
@code
|
myDB.dateFormat = [FMDatabase storeableDateFormat:@"yyyy-MM-dd HH:mm:ss"];
|
@endcode
|
|
@param format A valid NSDateFormatter format string.
|
|
@return A @c NSDateFormatter that can be used for converting dates to strings and vice versa.
|
|
@see hasDateFormatter
|
@see setDateFormat:
|
@see dateFromString:
|
@see stringFromDate:
|
@see storeableDateFormat:
|
|
@warning Note that @c NSDateFormatter is not thread-safe, so the formatter generated by this method should be assigned to only one FMDB instance and should not be used for other purposes.
|
|
*/
|
|
+ (NSDateFormatter *)storeableDateFormat:(NSString *)format;
|
|
/** Test whether the database has a date formatter assigned.
|
|
@return @c YES if there is a date formatter; @c NO if not.
|
|
@see hasDateFormatter
|
@see setDateFormat:
|
@see dateFromString:
|
@see stringFromDate:
|
@see storeableDateFormat:
|
*/
|
|
- (BOOL)hasDateFormatter;
|
|
/** Set to a date formatter to use string dates with sqlite instead of the default UNIX timestamps.
|
|
@param format Set to nil to use UNIX timestamps. Defaults to nil. Should be set using a formatter generated using @c FMDatabase:storeableDateFormat .
|
|
@see hasDateFormatter
|
@see setDateFormat:
|
@see dateFromString:
|
@see stringFromDate:
|
@see storeableDateFormat:
|
|
@warning Note there is no direct getter for the @c NSDateFormatter , and you should not use the formatter you pass to FMDB for other purposes, as @c NSDateFormatter is not thread-safe.
|
*/
|
|
- (void)setDateFormat:(NSDateFormatter * _Nullable)format;
|
|
/** Convert the supplied NSString to NSDate, using the current database formatter.
|
|
@param s @c NSString to convert to @c NSDate .
|
|
@return The @c NSDate object; or @c nil if no formatter is set.
|
|
@see hasDateFormatter
|
@see setDateFormat:
|
@see dateFromString:
|
@see stringFromDate:
|
@see storeableDateFormat:
|
*/
|
|
- (NSDate * _Nullable)dateFromString:(NSString *)s;
|
|
/** Convert the supplied NSDate to NSString, using the current database formatter.
|
|
@param date @c NSDate of date to convert to @c NSString .
|
|
@return The @c NSString representation of the date; @c nil if no formatter is set.
|
|
@see hasDateFormatter
|
@see setDateFormat:
|
@see dateFromString:
|
@see stringFromDate:
|
@see storeableDateFormat:
|
*/
|
|
- (NSString * _Nullable)stringFromDate:(NSDate *)date;
|
|
@end
|
|
|
/** Objective-C wrapper for @c sqlite3_stmt
|
|
This is a wrapper for a SQLite @c sqlite3_stmt . Generally when using FMDB you will not need to interact directly with `FMStatement`, but rather with @c FMDatabase and @c FMResultSet only.
|
|
See also
|
|
- @c FMDatabase
|
- @c FMResultSet
|
- [@c sqlite3_stmt ](https://sqlite.org/c3ref/stmt.html)
|
*/
|
|
@interface FMStatement : NSObject {
|
void *_statement;
|
NSString *_query;
|
long _useCount;
|
BOOL _inUse;
|
}
|
|
///-----------------
|
/// @name Properties
|
///-----------------
|
|
/** Usage count */
|
|
@property (atomic, assign) long useCount;
|
|
/** SQL statement */
|
|
@property (atomic, retain) NSString *query;
|
|
/** SQLite sqlite3_stmt
|
|
@see [@c sqlite3_stmt ](https://sqlite.org/c3ref/stmt.html)
|
*/
|
|
@property (atomic, assign) void *statement;
|
|
/** Indication of whether the statement is in use */
|
|
@property (atomic, assign) BOOL inUse;
|
|
///----------------------------
|
/// @name Closing and Resetting
|
///----------------------------
|
|
/** Close statement */
|
|
- (void)close;
|
|
/** Reset statement */
|
|
- (void)reset;
|
|
@end
|
|
#pragma clang diagnostic pop
|
|
NS_ASSUME_NONNULL_END
|
