类型别名

PropertyType 是一个枚举，描述 Realm 模型支持的所有属性类型。

有关详细信息，请参阅对象模型和模式。

基元类型

• Int
• Bool
• Float
• Double

Realm 对象类型

• String
• Data
• Date
• Decimal128
• ObjectId

关系：数组（在 Swift 中为List ）和Object类型

• Object
• Array

订阅 Realm 变更的方法返回的不透明令牌。

表示 Realm 应用配置的对象

表示对 Realm Cloud 用户 api 密钥执行网络调用的客户端的对象

表示对 Realm Cloud 用户注册和密码函数执行网络调用的客户端的对象

表示用户社交档案的对象。

用于报告错误的区块类型

表示客户端的对象，该客户端在 Realm Cloud 上执行网络调用以注册设备以推送通知

在 UserAPIKeyProviderClient 中使用的对象

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文档的字典对象。

与其他 BSON types 相比，MaxKey 将始终是最大值

与其他 BSON types 相比，MinKey 将始终是最小值

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
• 原始类型为合法属性类型的任何 RawRepresentable 枚举。 必须将枚举显式标记为符合PersistableEnum 。
• Object 子类，用于建模多对一关系
• EmbeddedObject 子类，用于对拥有一对一关系进行建模

除 之外，上述所有类型也可能为Optional 。AnyRealmValueObject和EmbeddedObject子类必须为可选。

除单个值外，还支持三种不同的collection类型：

• List<Element>：类似于Array的有序可变collection。
• MutableSet<Element>：类似于Set的无序唯一collection。
• Map<String, Element>：类似于Dictionary的无序键值collection。

collection的元素类型可以是上面列出的任何受支持的非collection属性类型。collection本身可能不是可选的，但其中的值可能是可选的， Object或EmbeddedObject子类的列表和集合除外。

最后， LinkingObjects属性可用于追踪哪些对象链接到此对象。

Realm 应存储的所有属性都必须显式标有@Persisted 。 任何未标记@Persisted的属性都将被 Realm 完全忽略，并且可以是任何类型。

查询

您可以通过调用objects(_:)实例方法从 Realm 中检索给定类型的所有对象。

关系

有关更多详细信息，请参阅我们的Swift 指南。

EmbeddedObject 是用于定义嵌入式 Realm 模型对象的基类。

嵌入式对象的工作方式与普通对象类似，但由单个父对象（其本身可能是嵌入式对象）拥有。 与普通的顶级对象不同，嵌入式对象不能直接在 Realm 中创建或添加到 Realm 中。 相反，它们只能作为父对象的一部分创建，或者通过将非托管对象分配给父对象的属性来创建。 当父对象被删除或父对象被修改为不再指向嵌入式对象时（通过重新分配对象属性或从包含它的列表中删除嵌入式对象），嵌入式对象会自动删除。

嵌入式对象只能有一个链接到它们的父对象，尝试链接到现有的托管嵌入式对象会引发异常。

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描述了一种由外部Polygon （称为outerRing ）和 0 个或多个内部Polygon （称为holes ）一致的形状，它表示外部Polygon内有无限数量的内孔。 Polygon描述由至少三个线段组成的形状，其中最后一个和第一个GeoPoint必须相同才能表示闭合多边形（这意味着至少需要 4 个点才能定义多边形）。 GeoPolygon中的内孔必须完全位于外环内部

hole具有以下限制：

• 孔不得交叉，即一个孔的边界不得与任何其他孔的内部和外部相交。
• 孔不得共享边，即，如果一个孔包含边 AB，则其他孔不得包含该边。
• 孔可以共享顶点，但任何顶点不得在单个孔中出现两次。
• 没有一个洞是空的。

• 只允许嵌套一次。

此结构是表示/转换距离的辅助函数。 它可用于地理空间查询，例如由 GeoCircle

表示圆形的类，可用于地理空间geoWithin查询。

用于迁移 Realm 的迁移区块的类型。

迁移期间使用的对象类。

一种区块类型，提供 Realm 中对象的旧版本和新版本。 只能使用下标访问对象属性。

Migration 实例封装了旨在促进模式迁移的信息。

更新 Realm 的版本时， Migration实例会传递到用户定义的MigrationBlock区块中。 此实例提供对新旧数据库模式、Realm 中的对象的访问，并提供在迁移期间修改 Realm 的功能。

MongoClient支持通过 Realm Cloud 服务读取和写入 MongoDB 数据库。

它提供对MongoDatabase实例的访问权限，而这些实例又提供对保存数据的特定MongoCollection的访问权限。

MongoDatabase代表 MongoDB database，其中包含一组包含数据的collection。

可以从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([文档]) 或 Result.failure(error) 的区块

在 findOne 操作成功时返回 Result.success(文档?) 或 Result.failure(error) 的区块

在计数操作成功时返回 Result.success(Int) 或 Result.failure(error) 的区块

更新操作成功时返回 Result.success(UpdateResult) 或 Result.failure(error) 的区块

MongoCollection表示 MongoDB collection。

您可以从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上注册的错误处理程序报告的所有错误都属于这种类型。

有关被服务器拒绝的写入的扩展信息。

服务器有时会因权限、其他服务器端验证失败或对象与任何Flexible Sync订阅不匹配等原因而拒绝客户端进行的写入。发生这种情况时，会报告.writeRejected SyncError.compensatingWriteInfo错误，并带有非零的字段，其中包含有关哪些写入被拒绝及其原因的信息。

此信息仅用于调试和日志记录目的。 reason字符串由服务器生成，并不能保证其稳定性，因此尝试以编程方式使用它们执行任何操作都会中断，而不发出警告。

向 Atlas App Services 发出请求时发生的错误。 大多数可能失败的用户和应用程序功能都会报告此类错误。

可用于指定日志记录级别的枚举。

一种数据类型，其值代表可与 Atlas App Services 一起使用的不同身份验证提供者。

控制首次打开Realm 文件时如何填充初始订阅的配置。