Realm ファイルのバンドル - .NET SDK

バンドル用の Realm ファイルの作成

1. 本番アプリと同じデータモデルで新しいプロジェクトを作成します。 バンドルするデータを使って既存のRealmを開くか、新しいRealmを作成します。

2. WriteCopy()メソッドを使用して、Realm を新しい場所や名前にコピーします。 次のコードは、これを示しています。

   ローカル Realm

   Synced Realm

   // open an existing realm
   var realm = Realm.GetInstance("myRealm.realm");
   // Create a RealmConfiguration for the *copy*
   var config = new RealmConfiguration("bundled.realm");
   // Make sure the file doesn't already exist
   Realm.DeleteRealm(config);
   // Copy the realm
   realm.WriteCopy(config);
   // Want to know where the copy is?
   var locationOfCopy = config.DatabasePath;

   重要

   同期された Realm のコピー

   同期済み Realm をコピーするときは、保留中の同期プロセスがないことを確認する必要があります。 そのためには、 WaitForUploadAsyncとWaitForDownloadAsync を呼び出します。

   // open an existing realm
   var existingConfig = new PartitionSyncConfiguration("myPartition", user);
   var realm = await Realm.GetInstanceAsync(existingConfig);
   // Create a RealmConfiguration for the *copy*
   // Be sure the partition name matches the original
   var bundledConfig = new PartitionSyncConfiguration("myPartition", user, "bundled.realm");
   // Make sure the file doesn't already exist
   Realm.DeleteRealm(bundledConfig);
   // IMPORTANT: When copying a Synced realm, you must ensure
   // that there are no pending Sync operations. You do this
   // by calling WaitForUploadAsync() and WaitForDownloadAsync():
   var session = realm.SyncSession;
   await session.WaitForUploadAsync();
   await session.WaitForDownloadAsync();
   // Copy the realm
   realm.WriteCopy(bundledConfig);
   // Want to know where the copy is?
   var locationOfCopy = existingConfig.DatabasePath;

   注意

   同じタイプの同期のみ

   このメソッドは、別のパーティションベースの同期ユーザーのパーティションベースの同期構成、または別の Flexible Sync ユーザーの Flexible Sync 構成のコピーのみをサポートします。 このメソッドを使用して、 パーティションベースの同期 Realm と Flexible Sync レルムの間で、またはその逆に変換することはできません。

本番アプリケーションでの Realm ファイルのバンドル

「シード」データを含む Realm のコピーが作成できたら、それを本番アプリケーションにバンドルする必要があります。 バンドルのプロセスは、モバイル アプリをビルドするか Unity アプリをビルドするかによって異なります。

バンドルされた Realm ファイルから Realm を開く

アプリに含まれる Realm のコピーが作成できたら、それを使用するためのコードを追加する必要があります。 追加するコードは、アプリの種類によって異なります。

// If you are using a local realm
var config = RealmConfiguration.DefaultConfiguration;
// If the realm file is a synced realm
var app = App.Create(Config.AppId);
var user = await app.LogInAsync(Credentials.Anonymous());
config = new PartitionSyncConfiguration("myPartition", user);
// Extract and copy the realm
if (!File.Exists(config.DatabasePath))
{
    using var bundledDbStream = Assembly.GetExecutingAssembly()
        .GetManifestResourceStream("bundled.realm");
    using var databaseFile = File.Create(config.DatabasePath);
    bundledDbStream!.CopyTo(databaseFile);
}
// Open the Realm:
var realm = Realm.GetInstance(config);

// After copying the above created file to the project folder,
// we can access it in Application.dataPath
// If you are using a local realm
var config = RealmConfiguration.DefaultConfiguration;
// If the realm is synced realm
var app = App.Create("myRealmAppId");
var user = await app.LogInAsync(Credentials.Anonymous());
config = new PartitionSyncConfiguration("myPartition", user);
if (!File.Exists(config.DatabasePath))
    FileUtil.CopyFileOrDirectory(Path.Combine(Application.dataPath,
        "bundled.realm"), config.DatabasePath);
}
var realm = Realm.GetInstance(config);