タイプエイリアス

PropertyType は、Realm モデルでサポートされているすべてのプロパティ タイプを説明する列挙型です。

詳細については、「オブジェクトモデルとスキーマ」を参照してください。

プリミティブの型

• Int
• Bool
• Float
• Double

オブジェクト タイプ

• String
• Data
• Date
• Decimal128
• ObjectId

関係: 配列（Swift、 List ）とObject型

• Object
• Array

Realm への変更をサブスクライブするメソッドから返されるオペレーターのトークン。

Realm App の構成を表すオブジェクト

Realm Cloud ユーザー API キーでネットワーク呼び出しを実行するクライアントを表すオブジェクト

Realm Cloud ユーザー登録およびパスワード機能に対してネットワーク呼び出しを実行するクライアントを表すオブジェクト

ユーザーのソーシャル プロファイルを表すオブジェクト。

エラーを報告するために使用されるブロックの種類

通知をプッシュするデバイスを登録するために、Realm Cloud でネットワーク呼び出しを実行するクライアントを表すオブジェクト

ユーザー APIKeyProviderClient 内で使用されるオブジェクト

Appには、Realm アプリケーション バックエンドで通信するための基本セットがあります。 このインターフェースは、ログインと認証へのアクセスを提供します。

この委任を使用して、認証が成功または失敗したときにコールバックを提供します

AsymmetricObject は、非対称 Realm オブジェクトを定義するために使用される基本クラスです。

非対称オブジェクトはcreate(_ type:, value:)関数を使用してのみ作成でき、追加、削除、クエリの実行はできません。 作成されると、非対称オブジェクトは MongoDB database に一方向に同期され、ローカルではアクセスできません。

Object内で非対称オブジェクトをリンクすることは許可されていないため、エラーがスローされます。

AsymmetricObjectでサポートされているプロパティ タイプはObjectと同じですが、非対称オブジェクトは埋め込みオブジェクトにのみリンクできるため、 ObjectとList<Object>プロパティはサポートされていません（ EmbeddedObjectとList<EmbeddedObject>は）。

class Person: AsymmetricObject {
    @Persisted(primaryKey: true) var _id: ObjectId
    @Persisted var name: String
    @Persisted var age: Int
}

BSONドキュメントを表す辞書オブジェクト。

MaxKey は、他の BSON types と比較すると、常に最大値になります

MinKey は、他のBSON typesと比較すると、常に最小値になります

Object は、Realm モデル オブジェクトを定義するために使用されるクラスです。

Realm では、 Objectをサブクラス化し、管理するプロパティを追加することでモデル クラスを定義します。 次に、 Objectクラスを直接使用するのではなく、カスタム サブクラスをインスタンス化して使用します。

class Dog: Object {
    @Persisted var name: String
    @Persisted var adopted: Bool
    @Persisted var siblings: List<Dog>
}

サポートされているプロパティの型

• String
• Int, Int8, Int16, Int32, Int64
• Float
• Double
• Bool
• Date
• Data
• Decimal128
• ObjectId
• UUID
• AnyRealmValue
• 生の型が有効なプロパティ型である任意の RawRepresentationable 列挙型。 列挙型はPersistableEnumに準拠しているものとして明示的にマークする必要があります。
• Object サブクラス（多対 1 の関係をモデル化するため）
• EmbeddedObject サブクラス、1 対 1 の関係を所有するモデル化

上記のすべてのタイプは、 AnyRealmValueを除き、 Optionalにすることもできます。 ObjectとEmbeddedObjectのサブクラスは任意である必要があります。

個々の 値に加えて、次の 3 つの異なるコレクション タイプがサポートされています。

• List<Element>: Arrayに似た順序付き可変コレクション。
• MutableSet<Element>: Setと同様の順序付けられていない一意のコレクション。
• Map<String, Element>: Dictionaryと同様の順序付けられていないキーと値のコレクション。

コレクションの要素タイプは、上記でリストしたサポートされている非コレクション プロパティ タイプのいずれかになります。 コレクション自体は 任意 ではない場合もありますが、 ObjectまたはEmbeddedObjectサブクラスのリストとセットは除き、コレクション内の値は である場合があります。

最後に、 LinkingObjectsプロパティは、このプロパティにリンクされているオブジェクトを追跡するために使用できます。

Realm によって保存されるすべてのプロパティは、 @Persistedで明示的にマークされる必要があります。 @Persistedでマークされていないプロパティは、Realm によって完全に無視され、任意のタイプになります。

クエリ

