SQLite Techniques

SQLite Techniques

Ben Scheirman
@subdigital

Code / Slides:
github.com/subdigital/iphonedevcon-
sandiego

Tuesday, September 28, 2010

SQLite is....

Single-user

File-based

Simple

Cross Platform

A subset of full ANSI SQL


SQLite API

Pure C API

Lots of strange-looking, hard to
debug code

Best choice is to abstract it away


SQLite Tools

SQLite Manager Add-in for Firefox

sqlite3 command line utility


Writable Databases

Your app bundle is signed!

(That means the contents can't
change)


Your App Sandbox

Your App Bundle

Resources
Documents


Creating the
database


Getting Resource
Paths


Getting Resource
Paths

//fetches
path
for
foo.db


Getting Resource
Paths

//fetches
path
for
foo.db
NSString
*resourcePath
=
[[NSBundle
mainBundle]


Getting Resource
Paths

//fetches
path
for
foo.db
NSString
*resourcePath
=
[[NSBundle
mainBundle]

pathForResource:@"foo"


Getting Resource
Paths

//fetches
path
for
foo.db
NSString
*resourcePath
=
[[NSBundle
mainBundle]

pathForResource:@"foo"

ofType:@"db"];


Finding the Documents
Directory


Directory

NSArray
*paths
=
NSSearchPathForDirectoriesInDomains(


Directory

NSArray
*paths
=

NSDocumentDirectory,


Directory

NSArray
*paths
=


NSUserDomainMask,


Directory

NSArray
*paths
=


NSUserDomainMask,

YES);


Directory

NSArray
*paths
=


NSUserDomainMask,

YES);

NSString
*documentsDirectory
=
[paths
objectAtIndex:0];


Copy a default
database on startup


Copy a default
database on startup
//in applicationDidFinishLaunching

NSString *sourcePath = [[NSBundle mainBundle]
pathForResource:@"app" ofType:@"db"];

NSString *targetPath = ...
NSFileManager *fm = [NSFileManager defaultManager];

if(![fm fileExistsAtPath:targetPath]) {
[fm copyItemAtPath:sourcePath toPath:targetPath error:&error];
}


SQLite API Basics


Add the Framework


SQLite API -
Opening a connection


SQLite API -
#import "sqlite3.h"


SQLite API -
#import "sqlite3.h"

sqlite3 *db;


SQLite API -
#import "sqlite3.h"

sqlite3 *db;

int result = sqlite3_open(PATH, &db);


SQLite API -
#import "sqlite3.h"

sqlite3 *db;

if (result != SQLITE_OK) {


SQLite API -
#import "sqlite3.h"

sqlite3 *db;

[NSException raise:@"SQLITE ERROR"


SQLite API -
#import "sqlite3.h"

sqlite3 *db;

format:@"Error %d", result];


SQLite API -
#import "sqlite3.h"

sqlite3 *db;

}


SQLite API -
#import "sqlite3.h"

sqlite3 *db;

}

//later


SQLite API -
#import "sqlite3.h"

sqlite3 *db;

}

//later
sqlite3_close(db);


SQLite API -
executing queries


SQLite API -
executing queries
int sqlite3_exec(


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
int (*callback)(void *, int, char**, char**) callbackFunc,


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
void *context,


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
void *context,
char **errorMessage


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
void *context,
char **errorMessage
);


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
void *context,
char **errorMessage
);

//callback signature


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
void *context,
char **errorMessage
);

int RowCallback(void * context,


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
void *context,
char **errorMessage
);

int numColumns,


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
void *context,
char **errorMessage
);

int numColumns,
char** colValues,


SQLite API -
executing queries
int sqlite3_exec(
sqlite3 *db,
char *sql,
void *context,
char **errorMessage
);

int numColumns,
char** colValues,
char ** colNames);


SQLite API -
Prepared Statements

More Powerful

Unfortunately much more code!


SQLite API-Prepared Statements



sqlite3 *db;



sqlite3 *db;
int result = sqlite3_open(DB_PATH, &db);



sqlite3 *db;
if(result != SQLITE_OK) {



sqlite3 *db;
//handle error



sqlite3 *db;
//handle error
}



sqlite3 *db;
//handle error
}

sqlite3_stmt *stmt;



sqlite3 *db;
//handle error
}

sqlite3_stmt *stmt;
result = sqlite3_prepare_v2(db, sql_cstring, -1, &stmt, NULL);



sqlite3 *db;
//handle error
}

sqlite3_stmt *stmt;



sqlite3 *db;
//handle error
}

sqlite3_stmt *stmt;
//handle error



sqlite3 *db;
//handle error
}

sqlite3_stmt *stmt;
//handle error
}



sqlite3 *db;
//handle error
}

sqlite3_stmt *stmt;
//handle error
}

//...


//INSERT INTO CARS(year, make) VALUES(?, ?)



//PARAMETERS HAVE A 1-BASED INDEX!



sqlite3_bind_int(stmt, 1 /* idx */, 5);



sqlite3_bind_text(stmt, 2 /* idx */,"value", -1, SQLITE_TRANSIENT);




result = sqlite3_step(stmt);




