Realm

Realm で使用されるSchema 。

Realmインスタンスの作成に使用されたConfigurationの値。

Realm にオブジェクトが含まれているかどうかを示します。

デフォルトの Realm のインスタンスを取得します。

デフォルトの Realm は、iOS 上のアプリケーションのドキュメントディレクトリおよび OS X 上のアプリケーションのアプリケーション サポートディレクトリにdefault.realmとして保存されます。

デフォルトの Realm はデフォルトのConfigurationを使用して作成されます。これは、 Realm.Configuration.defaultConfigurationプロパティを新しい値に設定することで変更できます。

指定された構成を持つRealmインスタンスを取得します。

指定されたファイル URL で永続化されたRealmインスタンスを取得します。

非同期に Realm を開き、指定されたキューのブロックに配信します。

Realm を非同期に起動すると、指定されたキューにディスパッチする前に、バックグラウンド スレッド上で Realm を使用可能な状態に戻すために必要なすべての作業（時間がかかる可能性のある移行の実行など）がバックグラウンド スレッドで実行されます。 さらに、同期された Realm は、操作がローカルでダウンロードされ利用可能になった時点で利用可能なすべてのリモート コンテンツを待機します。

コールバック関数に渡される Realm は、 Realm(configuration:queue:)が使用されていた場合と同様に、コールバック キューに制限されます。

非同期に Realm を開き、指定されたキューのブロックに配信します。

Realm を非同期に起動すると、指定されたキューにディスパッチする前に、バックグラウンド スレッド上で Realm を使用可能な状態に戻すために必要なすべての作業（時間がかかる可能性のある移行の実行など）がバックグラウンド スレッドで実行されます。 さらに、同期された Realm は、操作がローカルでダウンロードされ利用可能になった時点で利用可能なすべてのリモート コンテンツを待機します。

パブリッシャーに渡される Realm は、 Realm(configuration:queue:)が使用されているかのようにコールバック キューに制限されています。

非同期オープンを観察またはキャンセルするために使用できるタスク オブジェクト。

同期された Realm が非同期に開かれると、完了コールバックが呼び出される前に、Realm の最新の状態がサーバーからダウンロードされます。 このタスク オブジェクトは、ダウンロードの状態を確認したり、ダウンロードをキャンセルしたりするために使用できます。 これは、同期セッション自体が非同期で作成され、Realm.asyncOpen() が返すときにまだ存在しない可能性があるため、同期セッション経由でダウンロードを確認する代わりに使用する必要があります。

書込みトランザクション (write transaction) 内で指定されたブロックに含まれるアクションを実行します。

ブロックがエラーをスローした場合、トランザクションはキャンセルされ、エラーが発生する前に行われた変更はロールバックされます。

Realm ファイルごとに一度に開くことができる書込みトランザクションは 1 つだけです。 書込みトランザクションはネストできず、すでに書込みトランザクションが行われている Realm で書込みトランザクションを開始しようとすると、例外がスローされます。 他のスレッドまたは他のプロセス内の同じ Realm ファイルに対するRealmインスタンスからwriteへの呼び出しは、現在の書込みトランザクションが完了またはキャンセルされるまでブロックされます。

書込みトランザクションを開始する前に、 writeはrefresh()が呼び出された場合と同様にRealmインスタンスを最新の Realm バージョンに更新し、該当する場合は通知を生成します。 Realm がすでに最新になっている場合、これは効果がありません。

関連する通知トークンを渡すことで、この書込みトランザクションで行われた変更に関する特定の通知ブロックを通知するようスキップできます。 これは主に、書込みトランザクションが UI ですでに行われた変更を保存しており、通知ブロックによる同じ変更の再適用の試行を避けたい場合に便利です。

この関数に渡されるトークンは、書込みトランザクションが実行されているのと同じスレッドで追加された、この Realm の通知用のものである必要があります。 このメソッドを使用して、異なるスレッドの通知をスキップすることはできません。

Realm で書込みトランザクション (write transaction) を開始します。

Realm ファイルごとに一度に開くことができる書込みトランザクションは 1 つだけです。 書込みトランザクションはネストできず、すでに書込みトランザクションが行われている Realm で書込みトランザクションを開始しようとすると、例外がスローされます。 他のスレッドまたは他のプロセス内の同じ Realm ファイルに対するRealmインスタンスからbeginWriteへの呼び出しは、現在の書込みトランザクションが完了またはキャンセルされるまでブロックされます。

書込みトランザクションを開始する前に、 beginWriteはrefresh()が呼び出された場合と同様にRealmインスタンスを最新の Realm バージョンに更新し、該当する場合は通知を生成します。 Realm がすでに最新になっている場合、これは効果がありません。

