Realm 파일 번들 - 노드 SDK
Realm은 Realm 파일 번들 을 지원합니다. Realm 파일을 번들로 제공하면 애플리케이션 다운로드에 데이터베이스와 모든 해당 데이터가 포함됩니다.
이를 통해 사용자는 초기 데이터 설정하다 로 애플리케이션을 처음 시작할 수 있습니다. 동기화된 Realm의 경우 번들을 사용하면 사용자가 애플리케이션 을 처음 열 때 시간이 오래 걸리는 초기 다운로드 를 방지할 수 있습니다. 대신 사용자는 번들 파일 을 생성한 이후 발생한 동기화된 변경 사항만 다운로드 해야 합니다.
개요
Realm 파일을 생성하고 애플리케이션과 함께 번들로 제공하려면 다음과 같이 하세요:
번들로 제공하려는 데이터가 포함 된 Realm 파일을 만듭니다 .
번들로 제공되는 영역 파일 을 프로덕션 애플리케이션 에 추가합니다.
프로덕션 애플리케이션 에서 번들 자산 파일 의 영역 을 엽니다. 동기화된 Realm의 경우 파티션 키 를 포함해야 합니다.
참고
동기화된 Realm 번들
SDK 버전 10.12.0 동기화된 Realm을 번들로 묶는 기능을 도입했습니다. 10.12.0 이전 버전, 로컬 Realm만 번들로 사용할 수 있습니다. 동기화된 Realm 번들 시 고려 사항 및 제한 사항에 대한 자세한 내용 은 동기화된 Realm 번들하기 섹션을 참조하세요.
번들링을 위한 Realm 파일 만들기
애플리케이션의 데이터 모델을 공유하는 임시 Realm 앱을 빌드합니다.
Realm을 열고 번들로 제공하려는 데이터를 추가합니다. 동기화된 Realm을 사용하는 경우 Realm이 완전히 동기화될 때까지 기다립니다.
writeCopyTo() 메서드를 사용하여 영역을 새 파일에 복사합니다.
const originalPath = path.join(__dirname, "original.realm"); const originalConfig = { schema: [Car], path: originalPath, }; const originalRealm = await Realm.open(originalConfig); const copyPath = path.join(__dirname, "copy.realm"); originalRealm.writeCopyTo(copyPath); writeCopyTo()
복사하기 전에 Realm을 가능한 가장 작은 크기로 자동으로 압축합니다.참고
동기화된 Realm과 로컬 전용 Realm의 차이점
위의 예제에서는 SyncConfiguration 을 사용하여 Configuration 의
sync
필드에 대한 동기화된 Realm을 구성 합니다. 로컬 영역의 복사본을 만들려면 구성 객체에sync
필드를 포함하지 마세요.번들 영역 파일 의 파일 경로는 이전 단계에서
writeCopyTo()
에 전달된 인수에 지정된 위치 에서 찾을 수 있습니다. 다음 섹션에 설명된 대로 프로덕션 애플리케이션 에서 번들 영역 을 사용하려면 이 파일 이 필요합니다.temp_realm_app. ├── copyOfDefault.realm ... rest of files in _temp_ application
프로덕션 애플리케이션에 Realm 파일 번들
이제 초기 데이터가 포함된 Realm의 복사본이 있으므로 이를 프로덕션 애플리케이션과 번들로 제공합니다.
이전 섹션에서 만든 번들 영역 파일 을 프로덕션 애플리케이션 에 추가합니다.
. ├── copyOfDefault.realm ... rest of files in _prod_ application
번들 Realm 파일에서 Realm 열기
이제 프로덕션 애플리케이션에 포함된 Realm의 복사본이 있으므로 이를 사용하려면 코드를 추가해야 합니다.
번들 영역 의 경로를 path
필드 의 값으로 사용하여 구성 을 생성합니다. 해당 구성을 Realm.open() 메서드. 이제 방금 연 영역 에서 번들 영역 의 데이터로 작업할 수 있습니다.
const copyConfig = { schema: [Car], path: "path/to/bundled/file.realm" }; const copyRealm = await Realm.open(copyConfig);
동기화된 Realm 번들
참고
동일 유형 동기화만 가능
이 방법은 다른 파티션 기반 동기화 사용자를 위한 파티션 기반 동기화 구성 복사 또는 다른 Flexible Sync 사용자를 위한 Flexible Sync 구성 복사만 지원합니다. 이 방법을 사용하여 파티션 기반 동기화 영역과 Flexible Sync 영역 간에 또는 그 반대로 변환할 수 없습니다.
일반적으로 동기화된 영역 을 번들로 묶는 것은 로컬 전용 영역 을 번들로 묶는 것과 동일하게 작동합니다. 그러나 완전히 동기화된 Realm만 번들로 묶을 수 있습니다. 번들링하기 전에 영역 이 서버 와 완전히 동기화되었는지 확인합니다.
const config = { sync: { user: app.currentUser, partitionValue: app.currentUser.id, }, schema: [Car], }; const realm = await Realm.open(config); // create many changes realm.write(() => { for (let i = 0; i < 25; i++) { realm.create("Car", { make: "Toyota", model: "Prius", miles: i, owner: app.currentUser.id, }); } }); // ensure synchronize all changes before copy await realm.syncSession.uploadAllLocalChanges(); await realm.syncSession.downloadAllServerChanges(); // changes are synchronized -- we can copy the realm realm.writeCopyTo(__dirname + "syncedCopy.realm");
중요
동기화된 Realm 번들
백엔드 애플리케이션에서 Flexible Sync 를 사용하는 경우 사용자가 번들 Realm 파일을 처음 열 때 클라이언트 재설정을 경험할 수 있습니다. 이 문제는 클라이언트 최대 오프라인 시간 이 활성화된 경우(클라이언트 최대 오프라인 시간은 기본적으로 활성화되어 있음) 발생할 수 있습니다. 사용자가 처음 동기화하기 전에 번들 Realm 파일이 클라이언트 최대 오프라인 시간 설정에 지정된 일수보다 오래 생성된 경우 사용자는 클라이언트 재설정을 경험하게 됩니다.
클라이언트 재설정을 수행하는 애플리케이션은 애플리케이션 백엔드에서 영역의 전체 상태를 다운로드합니다. 이렇게 하면 Realm 파일을 번들로 제공할 때 얻을 수 있는 이점이 무효화됩니다. 클라이언트 재설정을 방지하고 Realm 파일 번들의 이점을 보존하려면 다음을 수행합니다.
동기화된 영역을 번들로 제공하는 애플리케이션에서는 클라이언트 최대 오프라인 시간을 사용하지 않도록 합니다.
애플리케이션에서 클라이언트 최대 오프라인 시간을 사용하는 경우 애플리케이션 다운로드에 항상 최근에 동기화된 Realm 파일이 포함되어 있는지 확인하세요. 각 애플리케이션 버전마다 새 파일을 생성하고 클라이언트 최대 오프라인 시간 (일)을 초과하는 버전이 최신 상태로 유지되지 않도록 합니다.
이전 파티션 기반 동기화 를 사용하는 번들 동기화 영역 을 열 때는 추가 제한이 있습니다. 파티션 기반 동기화 구성된 영역 사용에 대한 자세한 내용은 파티션 기반 동기화 - Node.js SDK 를 참조하세요.