プロパティ注釈 - Flutter SDK

項目一覧

必須プロパティと任意のプロパティ

デフォルトのフィールド値
プライマリキー
プロパティまたはクラスを別の名前にマッピング
Realm スキーマからのプロパティの無視
インデックスのプロパティ
全文検索インデックス

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

注釈を使用して、Realm オブジェクトモデルのプロパティに機能を追加できます。

必須プロパティと任意のプロパティ

Dart では、値の型は暗黙的に null 以外ですが、を追加することで任意（null 可能）にすることができます。。プロパティを任意にするには、 ?を含めます。

class _Vehicle {
  @PrimaryKey()
  late ObjectId id;
  late String? maybeDescription; // optional value
  late double milesTravelled = 0; // 0 is default value
  @Ignored()
  late String notInRealmModel;
  @Indexed()
  late String make;
  @MapTo('wheels') // 'wheels' is property name in the RealmObject
  late int numberOfWheels;
}

デフォルトのフィールド値

組み込みの言語機能を使用して、プロパティにデフォルト値を割り当てることができます。プロパティ宣言でデフォルト値を割り当てます。

class _Vehicle {
  @PrimaryKey()
  late ObjectId id;
  late String? maybeDescription; // optional value
  late double milesTravelled = 0; // 0 is default value
  @Ignored()
  late String notInRealmModel;
  @Indexed()
  late String make;
  @MapTo('wheels') // 'wheels' is property name in the RealmObject
  late int numberOfWheels;
}

プライマリキー

プライマリキー注釈は、プライマリキープロパティを示します。プライマリキーは、Realm 内のオブジェクトの一意の識別子です。同じ型の他のオブジェクトは、オブジェクトのプライマリキーを共有できません。

プライマリキーの重要な要素：

Realm にオブジェクトを追加した後は、プライマリキーを変更できません。
RealmModel 内の 1 つのプロパティにのみプライマリキーを追加します。
プライマリキーになることができるのは、 String 、 int 、 ObjectId 、 Uuidタイプのみです。
Realm はプライマリキーを自動的にインデックス化します。
プライマリキーは null 可能です。 nullは、コレクション内の 1 つのオブジェクトのプライマリキーのみにすることができます。

class _Vehicle {
  @PrimaryKey()
  late ObjectId id;
  late String? maybeDescription; // optional value
  late double milesTravelled = 0; // 0 is default value
  @Ignored()
  late String notInRealmModel;
  @Indexed()
  late String make;
  @MapTo('wheels') // 'wheels' is property name in the RealmObject
  late int numberOfWheels;
}

プロパティまたはクラスを別の名前にマッピング

The MapTo 注釈は、モデルまたはプロパティを別の名前で永続化する必要があることを示します。コードスタイルの規則が異なる可能性がある異なるバインディングで Realm を開く場合に便利です。例:

命名規則が異なるプラットフォーム間での操作を容易にします。たとえば、Device Sync スキーマのプロパティ名がスニペットのケースを使用する場合、プロジェクトはキャメルケースを使用します。
移行を強制せずにクラスまたはフィールド名を変更します。

@RealmModel()
@MapTo('naval_ship')
class _Boat {
  @PrimaryKey()
  late ObjectId id;
  late String name;
  late int? maxKnots;
  late int? nauticalMiles;
}

class _Vehicle {
  @PrimaryKey()
  late ObjectId id;
  late String? maybeDescription; // optional value
  late double milesTravelled = 0; // 0 is default value
  @Ignored()
  late String notInRealmModel;
  @Indexed()
  late String make;
  @MapTo('wheels') // 'wheels' is property name in the RealmObject
  late int numberOfWheels;
}

Realm スキーマからのプロパティの無視

無視を追加した場合RealmModel のプロパティに注釈を付けない場合、Realm オブジェクトジェネレーターRealmObject はスキーマにプロパティを含めないか、Realm に永続化します。

class _Vehicle {
  @PrimaryKey()
  late ObjectId id;
  late String? maybeDescription; // optional value
  late double milesTravelled = 0; // 0 is default value
  @Ignored()
  late String notInRealmModel;
  @Indexed()
  late String make;
  @MapTo('wheels') // 'wheels' is property name in the RealmObject
  late int numberOfWheels;
}

インデックスのプロパティ

インデックス付きのを追加する注釈を使用して、フィールドにインデックスを作成します。インデックスを使用すると、書き込み時間が若干遅くなり、ストレージとメモリのオーバーヘッドが増加する可能性を犠牲にして、一部のクエリを大幅に高速化できます。 Realm はインデックスをディスクに保存するため、Realm ファイルが大きくなります。各インデックスエントリは最小で12バイトです。インデックスは null にすることができます。

次のデータ型でインデックスを作成できます。

bool
int
String
ObjectId
Uuid
DateTime
RealmValue

class _Vehicle {
  @PrimaryKey()
  late ObjectId id;
  late String? maybeDescription; // optional value
  late double milesTravelled = 0; // 0 is default value
  @Ignored()
  late String notInRealmModel;
  @Indexed()
  late String make;
  @MapTo('wheels') // 'wheels' is property name in the RealmObject
  late int numberOfWheels;
}

全文検索インデックス

標準インデックスに加えて、Realm は string プロパティの全文検索（FTS）インデックスもサポートしています。標準インデックスの有無にかかわらず string フィールドをクエリできますが、FTS インデックスを使用すると複数の単語とフレーズを検索し、その他を除外できます。

FTS インデックスのクエリの詳細については、「全文検索でのフィルタリング」を参照してください。

プロパティに FTS インデックスを作成するには、 @Indexed 注釈を付けて RealmIndexType を指定するfullText と同様。これにより、プロパティに対する全文クエリが可能になります。次の例では、パターンと具体的なプロパティを FTS 注釈でマークします。

@RealmModel()
class _Rug {
    @PrimaryKey()
    late ObjectId id;
    @Indexed(RealmIndexType.fullText)
    late String pattern;
    @Indexed(RealmIndexType.fullText)
    late String material;
    late int softness;
}

戻る

関係

Realm オブジェクトスキーマの更新

必須 プロパティと任意のプロパティ