書込みトランザクションが実行ループの複数のサイクルにまたがる場合はまれに、書込みトランザクションがコミットされるまで、書込みトランザクションに参加する Realm が起動していることを確認する必要があります。

現在の書込みトランザクション内のすべての書込み操作をコミットし、トランザクションを終了します。

変更を保存し、書込みトランザクションを完了すると、この特定のRealmインスタンスに登録されているすべての通知ブロックが同期的に呼び出されます。 他のスレッド上のRealmインスタンスの通知ブロックと、Realm コレクションに登録されたブロック（現在のスレッド上のブロックを含む）は、同期的に呼び出されるようにスケジュールされます。

関連する通知トークンを渡すことで、この書込みトランザクションで行われた変更に関する特定の通知ブロックを通知するようスキップできます。 これは主に、書込みトランザクションが UI ですでに行われた変更を保存しており、通知ブロックによる同じ変更の再適用の試行を避けたい場合に便利です。

この関数に渡されるトークンは、書込みトランザクションが実行されているのと同じスレッドで追加された、この Realm の通知用のものである必要があります。 このメソッドを使用して、異なるスレッドの通知をスキップすることはできません。

現在の書込みトランザクションで行われたすべての書込みを元に戻し、トランザクションを終了します。

これにより、Realm 内のすべてのオブジェクトは、書込みトランザクション (write transaction) の開始時の状態にロールバックされ、トランザクションが終了します。

これにより、削除されたオブジェクトのデータは復元されますが、無効化されたオブジェクト インスタンスは有効化されません。 Realm に追加されたObjectは、管理されなくなるのではなく、無効化されます。

次のコードがあるとします。

let oldObject = objects(ObjectType).first!
let newObject = ObjectType()

realm.beginWrite()
realm.add(newObject)
realm.delete(oldObject)
realm.cancelWrite()

oldObjectとnewObject はどちらもtrue に対してisInvalidated を返しますが、oldObject を提供したクエリを再実行すると、有効なオブジェクトが再度返されます。

トランザクション中に変更されたオブジェクトの KVE オブジェクトは、初期値に戻った変更について通知されますが、キャンセルされた書込みトランザクションによって他の通知は生成されません。

Realm が現在書込みトランザクション (write transaction) を実行しているかどうかを示します。

Realm に追加または作成されるオブジェクトに、すでに存在するプライマリキーがある場合の操作。

この Realm に管理されていないオブジェクトを追加します。

同じプライマリキーを持つオブジェクトがこの Realm にすでに存在する場合は、選択したUpdatePolicyによって指定される、このオブジェクトのプロパティ値で更新されます。 プライマリキーがないオブジェクトでは、更新ポリシーは.errorである必要があります。

Realm にオブジェクトを追加すると、そのオブジェクトが参照するすべての子関係も追加されます（ ObjectとList<Object>プロパティを使用）。 これらのオブジェクトはこの Realm に追加する有効なオブジェクトでもある必要があり、 update:パラメータの値はそれらの追加に伝播されます。

追加するオブジェクトは、管理されていないオブジェクトまたはこの Realm によってすでに管理されている有効なオブジェクトである必要があります。 この Realm によってすでに管理されているオブジェクトを追加する場合は何も行われませんが、別の Realm によって管理されているオブジェクトまたは Realm から削除されたオブジェクト（つまり、 isInvalidatedがtrueであるオブジェクト）を追加する場合はエラーになります。

管理対象オブジェクトを Realm から別の Realm にコピーするには、代わりにcreate()を使用します。

コレクション内のすべてのオブジェクトを Realm に追加します。

指定された値を持つ Realm オブジェクトを作成し、その値を Realm に追加して返します。

value引数は、Realm オブジェクト、キー値コーディング準拠オブジェクト、 NSJSONSerializationのメソッドから返された配列または辞書、または管理対象プロパティごとに 1 つの要素を含むArrayにすることができます。 単独またはコレクションのノードとして、 LinkingObjectsインスタンスを渡しません。 value引数が配列の場合、すべてのプロパティが存在し、有効で、モデルで定義されたプロパティと同じ順序で存在する必要があります。

オブジェクトタイプにプライマリキーがない場合、または指定されたプライマリキーを持つオブジェクトがまだ存在しない場合は、Realm に新しいオブジェクトが作成されます。 指定されたプライマリキーを持つオブジェクトが Realm にすでに存在し、更新ポリシーが.modifiedまたは.allの場合、既存のオブジェクトが更新され、そのオブジェクトへの参照が返されます。

オブジェクトが更新されている場合、そのスキーマで定義されているすべてのプロパティは、キーと値のコーディングを使用してvalueからコピーされることによって設定されます。 value引数が特定のプロパティ名（または定義されている場合は getter 名）のvalue(forKey:)に応答しない場合、その値は影響を受けません。 オブジェクトの null 可能なプロパティは、更新された値としてNSNullを使用するか、（ Objectサブクラスのインスタンスを渡している場合） valueの対応するプロパティを nil に設定することで nil に設定できます。

