デフォルト パスに新しいRealmインスタンスを作成します。
互換性のない同期された Realm を開くときのエラー。
指定されたパスに新しいRealmインスタンスを作成します。
Realm を初めて作成するときに必要です。
指定されたパスで Realm を開くことができない場合は、 エラーが発生します。
互換性のない同期された Realm を開くときのエラー。
提供された構成を使用して新しいRealmインスタンスを作成します。 Realm がまだconfig.path （提供されていない場合はRealm.defaultPath ）に存在しない場合、このコンストラクターは指定されたconfig.schema （この場合は必須）を使用してそれを作成します。 それ以外の場合、インスタンスはそのパスにある ファイルから既存の Realm にアクセスします。 この場合、 config.schemaは任意であるか、変更されていない場合にのみ、 config.schemaVersionが増加している場合を除き、Realm は新しいスキーマを使用するように自動的に移行されます。 クエリベースの同期の場合は、 config.schemaが必要です。 config.schemaが定義されていない場合は、例外がスローされます。
Realm を初めて作成するときに必要です。
提供された構成内のいずれかが無効な場合は、 エラー。
互換性のない同期された Realm を開くときのエラー。
Readonly sync同期セッション（同期された Realm の場合）
Static この Realm が閉じているかどうかを示します。
true 閉じている場合はfalse 、閉じている場合は 。
2.1.0
この Realm にオブジェクトが含まれているかどうかを示します。
true 空の場合は 、それ以外の場合はfalse 。
1.10.0
この Realm がメモリ内で開かれているかどうかを示します。
true この Realm がメモリ内である場合は 、それ以外の場合はfalseになります。
この Realm が移行中かどうかを示します。
true 移行している場合は、それ以外の場合はfalse
12.3.0
この Realm が書込みトランザクション (write transaction) 内かどうかを示します。
true 書込みトランザクション（write transaction）にある場合は、それ以外の場合はfalse 。
1.10.3
この Realm が読み取り専用として開かれているかどうかを示します。
true この Realm が読み取り専用の場合は 、それ以外の場合はfalseになります。
0.12.0
この Realm が保存されているファイルへのパス。
この Realm が保存されているファイルへのパスを含む string。
0.12.0
この Realm が構築されたときに構成で提供されたスキーマの正規化された表現。
この Realm 内のすべてのオブジェクトを記述するCanonicalObjectSchemaの配列。
0.12.0
Realm の現在のスキーマ バージョン。
この Realm のスキーマ バージョン（ number 。
0.12.0
Flexible Sync サブスクライブの最新セット。
SubscriptionSetオブジェクト。
このアプリでフレキシブルな同期が有効になっていない場合は、 エラーが発生します。
指定された eventName のリスナー コールバックを追加します。
コールバックを呼び出すイベントの名前。
変更イベントが発生したときに呼び出される関数。 各コールバックは、追加された回数に関係なく、イベントごとに 1 回のみ呼び出されます。
無効なイベント eventName が指定されている場合、Realm が閉じている場合、またはコールバックが関数でない場合は、エラーが発生します。
書込みトランザクション (write transaction) を開始します。
トランザクションを実行するときは、エラー処理を行うことを強くお勧めします。 エラーを処理しないと、データの整合性が失われる可能性があります。 エラー処理には、多くの場合トランザクションのキャンセルが含まれます。
すでに書込みトランザクションが実行されている場合は エラー
realm.beginTransaction();
try {
realm.create('Person', { name: 'Arthur Dent', origin: 'Earth' });
realm.create('Person', { name: 'Ford Prefect', origin: 'Betelgeuse Five' });
realm.commitTransaction();
} catch (e) {
realm.cancelTransaction();
throw e;
}
この Realm 内のすべての string 列を string 列挙列に置き換え、データベースファイルを圧縮します。
書込みトランザクション (write transaction) からは呼び出せません。
他のRealmインスタンスが存在する場合は、圧縮は行われません。
圧縮の進行中、 は他のスレッドまたはプロセスによるデータベースを開こうとする試行を待機します。
圧縮のためのリソース要件は、データベース内のライブ データの量に比例することに注意してください。 Compaction works by writing the database contents to a temporary database file and then replacing the database with the temporary one.
true 圧縮が成功した場合は 、成功しない場合はfalseになります。
指定されたタイプと指定されたプロパティを持つ新しいRealm オブジェクトを作成します。 非対称マークされたオブジェクトの場合、 undefinedが返されます。 非対称オブジェクトの API は、将来変更される可能性があります。
RealmObjectまたはオブジェクトが非対称の場合はundefined 。
すべてのオブジェクトを含む Realm モデルを削除します。 移行関数外で呼び出されると、スキーマとschemaVersionが更新されます。
モデル名。
プライマリキーで Realm オブジェクトを検索します。
RealmObjectまたはオブジェクトが見つからない場合はnull 。
このメソッドに渡される型が無効な場合、またはオブジェクト型のスキーマでプライマリキーが指定されていない場合、あるいは非対称としてマークされている場合は、 エラー。
0.14.0
Realm 内の指定された型のすべてのオブジェクトを返します。
検索する Realm オブジェクトのタイプ。
オブジェクトが作成、変更、破棄されるにつれてライブアップデートされる結果。
このメソッドに渡される型が無効な場合、または型が埋め込みまたは非対称としてマークされている場合は、エラーが発生します。
すべてのイベント リスナーを削除します（イベント eventName が提供されている場合は、このリスナーに制限されます）。
Optional eventName : RealmEventNameリスナーを削除するイベントの名前。
無効なイベント eventName が指定された場合はエラー。
指定されたイベント eventName のリスナー コールバックを削除します。
イベント名。
以前にaddListerメソッドを通じてこのイベントのリスナーとして追加された関数。
無効なイベント eventName が指定されている場合、Realm が閉じている場合、またはコールバックが関数でない場合は、 エラー。
書込みトランザクション (write transaction) 内で、指定されたコールバックを同期して呼び出します。 トランザクション内で例外が発生した場合、そのトランザクションの変更は失われますが、Realm 自体は影響を受けません（または破損）。 より正確には、 startTransactionとcommitTransactionが自動的に呼び出されます。 トランザクション中に例外が発生した場合、 commitTransaction ではなく CancelTransaction が呼び出され、例外は Write の呼び出し元に再スローされます。
コールバックからの戻り値。
指定された構成を持つ Realm の圧縮されたコピーを書込みます。
宛先ファイルがすでに存在することはできません。 同期された Realm と同期されていない Realm 間のすべての変換はサポートされており、 出力を記述する必要な構成パラメーターに従って実行されます。
このメソッドが書込みトランザクション (write transaction) 内から呼び出されると、前の書込みトランザクションがコミットされた時点のデータではなく、現在のデータが書き込まれることに注意してください。
出力邦土を記述する Realm 構成。
Static Realm ファイル（ *.realm ）は、アプリケーション ディレクトリからアプリケーションのドキュメント ディレクトリにバンドルされており、Realm で開いて使用できるようになります。 ファイルがすでにドキュメント ディレクトリに存在する場合は、上書きされないため、これは複数回安全に呼び出せます。
バンドルされている Realm ファイルを書き込みできる場所に移動するには、Realm を開く前にこれを呼び出す必要があります。
// Given a bundled file, example.realm, this will copy example.realm (and any other .realm files)
// from the app bundle into the app's documents directory. If the file already exists, it will
// not be overwritten, so it is safe to call this every time the app starts.
Realm.copyBundledRealmFiles();
const realm = await Realm.open({
// This will open example.realm from the documents directory, with the bundled data in.
path: "example.realm"
});
これは React Native にのみ実装されています。
I/O エラーが発生した場合、またはメソッドが実装されていない場合は エラー 。
Static createRealm モデル クラスのテンプレート オブジェクトを作成します。ここでは、すべてのオプション フィールドは未定義で、すべての必須フィールドには指定されたデータ型のデフォルト値（スキーマのデフォルト プロパティによって設定されている値、またはスキーマが作成されている場合はデータ型のデフォルト値）が含まれます。は 1 つの を指定しません。つまり、0、false 、および "" です。
作成するオブジェクトを記述するスキーマ。
Static delete指定された構成の Realm ファイルを削除します。
削除される Realm の構成。
提供された構成内のいずれかが無効な場合は、 エラー。
Static existsRealm がすでにディスク上に存在するかどうかを確認します。
Realm の構成またはそのパス。
true デバイスに Realm が存在する場合は 、存在しない場合はfalse 。
提供された構成内のいずれかが無効な場合は、 エラー。
Static オープンPromise を使用して非同期に Realm を開きます。 Realm が同期されている場合は、使用可能になる前に完全に同期されます。 クエリベースの同期の場合、Configuration.schema | config.schema は必須です。 Configuration.scheme | の場合には、例外がスローされます。 config.schema が定義されていない。
Realm の構成またはそのパス。
Realm インスタンスが利用可能になると、それによって解決される Promise 。
指定された引数のいずれかが無効な場合は、エラーが発生します。
Static 指定されたパスにある Realm の現在のスキーマ バージョンを取得します。
Realm データベースが保存されているファイルへのパス。
Optional encryptionKey : Arrayバッファ| Arrayバッファビュー暗号化された Realm にアクセスする場合にのみ必要です。
整数で表されたスキーマのバージョン。または、パス上に Realm が存在しない場合は-1です。
無効な、または一致しない暗号化キーを渡す場合は、 エラーが発生します。
0.11.0
Static ログ レベルを設定します。
ロガーが使用するログレベル。 デフォルト値はinfoです。
ログ レベルは、アプリケーションの有効期間中に変更できます。
12.0.0
Static setロガーのコールバックを設定します。
ロガーによって呼び出されるコールバック。 デフォルトのコールバックでは、メッセージのレベルに応じて、 console.log 、 console.warn 、 console.errorが使用されます。
最初の Realm を開く前に、ロガー コールバックを設定する必要があります。
12.0.0
TypeDocを使用して生成
Realm データベース。