Custom Migration #116

New Issue

Closed

opened 2025-12-29 15:24:51 +01:00 by adam · 3 comments

adam commented 2025-12-29 15:24:51 +01:00

Owner

Copy Link

Originally created by @tosbaha on GitHub (Jan 6, 2017).

Hi,
I am in the process of upgrading my stack I need to do some migration. Lightweight migration works but leaves a property that I don't need it any more. I am sorry if this issue is not relevant. I checked the documentation but I only saw reference to lightweight migration. How can I do following migration with CoreStore?

Old Model

company Int16 (raw value of Company enum)
id String

New Model

slug String (string value based on Company)
renamedId (renamed from id)

I did the renaming by using Data Model inspector and using id as Renaming ID

My Current code with my old CoreData stack is like below which does the migration but leaves company attribute in new model.

func updateCoreDataIfNeeded(){
    let appDirectory = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: "myidentifier")!
    let url = appDirectory.appendingPathComponent("MyModel.sqlite")
    guard let model = NSManagedObjectModel(contentsOf:Bundle.main.url(forResource: "MyModel", withExtension: "momd")!) else {
        return
    }
    do {
        let metaData = try NSPersistentStoreCoordinator.metadataForPersistentStore(ofType: NSSQLiteStoreType, at: url)
        if (!model.isConfiguration(withName: nil, compatibleWithStoreMetadata: metaData) ) {
            //Model is not compatible
            updateCoreData()
        } else {
            print("No migration needed")
        }
    } catch {
        print(error)
        return
    }
}

func updateCoreData() {

    do {
            guard let kargos = try CoreDataHelper.sharedInstance.fetch("MyModel") as? [MyModel] else { return }
            for kargo in kargos {
                if (kargo.slug == "") {
                    print("Slug doesnt exist")
                    kargo.slug = Company(rawValue: Int(kargo.company))?.slug ?? Company.testpost.slug
                }
            }
            CoreDataHelper.sharedInstance.save()
            print("Update finished!")
        } catch {
            print(error)
            print("Update Error!")
        }
}

Originally created by @tosbaha on GitHub (Jan 6, 2017). Hi, I am in the process of upgrading my stack I need to do some migration. Lightweight migration works but leaves a property that I don't need it any more. I am sorry if this issue is not relevant. I checked the documentation but I only saw reference to lightweight migration. How can I do following migration with CoreStore? Old Model === ``` company Int16 (raw value of Company enum) id String ``` New Model === ``` slug String (string value based on Company) renamedId (renamed from id) ``` I did the renaming by using Data Model inspector and using `id` as Renaming ID My Current code with my old CoreData stack is like below which does the migration but leaves company attribute in new model. ```swift func updateCoreDataIfNeeded(){ let appDirectory = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: "myidentifier")! let url = appDirectory.appendingPathComponent("MyModel.sqlite") guard let model = NSManagedObjectModel(contentsOf:Bundle.main.url(forResource: "MyModel", withExtension: "momd")!) else { return } do { let metaData = try NSPersistentStoreCoordinator.metadataForPersistentStore(ofType: NSSQLiteStoreType, at: url) if (!model.isConfiguration(withName: nil, compatibleWithStoreMetadata: metaData) ) { //Model is not compatible updateCoreData() } else { print("No migration needed") } } catch { print(error) return } } func updateCoreData() { do { guard let kargos = try CoreDataHelper.sharedInstance.fetch("MyModel") as? [MyModel] else { return } for kargo in kargos { if (kargo.slug == "") { print("Slug doesnt exist") kargo.slug = Company(rawValue: Int(kargo.company))?.slug ?? Company.testpost.slug } } CoreDataHelper.sharedInstance.save() print("Update finished!") } catch { print(error) print("Update Error!") } } ```

adam added the question label 2025-12-29 15:24:51 +01:00

adam closed this issue 2025-12-29 15:24:51 +01:00

adam commented 2025-12-29 15:24:51 +01:00

Author

Owner

Copy Link

@JohnEstropia commented on GitHub (Jan 6, 2017):

@tosbaha The setup code for lightweight and custom migrations in CoreStore is the same. See
https://github.com/JohnEstropia/CoreStore#progressive-migrations
where you have to provide a MigrationChain to the DataStack.

For custom migrations, CoreStore will look for a .xcmappingmodel file in your bundle for the source and destination model versions. If CoreStore finds one it will use that mapping, if it doesn't find one it will try to use lightweight migration as a last resort.

@JohnEstropia commented on GitHub (Jan 6, 2017): @tosbaha The setup code for lightweight and custom migrations in CoreStore is the same. See https://github.com/JohnEstropia/CoreStore#progressive-migrations where you have to provide a `MigrationChain` to the `DataStack`. For custom migrations, CoreStore will look for a *.xcmappingmodel* file in your bundle for the source and destination model versions. If CoreStore finds one it will use that mapping, if it doesn't find one it will try to use lightweight migration as a last resort.

