[RealmSwift] Migration Primary Key

Realm을 사용해서 앱을 만들다 보면

프로젝트 진행 중에 새로운 프로퍼티 값을 추가, 삭제, 업데이트 하거나

프라이머리키를 변경해야 하는 순간이 있을 수 있다. 

 

특히 앱을 이미 배포한 상태에서 꼭 필요한 데이터베이스 구조 변경이 일어나야 한다면 아래 글을 참고해서 Configuration 을 해주어야 한다. 

[RealmSwift] Migration, 운영 중인 앱의 필드 추가한 후 마이그레이션 해주기

 

primaryKey의 변경이 일어났다면 아래와 같이 수정하면 된다. 

 

        let configuration = Realm.Configuration(schemaVersion: 4) { migration, oldSchemaVersion in
            migration.enumerateObjects(ofType: Quote.className()) { oldObject, newObject in
                newObject!["현재 프라이머리 키로 사용하는 변수 명"] = "이전에 프라이머리 키로 사용한 변수 명"
            }
        }
        
        Realm.Configuration.defaultConfiguration = configuration

 

그런데 만약에 primaryKey가 없었고 새롭게 추가해 주는 경우

    /// 프라이머리 키
    @objc dynamic var _id: ObjectId = ObjectId.generate()
    
    override class func primaryKey() -> String? {
        return "_id"
    }

 

새로운 primaryKey값이 될 프로퍼티를 Object 클래스에 선언해 줌

그 후에 primaryKey()를 오버라이드 해줌

 

        
        let configuration = Realm.Configuration(schemaVersion: 5) { migration, oldSchemaVersion in
            migration.enumerateObjects(ofType: Quote.className()) { oldObject, newObject in
                newObject!["_id"] = ObjectId.generate()
            }
        }
        
        Realm.Configuration.defaultConfiguration = configuration

새로 생성한 프로퍼티에 PrimaryKey 값으로 사용할 값을 넣어준다. 

이렇게 하면 이전에 사용한 id를 버리게 되는 것인데, 이전 id는 primaryKey로 쓰이지 않아 제대로 관리되고 있지 않아서

새로운 프로퍼티를 생성해 만들어 주었다. 

이때 조심할 것은 객체 필터링시 스트링 값으로 조건문을 적어주기 때문에 관련된 로직에서 해당 값을 찾아 직접 변경해 주어야 한다. 

 

참고 사이트 및 도서 

https://stackoverflow.com/questions/32747890/migrate-primary-key-in-realm

 

이미지 출처 : Realm 홈페이지