定义 Realm 对象模型 - React Native SDK

声明可选属性

要将属性标记为可选，请使用对象语法并将 optional 设置为 true 。您还可以使用简化的语法：将问号 ? 附加到类型。这最适合基本类型。对于更复杂的类型，应使用更具体的对象语法。

在下面的 Person 类示例中， age 和 birthday 属性都是可选的。

class Person extends Realm.Object<Person> {
  name!: string;
  age?: number;
  birthday?: Date;
  static schema: ObjectSchema = {
    name: 'Person',
    properties: {
      name: 'string',
      age: {
        type: 'int',
        optional: true,
      },
      // You can use a simplified syntax instead. For
      // more complicated types, use the object syntax.
      birthday: 'date?',
    },
  };
}

声明主键

要将某个属性指定为对象类型的主键，请将模式的 primaryKey 字段设置为属性名称。

在以下 Task 类的示例中，我们将 _id 属性指定为主键。

为属性创建索引

如果经常根据特定属性执行 读取操作 ，则可以为该属性建立索引以优化性能。Realm 支持为字符串、整数、布尔值、 Date 、 UUID 和 ObjectId 属性建立索引。

要为给定属性建立索引，请将该属性的 indexed 字段设置为 true 。

在以下 Book 类的示例中，我们在 name 属性上定义了一个索引。

设置全文搜索索引

除了标准索引外，Realm 还支持对字符串属性创建 Atlas 全文搜索索引。虽然无论是否使用标准索引都可以查询字符串字段，但 FTS 索引支持搜索多个词汇和短语并排除其他。

有关查询 FTS 索引的更多信息，请参阅 使用全文搜索进行筛选 。

要创建 FTS 索引，请将 索引 类型设置为 'full-text' 。 这将启用对该属性的全文查询。 在以下示例中，我们将 name 属性的索引类型设置为 'full-text' ：

class Book extends Realm.Object<Book> {
  name!: string;
  price?: number;
  static schema: ObjectSchema = {
    name: 'Book',
    properties: {
      name: {type: 'string', indexed: 'full-text'},
      price: 'int?',
    },
  };
}

设置默认属性值

要定义默认值，请将属性值设置为具有 type 字段和 default 字段的对象。

在以下 Car 类的示例中，我们定义了一个默认值为 0 的 miles 属性。

在 Realm.js v11.1.0 及更高版本中，您可以使用函数来定义动态默认值，例如下例中的 timestamp 属性。

重新映射属性

要在代码中使用与 Realm 中存储的属性名称不同的属性名称，请将 mapTo 设置为代码中显示的属性名称。

在以下 Employee 类的示例中，我们将 first_name 属性重映射到 firstName 。

定义非对称对象

如果您使用灵活同步并且需要将集合从设备单向同步到 Atlas 数据库，则可以在对象模式上设置 asymmetric 属性。