Enumerations

The NSError error codes for CSError.Domain.

All errors thrown from CoreStore are expressed in CoreStoreError enum values.

The MigrationResult indicates the result of a migration. The MigrationResult can be treated as a boolean:

CoreStore.upgradeStorageIfNeeded(SQLiteStorage(fileName: "data.sqlite")) { (result) in
    switch result {
    case .success(let migrationSteps):
        // ...
    case .failure(let error):
        // ...
    }
}

The MigrationType specifies the type of migration required for a store.

The CSLocalStorageOptions provides settings that tells the CSDataStack how to setup the persistent store for CSLocalStorage implementers.

The SelectTerm is passed to the Select clause to indicate the attributes/aggregate keys to be queried.

The SetupResult indicates the result of an asynchronous initialization of a persistent store. The SetupResult can be treated as a boolean:

try! CoreStore.addStorage(
    SQLiteStore(),
    completion: { (result: SetupResult) -> Void in
        if result {
            // succeeded
        }
        else {
            // failed
        }
    }
)

or as an enum, where the resulting associated object can also be inspected:

try! CoreStore.addStorage(
    SQLiteStore(),
    completion: { (result: SetupResult) -> Void in
        switch result {
        case .success(let storage):
            // storage is the related StorageInterface instance
        case .failure(let error):
            // error is the CoreStoreError enum value for the failure
        }
    }
)

CoreStore is the main entry point for all other APIs.

The NSError error codes for CoreStoreErrorDomain.

The LogLevel indicates the severity of a log message.

The containing type for value properties. Use the DynamicObject.Value typealias instead for shorter syntax.

class Animal: CoreStoreObject {
    let species = Value.Required<String>("species", initial: "")
    let nickname = Value.Optional<String>("nickname")
    let color = Transformable.Optional<UIColor>("color")
}

The containing type for transformable properties. Use the DynamicObject.Transformable typealias instead for shorter syntax.

class Animal: CoreStoreObject {
    let species = Value.Required<String>("species", initial: "")
    let nickname = Value.Optional<String>("nickname")
    let color = Transformable.Optional<UIColor>("color")
}

The containing type for relationships. Use the DynamicObject.Relationship typealias instead for shorter syntax.

class Dog: CoreStoreObject {
    let master = Relationship.ToOne<Person>("master")
}
class Person: CoreStoreObject {
    let pets = Relationship.ToManyUnordered<Dog>("pets", inverse: { $0.master })
}