src/FMDatabase.h

   1 #import <Foundation/Foundation.h>
   2 #import "sqlite3.h"
   3 #import "FMResultSet.h"
   4
   5 @interface FMDatabase : NSObject
   6 {
   7         sqlite3*    db;
   8         NSString*   databasePath;
   9     BOOL        logsErrors;
  10     BOOL        crashOnErrors;
  11     BOOL        inUse;
  12     BOOL        inTransaction;
  13     BOOL        traceExecution;
  14     BOOL        checkedOut;
  15     int         busyRetryTimeout;
  16     BOOL        shouldCacheStatements;
  17     NSMutableDictionary *cachedStatements;
  18 }
  19
  20
  21 + (id)databaseWithPath:(NSString*)inPath;
  22 - (id)initWithPath:(NSString*)inPath;
  23
  24 - (BOOL) open;
  25 - (void) close;
  26 - (BOOL) goodConnection;
  27 - (void) clearCachedStatements;
  28
  29 // encryption methods.  You need to have purchased the sqlite encryption extensions for these to work.
  30 - (BOOL) setKey:(NSString*)key;
  31 - (BOOL) rekey:(NSString*)key;
  32
  33
  34 - (NSString *) databasePath;
  35
  36 - (NSString*) lastErrorMessage;
  37
  38 - (int) lastErrorCode;
  39 - (BOOL) hadError;
  40 - (sqlite_int64) lastInsertRowId;
  41
  42 - (sqlite3*) sqliteHandle;
  43
  44 - (BOOL) executeUpdate:(NSString *)sql arguments:(va_list)args;
  45 - (BOOL) executeUpdate:(NSString*)sql, ...;
  46
  47 - (id) executeQuery:(NSString *)sql arguments:(va_list)args;
  48 - (id) executeQuery:(NSString*)sql, ...;
  49
  50 - (BOOL) rollback;
  51 - (BOOL) commit;
  52 - (BOOL) beginTransaction;
  53 - (BOOL) beginDeferredTransaction;
  54
  55 - (BOOL)logsErrors;
  56 - (void)setLogsErrors:(BOOL)flag;
  57
  58 - (BOOL)crashOnErrors;
  59 - (void)setCrashOnErrors:(BOOL)flag;
  60
  61 - (BOOL)inUse;
  62 - (void)setInUse:(BOOL)value;
  63
  64 - (BOOL)inTransaction;
  65 - (void)setInTransaction:(BOOL)flag;
  66
  67 - (BOOL)traceExecution;
  68 - (void)setTraceExecution:(BOOL)flag;
  69
  70 - (BOOL)checkedOut;
  71 - (void)setCheckedOut:(BOOL)flag;
  72
  73 - (int)busyRetryTimeout;
  74 - (void)setBusyRetryTimeout:(int)newBusyRetryTimeout;
  75
  76 - (BOOL)shouldCacheStatements;
  77 - (void)setShouldCacheStatements:(BOOL)value;
  78
  79 - (NSMutableDictionary *)cachedStatements;
  80 - (void)setCachedStatements:(NSMutableDictionary *)value;
  81
  82
  83 + (NSString*) sqliteLibVersion;
  84
  85
  86
  87 @end
  88
  89 @interface FMStatement : NSObject {
  90     sqlite3_stmt *statement;
  91     NSString *query;
  92     long useCount;
  93 }
  94
  95
  96 - (void) close;
  97 - (void) reset;
  98
  99 - (sqlite3_stmt *)statement;
 100 - (void)setStatement:(sqlite3_stmt *)value;
 101
 102 - (NSString *)query;
 103 - (void)setQuery:(NSString *)value;
 104
 105 - (long)useCount;
 106 - (void)setUseCount:(long)value;
 107
 108
 109
 110 @end
 111