adam commented 2025-12-29 15:24:52 +01:00

Author

Owner

Copy Link

@tosbaha commented on GitHub (Jan 6, 2017):

Thanks for quick reply. I did following but it seems it is crashing. Could you tell me why ?

import Foundation
import CoreData


class KargoCDV1ToV2Policy:NSEntityMigrationPolicy {
    
    func valueFor(company:NSNumber) -> String {
        let company = Company(rawValue: Int(company))
        return company?.slug  ?? Company.testpost.slug
    }
}

I get

-[Kargotakip.KargoCDV1ToV2Policy valueFor:]: unrecognized selector sent to instance 0x60000000dc00

I also tried FUNCTION($entityPolicy, "valueForcompany:" , $source.company) again I get

-[Kargotakip.KargoCDV1ToV2Policy valueForcompany:]: unrecognized selector sent to instance 0x60000000dc00

I am using Swift 3. Is there a breaking change?

EDIT: If I change function to

func valueFor(_ comp:NSNumber) -> String {
        let company = Company(rawValue: Int(comp))
        return company?.slug  ?? Company.testpost.slug

    }

Then it worked. 🤷‍♂️

@tosbaha commented on GitHub (Jan 6, 2017): Thanks for quick reply. I did following but it seems it is crashing. Could you tell me why ? ```swift import Foundation import CoreData class KargoCDV1ToV2Policy:NSEntityMigrationPolicy { func valueFor(company:NSNumber) -> String { let company = Company(rawValue: Int(company)) return company?.slug ?? Company.testpost.slug } } ```   I get > -[Kargotakip.KargoCDV1ToV2Policy valueFor:]: unrecognized selector sent to instance 0x60000000dc00 I also tried FUNCTION($entityPolicy, "valueForcompany:" , $source.company) again I get > -[Kargotakip.KargoCDV1ToV2Policy valueForcompany:]: unrecognized selector sent to instance 0x60000000dc00 I am using Swift 3. Is there a breaking change? EDIT: If I change function to ``` func valueFor(_ comp:NSNumber) -> String { let company = Company(rawValue: Int(comp)) return company?.slug ?? Company.testpost.slug } ``` Then it worked. 🤷‍♂️

adam commented 2025-12-29 15:24:52 +01:00

Author

Owner

Copy Link

@JohnEstropia commented on GitHub (Jan 7, 2017):

Glad it worked for you :) I'm closing this issue now but if you have other questions feel free to ask!

@JohnEstropia commented on GitHub (Jan 7, 2017): Glad it worked for you :) I'm closing this issue now but if you have other questions feel free to ask!

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

develop

master

prototype/concurrency

minIOS13

prototype/containers

transactionSourceTracking

prototype/swiftui

minIOS11

swift5_3

prototype/propertyWrapperFields

prototype/propertyWrappers

prototype/propertyWrapper

Swift5

throwables

prototype/Swift_4_1

prototype/Swift_4_0

prototype/Swift_3_2

prototype/queryBuilders

temp/develop

corestore4_develop

prototype/mainContextToPSC

master_ios_7_to_9

swift_2_3

gh-pages

_corespotlight-test

9.3.0

9.2.0

9.1.0

9.0.0

8.1.0

8.0.1

8.0.0

7.3.1

7.3.0

7.2.0

7.1.0

7.0.4

7.0.3

7.0.2

7.0.1

7.0.0

6.3.2

6.3.1

6.3.0

6.2.1

6.2.0

6.1.0

6.0.0

5.3.1

5.3.0

5.2.0

5.1.1

5.1.0

5.0.0

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.4

4.1.3

4.1.1

4.1.0

4.0.5

4.0.4

4.0.3

4.0.2

4.0.1

4.0.0

4.0.0-beta3

4.0.0-beta2

4.0.0-beta

3.1.1

3.1.0

3.0.3

3.0.2

3.0.1

3.0.0

2.1.3

2.1.2

2.1.1

2.1.0

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.6.10

1.6.9

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.1

1.2.0

1.0.2

1.0.1

1.0.0

0.2.1

0.2.0

0.1.2

0.1.1

0.1.0

Labels

Clear labels

abandoned

corestore bug

discussion

duplicate

enhancement

fixed

fixed

help wanted

in progress

investigating

ios/compiler bug

irreproducible

looking for workarounds

not a bug

pending

pending docs update

pull-request

Mirrored from GitHub Pull Request

question

regression

user bug

wontfix

No Label question

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

adam

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/CoreStore#116