objects(_:)インスタンス メソッドを呼び出すと、Realm から特定のタイプのすべてのオブジェクトを検索できます。

関係

詳しくは、 Swift ガイドを参照してください。

EmbeddedObject は、埋め込み Realm モデル オブジェクトを定義するために使用される基本クラスです。

埋め込みオブジェクトは通常のオブジェクトと同様に機能しますが、単一の親オブジェクト（それ自体が埋め込まれる場合）によって所有されます。 通常の最上位オブジェクトとは異なり、埋め込みオブジェクトを で直接作成したり、Realm に追加したりすることはできません。 代わりに、親オブジェクトの一部として、または管理されていないオブジェクトを親オブジェクトの プロパティに割り当てた場合にのみ作成できます。 埋め込みオブジェクトは、親オブジェクトが削除されるか、親が埋め込みオブジェクトを指すように変更されると、 オブジェクト プロパティを再割り当てするか、それを含むリストから埋め込みオブジェクトを削除して、自動的に削除されます。

埋め込みオブジェクトには、それらにリンクする親オブジェクトが 1 つだけあるため、既存の管理対象オブジェクトにリンクしようとすると例外がスローされます。

EmbeddedObjectでサポートされているプロパティ タイプはObjectと同じですが、埋め込みオブジェクトが最上位オブジェクトにリンクできないため、 ObjectとList<Object>プロパティはサポートされていません（ EmbeddedObjectとList<EmbeddedObject>は）です。

埋め込みオブジェクトにはプライマリキーまたはインデックス付きプロパティを含めることはできません。

class Owner: Object {
    @Persisted var name: String
    @Persisted var dogs: List<Dog>
}
class Dog: EmbeddedObject {
    @Persisted var name: String
    @Persisted var adopted: Bool
    @Persisted(originProperty: "dogs") var owner: LinkingObjects<Owner>
}

緯度と経度によって作成される点の座標を表す構造体。

• 緯度の範囲は -90 度から 90 度までです。
• 経度の範囲は -180 から 180 度までです。

GeoPointを作成しようとすると、この範囲外の値は nil を返します。

Realm での地理的ポイントの永続化は現在、アベイラビリティー型を使用して行われています。つまり、特定の形状を持つ任意のモデル クラスは、地理的場所が含まれているかのようにクエリできます。

次は必須です。

• stringポイント の値が の@Persisted var type: String = "Point" プロパティ。
• 経度と緯度のペアを含むリスト: @Persisted private var coordinates: List<Double> 。

埋め込みオブジェクトを使用するアプローチをお勧めします。

public class Location: EmbeddedObject {
  @Persisted private var coordinates: List<Double>
  @Persisted private var type: String = "Point"

  public var latitude: Double { return coordinates[1] }
  public var longitude: Double { return coordinates[0] }

  convenience init(_ latitude: Double, _ longitude: Double) {
      self.init()
      // Longitude comes first in the coordinates array of a GeoJson document
      coordinates.append(objectsIn: [longitude, latitude])
    }
  }

地理空間geoWithinクエリで使用できる正方形を表すクラス。

地理空間geoWithinクエリで使用できる多角形を表すクラス。

GeoPolygonは、 outerRingと呼ばれる と外側のPolygonに準拠し、 holesと呼ばれる 0 個以上の内部Polygonに準拠した形状を記述します。これは、外側のPolygon内の内部穴の数が無制限を表すものです。 Polygonは少なくとも 3 つのセグメントに準拠した形状を記述します。閉じた多角形を示すには、最後の GeoPoint と最初のが同じである必要があります（つまり、多角形を定義するには少なくとも 4 つのポイントが必要）。 GeoPolygon内の穴は完全に外側の円内になければなりません

holeには次の制限があります。

• 穴はまたがることはできません。つまり、層の境界は他の層の層と層の両方と交差することはできません。
• 穴はエッジを共有しない場合があります。つまり、穴にエッジ AB が含まれている場合、他の層にはそれが含まれていない場合があります。
• 穴は垂直方向を共有する場合がありますが、単一の穴にドライバーが 2 回表示されることはありません。
• 空の穴はありません。

• ネストは 1 つのみです。

この構造は、距離を表現/変換するためのヘルパーです。 で表されるような地理空間クエリで使用できます GeoCircle

円を表すクラス。地理空間geoWithinクエリで使用できます。

Realm の移行に使用される移行ブロックのタイプ。

移行中に使用されるオブジェクトクラス。

