Close Menu

sugarrecord


SugarRecord is a lightweight and easy-to-use framework for managing the persistence layer in your iOS app. It provides a fluent interface that allows you to store and retrieve objects from a database without writing complex SQL queries.

Installation

To install SugarRecord, you can use CocoaPods. Simply add the following line to your Podfile:

pod 'SugarRecord'

Then, run the command pod install in your terminal.

Getting Started

Once you’ve installed SugarRecord, you can start using it in your project. Here’s a quick guide to help you get started:

Setting Up The Stack

The first step is to set up the database stack. SugarRecord supports multiple stack configurations, including SQLite and in-memory stores.

Here’s an example of how to set up a SQLite stack:

SugarRecord.setupCoreDataStack()

Creating Entities

To define an entity, you need to create a Swift class that subclasses the SugarRecord’s BaseEntity class. You can then use properties to define the attributes of the entity.

Here’s an example of a User entity:


// User.swift
import SugarRecord

class User: BaseEntity {
@objc dynamic var name: String = ""
@objc dynamic var email: String = ""
}

Saving and Retrieving Entities

SugarRecord provides a simple and intuitive API for saving and retrieving entities. Here’s an example:


let user = User()
user.name = "John Doe"
user.email = "john.doe@example.com"
SugarRecord.save(user)

To retrieve entities, you can use the find method:


let users = SugarRecord.default.find(User.self)

Querying Entities

To perform more complex queries, you can use the SugarRecord’s query API. Here’s an example:


let query = Query().filter("name", isEqualTo: "John Doe")
let users = SugarRecord.default.fetch(query)

Deleting Entities

To delete entities, you can use the delete method:


SugarRecord.delete(user)

Conclusion

SugarRecord is a powerful framework for managing the persistence layer in your iOS app. It provides an easy-to-use API that simplifies database operations and helps you save time and effort.

For more information, you can check out the official documentation at https://cocoadocs.org/docsets/sugarrecord