Close Menu

ocmapper

The OCMapper is a powerful object-relational mapping (ORM) library for iOS and macOS development. It provides a seamless interface between your code and a SQLite database, making it easier to manage the storage and retrieval of data in your applications.

Features

  • Effortlessly map objects to database tables
  • Simplify data manipulation with object-oriented techniques
  • Supports relationships between objects
  • Manage database schema migrations
  • Perform efficient database queries using a concise and expressive syntax
  • Supports multi-threaded applications

Getting Started

Follow the steps below to start using the OCMapper library in your iOS or macOS application:

Step 1: Installation

To install OCMapper in your project, add the following line to your Podfile:

pod 'OCMapper'

Then run the following command in your project directory:

pod install

Step 2: Importing

In the file where you want to use OCMapper, import the library using the following line:

#import <OCMapper/OCMapper.h>

Step 3: Mapping your Objects

To map your custom objects to database tables, you need to define a mapping configuration. Below is an example of how you can create a mapping using OCMapper’s fluent interface:


[objectMappingProvider mapClassName:@"YourObject" toTableName:@"your_table_name"];

Step 4: Database Operations

You can perform various database operations using OCMapper. Below are some examples:

  • Insert: Use the following code to insert an object into the database:


[[[[OMInsert alloc] initWithObject:yourObject] save];

  • Update: Use the following code to update an existing object in the database:


[[[[OMUpdate alloc] initWithObject:yourObject] save];

  • Delete: Use the following code to delete an object from the database:


[[[[OMDelete alloc] initWithObject:yourObject] save];

  • Retrieve: Use the following code to retrieve objects matching a certain criteria:


NSArray *results = [YourObject where:@"name = %@", @"John"];

Step 5: Relationships

OCMapper supports relationships between objects. You can define relationships using the following types: One-to-One, One-to-Many, Many-to-One, and Many-to-Many. To set up relationships, you can use the relationMappings property in your mapping configuration. Below is an example:


[objectMappingProvider mapClassName:@"YourObject" toTableName:@"your_table_name"];
[objectMappingProvider mapRelationship:@"your_object_id" with:@"YourRelatedObject"];

With the above configuration, you can retrieve related objects using the following code:


YourRelatedObject *relatedObject = [yourObject valueForKey:@"your_object_id"];

Conclusion

The OCMapper library simplifies object-relational mapping in iOS and macOS projects. It provides a convenient and efficient way to work with SQLite databases and manage your application’s data. With its support for relationships and a concise querying syntax, OCMapper helps you build robust and scalable applications with ease.