Realm からオブジェクトを削除します。 オブジェクトが削除されると、無効化されたと見なされます。

Realm から 0 個以上のオブジェクトを削除します。

Resultsまたはその他の自動更新 Realm コレクション タイプ（Swift suffix(_:)標準ライブラリ メソッドによって返されるタイプ）にスライスを渡しないでください。 代わりに、 Array()を使用して削除するオブジェクトのコピーを作成し、それを代わりに渡します。 自動更新コレクションにビューを直接渡すと、「限界外のインデックス」 の例外がスローされる可能性があります。

Realm からすべてのオブジェクトを削除します。

Realm に保存されている指定された型のすべてのオブジェクトを返します。

指定されたプライマリキーを持つ指定されたオブジェクトタイプの単一のインスタンスを Realm から検索します。

このメソッドでは、特定のオブジェクト クラスでprimaryKey()がオーバーライドされる必要があります。

この Realm に加えられた変更の通知ハンドラーを追加し、通知トークンを返します。

通知ハンドラーは、スレッドやプロセスとは独立して、各書込みトランザクションがコミットされた後に呼び出されます。

ハンドラー ブロックは、追加されたのと同じスレッドで呼び出され、現在実行ループ内にあるスレッドにのみ追加できます。 バックグラウンド スレッドで実行ループを具体的に作成して実行している場合を除き、これは通常、メイン スレッドのみになります。

実行ループが他のアクティビティによってブロックされている限り、通知は配信されません。 通知をすぐに配信できない場合は、複数の通知が統合されることがあります。

アップデートをブロックに送信する場合は、返されたトークンを保持する必要があります。 更新の受信を停止するには、トークンでinvalidate()を呼び出します。

このプロパティをtrueに設定すると、他のスレッドで変更が発生したときにこの Realm を自動的に更新します。

true （デフォルト）に設定されている場合、他のスレッドで行われた変更は、変更がコミットされた後の実行ループの次のサイクルでこの Realm に反映されます。 falseに設定されている場合、最新データを取得するには、Realm でrefresh()を手動で呼び出して更新する必要があります。

デフォルトでは、バックグラウンド スレッドにはアクティブな実行ループがないため、 autorefreshがtrueに設定されている場合でも、最新バージョンに更新するにはrefresh()を手動で呼び出す必要があることに注意してください。

このプロパティが有効になっている場合でも、自動更新が行われる前にいつでもrefresh()を呼び出して Realm を更新できます。

自動更新が有効になっているかどうかにかかわらず、書込みトランザクションがコミットされたときに通知が送信されます。

強力な参照がないRealmでautorefreshを無効にしても効果はなく、次に Realm が作成されるときにautorefreshはtrueに戻ります。 これは通常、更新するものがないことを意味するため通常は関係ありません（管理対象のObject 、 List 、 Resultsは、それらを管理するRealmへの強力な参照を持っています）が、 autorefresh = falseを設定することを意味しますapplication(_:didFinishLaunchingWithOptions:) 以降の例では、Realm オブジェクトの保存が機能しません。

デフォルトは true です。

Realm と Realm によって管理される未処理のオブジェクトを最新データを指すように更新します。

この Realm が固定されている場合は を返します。

この Realm の固定（不変）スナップショットを返します。

固定された Realm は、Realm のデータの特定のバージョンの不変のスナップショット ビューです。 通常の Realm インスタンスとは異なり、Realm に行われた書込みを反映するためのライブアップデートは行われないため、任意のスレッドからアクセスできます。 固定された Realm への書込みは許可されておらず、書込みトランザクションを開始しようとすると例外がスローされます。

固定された Realm から読み取られるすべてのオブジェクトとコレクションも固定されます。

この Realm のライブ（可変）参照を返します。

返された Realm 参照から読み取られたすべてのオブジェクトとコレクションは、固定されなくなります。 まだ固定されていない Realm で呼び出されると自分自身が返されます。

指定されたオブジェクトの固定（不変）スナップショットを返します。

固定されたコピーは、指定されたオブジェクトが現在含まれているデータと同じデータを含む不変のオブジェクトですが、含まれている Realm に書込み (write) が行われても更新されません。 ライブオブジェクトと違い、固定オブジェクトには任意のスレッドからアクセスできます。

このオブジェクトのライブ（可変）参照を返します。

このメソッドでは、同じ固定オブジェクトのライブ コピーへの管理対象アアクセス権が作成されます。 すでに存在するオブジェクトで呼び出される場合は、自分自身を返します。

指定されたコレクションの固定（不変）スナップショットを返します。

