Realm オブジェクト スキーマの定義 - Flutter SDK

モデルの作成

import 'package:realm/realm.dart';

import 'package:realm_dart/realm.dart';

part 'schemas.realm.dart';

@RealmModel()
class _Car {
  @PrimaryKey()
  late ObjectId id;
  late String make;
  late String? model;
  late int? miles;
}

dart run realm generate

dart run realm_dart generate

.
├── schemas.dart
├── schemas.realm.dart // newly generated file
├── myapp.dart
└── ...rest of application

import './schemas.dart';
final hondaCivic = Car(ObjectId(), 'Honda', model: 'Civic', miles: 99);

Device Sync でのスキーマの使用

App Services スキーマは、アプリが永続化できるオブジェクトタイプをそれぞれ定義する有効なオブジェクト スキーマのリストです。 Realm 内のすべての同期されたオブジェクトは、App Services スキーマに準拠する必要があります。

クライアント アプリケーションは Realm を開くときにオブジェクト スキーマを提供します。 Realm にすでにデータが含まれている場合は、すでにスキーマが存在しており、それが開かれると、Realm はクライアント上のスキーマを既存のスキーマに対して検証します。

App Services スキーマは、次の方法で定義できます。

• 開発モードが有効になっている場合は、 オブジェクト スキーマが自動的に使用されます。

• App Services を使用して App Services スキーマを明示的に定義します。

オブジェクト スキーマを App Services と正常に同期するには、スキーマで、 RealmModelのプライマリキーとともにMapTo("_id")アノテーションを使用する必要があります。

@RealmModel()
class _SyncSchema {
  @PrimaryKey()
  @MapTo("_id")
  late ObjectId id;
  // ... other properties
}

スキーマの定義と、アプリケーションに対して考慮する必要があるアプローチの詳細については、 Realm スキーマの作成 に関するドキュメントを参照してください。

サポートされているデータ型

Realm スキーマは、Realm 固有のタイプに加えて、多くの Dart 言語のデータ型をサポートします。 サポートされているすべてのデータ型の包括的なリファレンスについては、「 データ型 」を参照してください。

プロパティ注釈

注釈 を使用して、Realm オブジェクトモデルのプロパティに機能を追加します。 注釈は、プロパティを null 可能としてマークする、プライマリキーを設定する、プロパティを無視するなどの目的で使用できます。 利用可能なプロパティ注釈の詳細については、「 プロパティ注釈 」を参照してください。

関係プロパティを定義する

スキーマ内の Realm オブジェクト間の関係を定義できます。 Realm Flutter SDK は、対 1 の関係、対多の関係、逆の関係、他のオブジェクト内へのオブジェクトの埋め込みをサポートしています。 Realm オブジェクト スキーマで関係を定義する方法の詳細については、「 関係 」を参照してください。

モデルまたはクラスを別の名前にマッピング

MapTo を使用できます Realm オブジェクトモデルまたはプロパティを Realm に保存されている別の名前にマッピングするための注釈。これは、次のシナリオで役立ちます。 例:

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

• 移行を強制せずにクラスまたはフィールド名を変更します。

• 異なるパッケージで同じ名前の複数のモデル クラスをサポートします。

• Realm によって強制される 57 文字の制限よりも長いクラス名を使用します。

Atlas Device Sync を使用している場合、 MapTo注釈で指定した名前は永続化されたApp Services スキーマ名として使用されます。

@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;
}

非構造化データのモデル化

Flutter SDK バージョン2.0.0以降、 RealmValueプロパティ内に混合データのコレクションを保存できます。 この機能を使用すると、厳密なデータモデルを定義することなく、JSON や MongoDB ドキュメントなどの複雑なデータ構造をモデル化できます。

非構造化データとは、期待されるスキーマに簡単に準拠していないデータであるため、個々のデータ クラスにモデル化するのが困難または非効率的です。 たとえば、アプリには、実行時に構造が不明な高度に変数データや動的データがある場合があります。

コレクションを混合プロパティに保存すると、Device Sync を使用する際のパフォーマンス的な同期など、機能を犠牲にすることなく柔軟性が高まります。 そして、混合されていないコレクションと同じ方法でそれらを操作できます。

• 混合コレクションは最大100レベルまでネストできます。

• 混合コレクションのReactに対応する と をクエリできます。