Realm 内のオブジェクトの古いバージョンと新しいバージョンの両方を提供するブロック タイプ。 オブジェクト プロパティには、サブスクリプションを使用してのみアクセスできます。

Migration インスタンスは、スキーマ移行を容易にするために情報をカプセル化します。

Realm のバージョンを更新するときに、 Migrationインスタンスはユーザー定義のMigrationBlockブロックに渡されます。 このインスタンスは、古いデータベース スキーマと新しいデータベース スキーマ、Realm 内のオブジェクトへのアクセスを提供し、移行中に Realm を変更する機能を提供します。

MongoClientでは、Realm Cloud サービスを介して MongoDB database の読み取りと書込みが可能になります。

これにより、 MongoDatabaseのインスタンスへのアクセスが提供されます。これにより、データを保持する特定のMongoCollectionへのアクセスが提供されます。

MongoDatabaseは、データを含むコレクションのグループを保持する MongoDB database を表します。

MongoClientから取得できます。

これを使用して、データの読み取りと書き込み用のMongoCollectionを取得します。

MongoCollectionでfindコマンドを実行するときに使用するオプション。

MongoCollectionでfindOneAndUpdate 、 findOneAndReplace 、またはfindOneAndDeleteコマンドを実行するときに使用するオプション。

updateOneまたはupdateMany操作の結果MongoCollection 。

正常に挿入が行われた場合は Result.success(DocumentId) を返すブロック、または Result.failure(error) は

成功した insertMany または Result.failure(error) で Result.success([ObjectId]) が返されるブロック

検索操作が成功した場合は Result.success([Document]) を返すブロック、または Result.failure(error) は

成功した findOne 操作または Result.failure(error) 操作で Result.success(Document?) が返されるブロック

カウント操作が成功した場合は Result.success(Int) を返すブロック、または Result.failure(error) を返す

成功した更新操作で Result.success(UpdateResult) を返すブロック、または Result.failure(error) を返す

MongoCollectionは MongoDB コレクションを表します。

インスタンスはMongoDatabaseから取得できます。

作成、読み取り、更新、削除のメソッドが利用できます。

Realm Cloud サーバーに対する操作は非同期で実行されます。

ミドルウェアとして機能し、 WatchStream でイベントを処理します

非同期トランザクションの ID。

Realm 内のデータが変更されたときに通知目的で実行するブロックのタイプ。

Logger は、独自のカスタムログロジックを作成するために使用されます。

Loggerのインスタンスを作成する独自のロガーを定義し、ログ メッセージがあるたびに呼び出されるログ関数を定義できます。

let logger = Logger(level: .all) { level, message in
   print("Realm Log - \(level): \(message)")
}

Logger.sharedを使用して、このカスタム ロガーをデフォルトのロガーとして設定します。

   Logger.shared = inMemoryLogger

Atlas App Services ユーザーを表すオブジェクト。

Atlas App Services の同期関連機能を設定および管理するマネージャー。

同期クライアントでタイムアウトと間隔を設定するオプション。

特定の Realm のクライアントとサーバー間の通信を表すセッション オブジェクト。

閉じる の閉じるタイプSyncManagerに設定すると、エラーをアプリケーションに報告できるようになります。

特定の API がSyncUserオブジェクトをアプリケーションに非同期に返すために使用される クローズド の タイプ 。

SDK の同期機能に関連するエラーです。 SyncManagerに登録されているエラー ハンドラーによって報告されるすべてのエラーは、このタイプです。

サーバーによって拒否された書込み (write) に関する拡張情報。

サーバーは、権限、追加のサーバー側検証が失敗した、オブジェクトがFlexible Sync サブスクライブに一致しなかったためなどの理由で、クライアントによる書込みを拒否することがあります。 このような状況が発生すると、拒否された書込みとその理由に関する情報を含む、 nil 以外のSyncError.compensatingWriteInfoフィールドで.writeRejectedエラーが報告されます。

この情報はデバッグとログ記録のみを目的とした情報です。 reason string はサーバーによって生成され、安定していることが保証されていないため、プログラムによってこれらを使用して操作を実行しようとすると、警告なしで中断されます。

Atlas App Services にリクエストを行う際に発生したエラー。 失敗する可能性のあるほとんどのユーザーおよびアプリ関数は、このタイプのエラーを報告します。

ログのレベルを指定するために使用できる列挙型。

Atlas App Services で使用できるさまざまな認証プロバイダを表す値を持つデータ型。

Realm ファイルが最初に開かれたときに初期サブスクリプションが入力される方法を制御する構成。