if(result == SQLITE_DONE)




return [NSArray array]; //nothing to do!





NSMutableArray *results = [NSMutableArray array];





while(result == SQLITE_ROW) {





NSMutableDictionary *row = [NSMutableDictionary dictionary];






[self processRow:row forStatement:stmt];







[results addObject:row];







}







}

sqlite_finalize(stmt);







}

sqlite_finalize(stmt);

return results;


-(void)processRow:(NSMutableDictionary *)row forStatement:
(sqlite3_stmt*)stmt {



int columnCount = sqlite3_column_count(stmt);



for(int i=0; i<columnCount; i++) {



//0-based index!



//0-based index!
const char * colName = sqlite3_column_name(stmt, i);



//0-based index!
int type = sqlite3_column_type(stmt, i);



//0-based index!

id value = [NSNull null];



//0-based index!

if(type == SQLITE_INTEGER) {



//0-based index!

value = [NSNumber numberWithInt:sqlite3_column_int(stmt, i)];



//0-based index!

} else if (type == SQLITE_TEXT) {



//0-based index!

const unsigned char * text = sqlite3_column_text(stmt, i);



//0-based index!

value = [NSString stringWithFormat:@"%s", text];



//0-based index!

} else {



//0-based index!

} else {
// more type handling



//0-based index!

} else {
}



//0-based index!

} else {
}
[row setObject:value forKey:



//0-based index!

} else {
}
[NSString stringWithUTF8String:colName]];



//0-based index!

} else {
}
}



//0-based index!

} else {
}
}
}

FMDB

http://github.com/ccgus/fmdb


FMDB Usage


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


FMDB Usage
if (![db open])


FMDB Usage
  if (![db open])
     NSLog(@"Could not open db.");


FMDB Usage
  if (![db open])

  [db executeUpdate:@"blah blah blah"];


FMDB Usage
  if (![db open])




FMDB Usage
  if (![db open])


  if ([db hadError])


FMDB Usage
  if (![db open])


  if ([db hadError])
   NSLog(@"Err %d: %@", [db lastErrorCode],


FMDB Usage
  if (![db open])


  if ([db hadError])
[db lastErrorMessage]);


FMDB Usage
  if (![db open])


  if ([db hadError])

  [db executeUpdate:@"create table test (a text, b integer)"];


FMDB Usage
  if (![db open])


  if ([db hadError])


  [db beginTransaction];


FMDB Usage
  if (![db open])


  if ([db hadError])


  int i = 0;


FMDB Usage
  if (![db open])


  if ([db hadError])


  int i = 0;
  while (i++ < 20) {


FMDB Usage
  if (![db open])


  if ([db hadError])


  int i = 0;
  while (i++ < 20) {
  [db executeUpdate:@"insert into test (a, b) values (?, ?)" ,


FMDB Usage
  if (![db open])


  if ([db hadError])


  int i = 0;
  while (i++ < 20) {
       @"hi'", // look! I put in a ', and I'm not escaping it!


FMDB Usage
  if (![db open])


  if ([db hadError])


  int i = 0;
  while (i++ < 20) {
       [NSNumber numberWithInt:i]];


FMDB Usage
  if (![db open])


  if ([db hadError])


  int i = 0;
  while (i++ < 20) {
  }


FMDB Usage
  if (![db open])


  if ([db hadError])


  int i = 0;
  while (i++ < 20) {
  }
  [db commit];

What about updates?

Database is never copied over again

If we did, your customers would lose
data


Migrations

Concept from Ruby on Rails

Evolutionary database design

Each database has a "version"

App runs all migrations to the latest
version


Migrations

number name
1 initial_schema
2 update_foo
3 implement_blah


Hand-rolled Database
Migrator

DEMO


FMDB Migration
Manager

http://github.com/mocra/fmdb-
migration-manager


FMDB Migration
Manager

NSArray *migrations = [NSArray arrayWithObjects:
[CreateStudents migration], // 1
[CreateStaffMembers migration], // 2
[AddStudentNumberToStudents migration], // 3
nil
];
[FmdbMigrationManager executeForDatabasePath:@"/tmp/tmp.db"
withMigrations:migrations];


FMDB Migration
Manager
@interface CreateStudents : FmdbMigration
{
}
@end

@implementation CreateStudents
- (void)up {
[self createTable:@"students" withColumns:[NSArray arrayWithObjects:
[FmdbMigrationColumn columnWithColumnName:@"first_name" columnType:@"string"],
[FmdbMigrationColumn columnWithColumnName:@"age" columnType:@"integer"
defaultValue:21], nil];
}

- (void)down {
[self dropTable:@"students"];
}

@end


ActiveRecord

Person *p = [[Person alloc] init];
p.name = @"Joe";
p.occupation = @"Dishwasher";

[p save];

Person *p = [Person personWithId:5];
==> Person {id:5, name:Joe, occupation:Dishwasher}


Aptiva's ActiveRecord

http://github.com/aptiva/activerecord

(YMMV)


Questions?


SQLite Techniques

More Related Content

What's hot (20)

Similar to SQLite Techniques (20)

More from joaopmaia (6)

Recently uploaded (20)

SQLite Techniques