• 個々の混合コレクション要素を検索して更新できます。

ただし、混合コレクションにデータを保存する場合、構造化スキーマを使用したり、JSON string を単一の string プロパティに直列化したりする場合よりパフォーマンスが低くなります。

アプリ内の非構造化データをモデル化するには、スキーマ内の適切なプロパティをRealmValue型として定義します。 次に、これらのRealmValueプロパティをRealmListまたはRealmValue要素のRealmMapコレクションとして設定できます。 Note that RealmValue cannot represent a RealmSet or an embedded object.

たとえば、変数イベント ログ オブジェクトをモデル化するときに、混合データのマップを含むRealmValueを使用できます。

// Define class with a `RealmValue` property
@RealmModel()
class _EventLog {
  @PrimaryKey()
  late ObjectId id;
  late String eventType;
  late DateTime timestamp;
  late String userId;
  late RealmValue details;
}

realm.write(() {
  // Add `eventLog` property data as a map of mixed data, which 
  // also includes nested lists of mixed data 
  realm.add(EventLog(ObjectId(), 'purchase', DateTime.now(), 'user123',
      details: RealmValue.from({
        'ipAddress': '192.168.1.1',
        'items': [
          {'id': 1, 'name': 'Laptop', 'price': 1200.00},
          {'id': 2, 'name': 'Mouse', 'price': 49.99}
        ],
        'total': 1249.99
      })));
  final eventLog = realm.all<EventLog>().first;
  final items = eventLog.details.asMap();
  print('''
      Event Type: ${eventLog.eventType}
      Timestamp: ${eventLog.timestamp}
      User ID: ${eventLog.userId}
      Details:
        Item: 
  ''');
  for (var item in items.entries) {
    print('${item.key}: ${item.value}');
  }

Event Type: purchase
Timestamp: 2024-03-18 13:50:58.402979Z
User ID: user123
Details:
Item:
   ipAddress: RealmValue(192.168.1.1)
   items: RealmValue([RealmValue({id: RealmValue(1), name: RealmValue(Laptop), price: RealmValue(1200.0)}), RealmValue({id: RealmValue(2), name: RealmValue(Mouse), price: RealmValue(49.99)})])
   total: RealmValue(1249.99)

Realm オブジェクトの生成

Realm モデルが完了したら、 RealmObject を生成する必要があります クラスを使用してアプリケーション内で使用します。

次のコマンドを実行して、 RealmObjectsを生成します。

dart run realm generate

dart run realm_dart generate

これを実行すると、モデルの作成 セクションでRealmModelクラスを定義したディレクトリに新しいファイルにパブリック クラスが作成されます。

生成されたファイルのベース名は、RealmModel .realm.dartを含むファイルと同じで、 で終わる。たとえば、 RealmModelを含むファイルの名前がschemas.dartの場合、生成されたファイルはschemas.realm.dartになります。

// ...import packages
part 'schemas.realm.dart';
@RealmModel()
// ...model definition

データモデルが変更されるたびにRealmObjectsを生成するよう監視する場合は、コマンドに--watchフラグを含めます。

dart run realm generate --watch

dart run realm_dart generate --watch

ジェネレーター キャッシュをクリーンにするには、コマンドに--cleanフラグを含めます。 ジェネレーター キャッシュをクリーンにするとデバッグ時に役立ちます。

dart run realm generate --clean

dart run realm_dart generate --clean

非対称オブジェクトの定義

非対称オブジェクトには Flexible Sync が必要です。 非対称オブジェクトを定義するには、 ObjectType.asymmetricObjectを@RealmModel()に渡します。

@RealmModel(ObjectType.asymmetricObject)
class _WeatherSensor {
  @PrimaryKey()
  @MapTo("_id")
  late ObjectId id;
  late String deviceId;
  late double modtemperatureInFahrenheitel;
  late double barometricPressureInHg;
  late double windSpeedInMph;
}

Flutter SDK バージョン 1.5.0 以前では、 asymmetricObject型からRealmObjectsにリンクできません。 SDK バージョン 1.6.0 以降では、埋め込みオブジェクト タイプに加えて、 asymmetricObjectタイプもRealmObjectsにリンクできます。

Data Ingest の詳細については、「 Atlas へのデータのストリーム 」を参照してください。