https://github.com/johnfairh/tmlpersistentcontainer

Shortest-path multi-step Core Data migrations in Swift
https://github.com/johnfairh/tmlpersistentcontainer

cloudkit coredata ios macos swift

Last synced: 6 months ago
JSON representation

Shortest-path multi-step Core Data migrations in Swift

• Host: GitHub
• URL: https://github.com/johnfairh/tmlpersistentcontainer
• Owner: johnfairh
• License: isc
• Created: 2017-03-29T13:26:41.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-09-19T08:44:02.000Z (10 months ago)
• Last Synced: 2025-01-10T19:03:05.155Z (6 months ago)
• Topics: cloudkit, coredata, ios, macos, swift
• Language: Swift
• Homepage:
• Size: 3.95 MB
• Stars: 15
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# TMLPersistentContainer

[![CI](https://travis-ci.org/johnfairh/TMLPersistentContainer.svg?branch=master)](https://travis-ci.org/johnfairh/TMLPersistentContainer)

[![codecov](https://codecov.io/gh/johnfairh/TMLPersistentContainer/branch/master/graph/badge.svg)](https://codecov.io/gh/johnfairh/TMLPersistentContainer)

![Pod](https://cocoapod-badges.herokuapp.com/v/TMLPersistentContainer/badge.png)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

![Platforms](https://cocoapod-badges.herokuapp.com/p/TMLPersistentContainer/badge.png)

![License](https://cocoapod-badges.herokuapp.com/l/TMLPersistentContainer/badge.png)

Automatic shortest-path multi-step Core Data migrations in Swift.

![logo](SourceDocs/logo.png)

A set of Swift extensions to Core Data's `NSPersistentContainer` and

`NSPersistentCloudKitContainer` that automatically detect and perform

multi-step store migration using the shortest valid sequence of migrations.

The library supports both light-weight and heavy-weight migrations, multiple

stores, progress reporting, and configurable logging.

## Example

Minimally replace the call to `NSPersistentContainer.init` or

`NSPersistentCloudKitContainer`:

```swift

container = PersistentCloudKitContainer(name: "MyStore",

                                        managedObjectModel: model)

```

Additional parameters optionally enable more features:

```swift

container = PersistentContainer(name: "MyStore",

                                managedObjectModel: model,

                                bundles: [Bundle.main, myResBundle],

                                modelVersionOrder: .list("V_One", "V_Two", "V_Six"),

                                logMessageHandler: myLogHandler)

container.migrationDelegate = self

```

All migrations happen as part of `NSPersistentContainer.loadPersistentStores`.

## Documentation

* [User guide](https://johnfairh.github.io/TMLPersistentContainer/usage.html) and

[API documentation](https://johnfairh.github.io/TMLPersistentContainer/) online.

* Or in the docs/ folder of a local copy of the project.

* Docset for Dash etc. at [docs/docsets/TMLPersistentContainer.tgz](https://johnfairh.github.io/TMLPersistentContainer/docsets/TMLPersistentContainer.tgz)

* Read `TestSimpleMigrate.testCanMigrateV1toV3inTwoSteps` for an end-to-end

  example.

## Requirements

Swift 6 or later, Xcode 16 or later.

* See the *swift31* branch for a Swift 31 version.

* See the *swift4* branch for a Swift 4 version.

* See the *swift41* branch for a Swift 4.1 version.

The library is based on `NSPersistentContainer`.  The minimum deployment targets

are iOS 12.0, macOS 10.14.6, tvOS 12.0, and watchOS 3.0.

The `PersistentCloudKitContainer` class is based on

`NSPersistentCloudKitContainer` so further requires a minimum deployment target

of iOS 13.0, macOS 10.15, tvOS 13.0, or watchOS 6.0.`

No additional software dependencies.

## Installation

CocoaPods:

    pod 'TMLPersistentContainer'

Swift package manager:

    .Package(url: "https://github.com/johnfairh/TMLPersistentContainer/", majorVersion: 6)

Carthage:

    github "johnfairh/TMLPersistentContainer"

## Contributions

Contributions and feedback welcome: open an issue / [email protected] / @[email protected]

## License

Distributed under the ISC license.