固定コピーは、特定のコレクションに現在含まれているデータと同じデータを含む不変のコレクションですが、含まれている Realm への書込み (write) が行われても更新されません。 ライブコレクションとは異なり、固定コレクションには任意のスレッドからアクセスできます。

Realm によって管理されているすべてのObject 、 Results 、 LinkingObjects 、 Listを無効にします。

Realm は、アクセスされるデータのバージョンに対して読み取りロックを保持するため、異なるスレッドで Realm に加えられた変更によって、この Realm が認識するデータが変更または削除されることはありません。 このメソッドを呼び出すと読み取りロックが解除され、ディスクで使用される領域は、ファイルを拡張するのではなく、後の書込みトランザクションで再利用できるようになります。 このメソッドは、以前に Realm から不要になったデータを読み込んだバックグラウンド スレッドで長時間のブロッキング操作を実行する前に呼び出す必要があります。

現在のスレッドでこのRealmインスタンスから取得されたすべてのObject 、 Results 、およびListインスタンスは無効化されます。 ObjectとArrayは使用できません。 Resultsは空になります。 Realm 自体は有効なままであり、次に Realm からデータが読み取られるときに、新しい読み取りトランザクションが暗黙的に開始されます。

Realm からのデータを読み込まずに、または Realm からのデータを読み取る前に、このメソッドを複数回連続で呼び出すと、操作は実行されません。

指定されたローカル URL に Realm の圧縮され、オプションで暗号化されたコピーを書込みます。

宛先ファイルがすでに存在することはできません。

このメソッドが書込みトランザクション (write transaction) 内から呼び出されると、前の書込みトランザクションがコミットされた時点のデータではなく、現在のデータが書き込まれることに注意してください。

指定された構成の Realm ファイルがディスク上にローカルに存在するかどうかを確認します。

非同期、メモリ内以外の Realm の場合、これはFileManager.default.fileExists(atPath:)と同じです。 同期された Realm の場合、Realm を開くときに実行されるように、サーバー、仮想パス、ユーザーに基づいてディスク上の実際のパスを計算します。

@ param config の有無を確認するための Realm 構成。 @return 指定された構成の Realm ファイルがディスクに存在する場合は true、それ以外の場合は false を返します。

指定された構成のローカル Realm ファイルと関連する一時ファイルを削除します。

これにより、特定の構成で Realm を開くことで作成される「.realm」、「.note」、および「.management」ファイルが削除されます。 .lock ファイル（永続化されたデータを含まず、Realm ファイルが開かれるたびに最初から再作成される）は削除されません。

Realm は現在、スレッドまたは別のプロセスで開いてはなりません。 その場合、.alreadyOpen というエラーがスローされます。 削除が発生している間に別のスレッドで Realm を開こうとするとブロックされ、その後新しい Realm を作成してそれを開きます。

Realm がすでに存在しない場合は、 falseが返されます。

@ param config 削除する Realm を識別する Realm 構成。 @return ファイルが削除された場合は true、それ以外の場合は false です。

オブジェクトが変更されるたびに Vid を発行する出版社。

名前に関係なく、コレクションが変更された後にこれが実際に発行します。

Realm エラー ドメイン内のエラー コードを記述する構造体。 値は、特に Realm インスタンスの初期化時に発生するさまざまな回復可能なエラーをキャッチするために使用できます。

let realm: Realm?
do {
    realm = try Realm()
} catch Realm.Error.incompatibleLockFile {
    print("Realm Browser app may be attached to Realm on device?")
}

指定されたパスにある Realm で指定された Realm 構成の移行ブロックを実行します。

このメソッドは Realm を初めて開くときに自動的に呼び出され、明示的に呼び出す必要はありません。 このメソッドを呼び出すことで、移行がいつどのように実行されるかを正確に制御できます。

2 つのRealmインスタンスが等しいかどうかを返します。

Realm に変更が加えられたことを示す通知。

Configurationインスタンスでは、Realm のインスタンスを作成するために使用されるさまざまなオプションについて説明します。

Configuration インスタンスは単純な Swift 構造体です。 RealmやObjectとは異なり、ミューテーションがない限り、スレッド間で自由に共有できます。

クラス サブセットの構成値の作成（ objectClassesプロパティの設定）にはコストがかかる場合があります。 このため、Realm を開くたびに新しい値を作成するのではなく、通常、個別の構成ごとに 1 つの構成値をキャッシュして再利用することをお勧めします。

この Realm で使用される SyncSession を取得します。 これが同期された Realm でない場合は nil になります。

ThreadSafeReferenceが最初に作成されたときに参照されたオブジェクトと同じオブジェクトを返しますが、このスレッドの現在の Realm では解決されたオブジェクトを返します。 参照が作成された後にこのオブジェクトが削除された場合はnilを返します。