io.realm
クラスを囲みます。
RealmConfiguration.Builder は、RealmConfiguration のインスタンスをスムーズに構築するために使用されます。
コンストラクター
コンストラクターと説明 |
|---|
Builder () RealmConfiguration のビルダのインスタンスを作成します。 |
メソッドの概要
修飾子と型 | メソッドと説明 |
|---|---|
public RealmConfiguration.Builder | RealmQueryを UI スレッドから起動できるかどうかを設定します。 |
public RealmConfiguration.Builder | UI スレッドからRealm.executeTransactionへの呼び出しを許可するかどうかを設定します。 |
public RealmConfiguration.Builder | |
public RealmConfiguration | build () ビルダ パラメータに基づいて RealmConfiguration を作成します。 |
public RealmConfiguration.Builder | Realm ファイルをユーザーに返す前に圧縮する必要があるかどうかを決定するためにこれを設定します。 |
public RealmConfiguration.Builder | これを設定すると、Realm ファイルが大きくなりすぎて有効な量のスペースが復元される場合、Realm は Realm ファイルを圧縮します。 |
public RealmConfiguration.Builder | これを設定すると、移行例外の処理方法の動作が変更されます。 |
public RealmConfiguration.Builder | |
public RealmConfiguration.Builder | Realm ファイルの暗号化と復号化に使用される 64 バイト キーを設定します。 |
public RealmConfiguration.Builder | Realm オブジェクトからコルーチン フローを作成するために使用されるFlowFactoryを設定します。 |
public RealmConfiguration.Builder | inMemory () これを設定すると、ディスクに保存されるのではなく、メモリ内 Realm が作成されます。 |
public RealmConfiguration.Builder | io.realm.Realmに初期データを設定します。 |
public RealmConfiguration.Builder | 追加のデータの書込みを試みるときに IllgealStateException がスローされる前に、 Realm ファイル内のライブ バージョンの最大数を設定します。 |
public RealmConfiguration.Builder | 移行が必要な場合にio.realm.RealmMigrationを実行するように設定します。 |
public RealmConfiguration.Builder | 既存のモジュールを 1 つ以上のRealmModleに置き換えます。 |
public RealmConfiguration.Builder | |
public RealmConfiguration.Builder | readOnly () これを設定すると、 Realm は読み取り専用になり、このRealmに対して行われたすべての書込みトランザクション (write transaction) は、 IllealStateException で失敗します。 |
public RealmConfiguration.Builder | Realm オブジェクトから Rx Observable を作成するために使用されるRxObservableFactoryを設定します。 |
public RealmConfiguration.Builder | Realm のスキーマ バージョンを設定します。 |
継承されたメソッド
クラスjava.lang.Object から継承されたメソッド:
getClass、hashCode、equals、clone、toString、notify、notifyAll、wait、wait、wait、finalize
コンストラクターの詳細
public Builder () |
|---|
RealmConfiguration 用のビルダのインスタンスを作成します。これにより、Realm ファイルを保存するためにアプリ独自の内部ディレクトリが使用されます。 これには追加の権限は必要ありません。 デフォルトのロケーションは |
メソッドの詳細
addModule
修正: 一時的に表示される DEBUG メソッド。 無条件にモジュールを追加します。 すでに定義されているモジュールにモジュールを追加します。 |
allowQueriesOnUiThread
RealmQueryを UI スレッドから起動できるかどうかを設定します。 デフォルトでは、Realm はメイン スレッドでのクエリを許可します。 ただし、そうすると、アプリケーションのフレームワークが低下したり、ARN が発生したりする可能性があります。 クエリを非 UI スレッドに転送する、または RealmQuery.findAllAsync ()またはRealmQuery.findFirstAsync( ) を使用することをお勧めします。 |
allowWritesOnUiThread
UI スレッドからRealm.executeTransactionへの呼び出しを許可するかどうかを設定します。 警告: Realm では、ユーザーがこのメソッドで明示的にオプトインしない限り、メイン スレッドで同期トランザクションを実行することはできません。 |
assetFile
指定されたアセット ファイル パスから Realm ファイルをコピーします。初めて Realm を開くと、空のファイルが作成される代わりに、Realm ファイルは提供されたアセット ファイルからコピーされ、使用されます。 これを deleteRealmIfMigrationNeted() と組み合わせることはできません。これを行うと、コピーされたファイルがのみ削除されます。 警告: これは長時間の操作になる可能性があるため、理想的にはバックグラウンド スレッドで実行する必要があります。 パラメーター
スロー
|
構築
public RealmConfiguration build () |
|---|
compactOnLaunch
Realm ファイルをユーザーに返す前に圧縮する必要があるかどうかを決定するためにこれを設定します。 合計ファイルサイズ（データ + 空き領域）とファイル内のデータによって使用されるバイト数が渡されます。 パラメーター
|
public RealmConfiguration.Builder compactOnLaunch () |
|---|
これを設定すると、Realm ファイルが大きくなりすぎて有効な量のスペースが復元される場合、Realm は Realm ファイルを圧縮します。 詳細については、「 DefaultCompactOnLaunchコールバック」を参照してください。 |
deleteRealmIfMigrationMoneded
これを設定すると、移行例外の処理方法の動作が変更されます。 io.realm .例外をスローする代わりに、ディスク上の Realm はクリアされ、新しい Realm スキーマで再作成されます。 これは、提供されたアセットファイルは移行で削除されるため、assetFile(string) を呼び出して同時にアセットファイルを存在するように構成することはできません。 警告。 これにより、データが失われます。 スロー
|
ディレクトリ
Realm ファイルを保存するディレクトリを指定します。 デフォルト値は パラメーター
スロー
|
encryptionKey
Realm ファイルの暗号化と復号化に使用される 64 バイト キーを設定します。 Realm ファイルの暗号化と復号化に使用される io.realm.Realm#enCRYPTION_KEY_LENGTH バイトキーを設定します。 |
cloudFactory
Realm オブジェクトからコルーチン フローを作成するために使用されるFlowFactoryを設定します。 デフォルトのファクトリーはRealmFlowFactoryです。 パラメーター
|
インメモリ
public RealmConfiguration.Builder inMemory () |
|---|
これを設定すると、ディスクに保存されるのではなく、メモリ内 Realm が作成されます。 メモリが不足している場合は、インメモリ Realm でもディスク領域が使用される可能性がありますが、Realm が閉じられると、インメモリ Realm によって作成されたすべてのファイルが削除されます。インメモリ Realm は永続化されないため、次が付けられている必要があることに注意してください:データが存在する限り、特定の名前を持つメモリ内の Realm オブジェクトへの閉じられていない参照を少なくとも 1 つ保持します。 |
initialData
io に初期データを設定します。邦土。 Realm 。このトランザクションは、データベースファイルが作成されたときに初めて実行されるか、 Builder.deleteRealmIfMigrationNeted() が設定されている場合にのみ実行されます。 パラメーター
|
maxNumberOfActiveVersions
追加のデータの書込みを試みるときに IllgealStateException がスローされる前に、 Realm ファイル内のライブ バージョンの最大数を設定します。 Realm は、多くの異なるバージョンの Realm オブジェクトを同時に処理することができます。 これは例えば データが ファイルに書き込まれているときに、多数の異なるスレッドで Realm を開いているか、オブジェクトをフリーズしている場合は、 が発生します。 通常の状況では、これは問題ではありませんが、アクティブなバージョンの数が大きくなりすぎると、ディスク上のファイルサイズに悪影響が生じます。 したがって、このパラメーターを設定すると、Realm が非常に大きくなる可能性のある Realm の使用を防ぐために使用できます。 パラメーター
Tip |
migration
移行が必要な場合にio.realm.RealmMigrationを実行するように設定します。 この移行によってディスク上のスキーマがランタイム スキーマにアップグレードされない場合、 io.realm.Exceptions.RealmMigrationNetedExceptionがスローされます。 |
modules
既存のモジュールを 1 つ以上のRealmModleに置き換えます。 このメソッドを使用すると、この Realm の現在のスキーマが、提供されている モジュールによって定義されているスキーマに置き換えられます。 プロジェクト内のすべての Realm クラス（ただし、依存関係は含まない）を含むデフォルトの Realm モジュールへの参照は、 Realm.getDefaultModule()を使用して見つけることができます。 アプリプロジェクトとライブラリの依存関係のスキーマを組み合わせるには、次のコードを使用します。
パラメーター
スロー
|
name
Realm ファイルのファイル名を設定します。 |
readOnly
public RealmConfiguration.Builder readOnly () |
|---|
これを設定すると、 Realm は読み取り専用になり、このRealmに対して行われたすべての書込みトランザクション (write transaction) は、 IllealStateException で失敗します。 これは特に initialData( Realm.Transaction) が読み取り専用Realmと組み合わせて動作せず、これを設定すると IllealStateException がスローされることを平均。 Realm を読み取りとしてマークすると、このプロセス内の Realm にのみ適用されます。 他のプロセスは引き続き Realm に書込むことができます。 |
rxFactory
Realm オブジェクトから Rx Observable を作成するために使用されるRxObservableFactoryを設定します。 デフォルトのファクトリーはRealmObservableFactoryです。 パラメーター
|
schemaVersion
Realm のスキーマ バージョンを設定します。 これは、既存の Realm ファイルのスキーマ バージョンと等しいか、それ以上である必要があります（存在する場合）。 スキーマ バージョンが既存の Realm よりも高い場合は、移行が必要です。移行コードが提供されていない場合、Realm はio.realm.Exceptions.RealmMigrationNetedExceptionをスローします。 |