OLCOrm v1.0.4

[](https://travis-ci.org/Lakitha Samarasinghe/OLCOrm)

Usage

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

Dependencies

FMDB - https://github.com/ccgus/fmdb

pod "FMDB"

Installation

OLCOrm is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "OLCOrm"

What's new ?

2016-02-07

OneToOne relationship bug fixed. Crashlytics removed.

2015-12-01

Ignore list related bug fixed.

2015-10-22

CRUD Operation listeners added. Not you can subscribe to these listen to monitor any changes happening to the specified table. Primary Ket can be specified. Ignoring object properties are possible. Debugger is now enabled to table level for more convenience. Relationship mapping logic updated. (Please note; current methods are changed accordingly)

2016-04-01

Header files updated to support Swift 2.0, still need to test and confirm on that. Spelling mistakes corrected.

2015-08-07

Minor bug fixes.

2015-04-06

Now you can save NSArray, NSSet, NSData and UIImage object in the database!

2014-10-15

Required minimum version downgraded to ios 7.0

2014-10-14

NSDate failing to retrieve from database issue fixed.

2014-09-29

Lib updated to prevent sql injection.

2014-09-15

Now truncating tables are possible. This will reset the auto incremental id value as well.

2014-08-19

Basic relationship mapping added to the lib. One-to-One and One-to-Many relations.

Usage

There are two main classes in OLCOrm

1. 'OLCMigrator' - which handles the the database and table create part.
2. 'OCLModel' - Model class that you need to extend your model classes from.

** Creating the database **

import the "OLCMigrator.h" class first.

Creating a database is pretty straightforward, all you need to do is add this line to your AppDelegate.m file, at 'didFinishLaunchingWithOptions' method.

OLCMigrator *dbH = [OLCMigrator sharedInstance:@"olcdemo.sqlite" version:[NSNumber numberWithInt:1] enableDebug:NO];
[dbH initDb];

here 'version' is the database version that you must manage. Normaly you will need to update this as you update your model classes. *WARNING: When you update your model and run the app again, it will drop all tables from the database and add them back with updates.

** Creating the Tables **

After you add the code to create the database, add this line to create the table.

[dbH makeTable:[TestObject class]];

Or

[dbH makeTable:[[TestObject class] ] withTableVersion:[NSNumber numberWithInt:1]]

First option is the strait foward way of creating a table and let the database init code to handle the table versioning part. But you can always maitain the table versioning manually like this.

** Inserting a Record **

TestObject *test = [[TestObject alloc] init];

test.title = [NSString stringWithFormat:@"Sample Record %d", [records count]];
test.coordinates = [NSNumber numberWithDouble:234.345345];
test.currency = [NSNumber numberWithFloat:150.00];
test.flag = [NSNumber numberWithInt:1];
test.addAt = [NSDate date];
test.link = [NSURL URLWithString:@"http://google.com"];
test.status = [NSNumber numberWithInt:1];

return [test save];

** Update a Record **

test.title = @"Updated title";
[test update];

** Delete Record **

[test delete];

** Querying the Database **

NSArray *allRecords = [TestObject all];

TestObject *findObj = [TestObject find:[NSNumber numberWithInt:1]];

NSArray *searchObjs = [TestObject whereColumn:@"search_column" byOperator:@">=" forValue:@"4"];

NSArray *searchObjs = [TestObject where:@"column_1 = 2 AND column_2 > 12" sortBy:@"column_1 ASC"];

NSArray *searchObjs = [TestObject query:@"SELECT * FROM myTable WHERE STATUS = 1"];

** Working with Relationships **

One-to-One

[self hasOne:<Model class> foreignKeyCol:<Foreign Key> primaryKeyCol:<Primary Key>]

Exsample:

Add this method to your model class

- (UserObject *) hasUser
{
    return (UserObject*) [self hasOne:[UserObject class] foreignKeyCol:@"userId" primaryKeyCol:@"Id"];
}

One-to-Many

[self hasMany:<Model class> foreignKeyCol:<Foreign Key> primaryKeyCol:<Primary Key>];

Exsample:

Add this method to your model class

- (NSArray *) hasTests
{
    return [self hasMany:[TestObject class] foreignKeyCol:@"userId" primaryKeyCol:@"Id"];
}

Primary Key

Now you can specify the primary key property of and object by overiding the method '+ (NSString *) primaryKey' and returning the key you want, by default this is set to 'Id';

+ (NSString *) primaryKey
{
    return @"CustomKey";
}

Ignoring properties

You can have temparary values that need to be stored in an object at runtime that you don't need to save to the database. To ignore thoes properties you can overide the method '+ (NSArray *) ignoredProperties' and return an array of property names

+ (NSArray *) ignoredProperties
{
    return @[@"status"];
}

Enabling debug mode for the object

To enable debug mode for a specific object you can overid the method '+ (BOOL) debug' and return YES to enable it, by default this is set to NO;

+ (BOOL) debug
{
    return YES;
}

Notifications

OLCOrm instances send out notifications to other instances on other threads every time a crud transaction is committed. These notifications can be observed by registering a to notifications:

Registering;

[TestObject notifyOnChanges:self withMethod:@selector(testNotificationListner:)];

Unregistering;

    [TestObject removeNotifyer:self];

Special Thanks

Special thanks goes to 'ccgus' for the awesome FMDB database warpper library. And to 'kevinejohn' for his NSObject-KJSerializer (https://github.com/kevinejohn/NSObject-KJSerializer) utlity class.

Note

We all know the working with Core Data is major pain in the neck. Yet it is in a way bit easy you work with, if you get an hold of how it actaully work, working with only model calsses to update the database structre on the fly.

And for those who hate to use Core Data, FMDB is you best choice. But still it lack the capability of mapping objects to models. So you have to manullay create the databas and queries, ah.

So I develop this Libaray as an wrapper library to FMDB, that handle the database, table & all other CRUD function that we use daily. To make you life easire.

This libaray is still at it early stages (not even Alpha) so you are always welcome to teak thigs here and there to make this better :).

Happy Coding.

Author

Lakitha Samarasinghe, lakitharav@gmail.com

License

OLCOrm is available under the MIT license. See the LICENSE file for more info.