サポートされているタイプ - Swift SDK

結果とセクション化された結果

Swift SDK結果コレクションは、クエリから検索されたオブジェクトを表すクラスです。 結果コレクションは、クエリ操作の遅延評価された結果を表します。 結果は不変です。結果コレクションに要素を追加したり、結果コレクションから要素を追加したり、削除したりすることはできません。 結果には、その内容を決定する関連付けられたクエリがあります。

Swift SDK は、 ResultsSectionを要素として保持する型セーフなコレクションであるSessionedResultsも提供します。 各ResultSectionは、特定のセクション キーに属するオブジェクトのみを含む結果のコレクションです。

たとえば、連絡先リストを含むアプリでは、 SessionedResults を使用して、セクションに分割された連絡先のリストを表示できます。各セクションには、特定の文字で始まるすべての連絡先が含まれています。 キーが「L」であるResultsSectionには、「Larry」、「Liam」、「LiSA」が含まれます。

プロパティとしてのコレクション

Swift SDK は、データモデルのプロパティとして使用できるいくつかの コレクション タイプ も提供しています。

1. モデル内で 対多の関係 を表すクラスである、 リスト 。

2. LinkingObjectsは、モデル内で逆の関係を表すクラスです。

3. MutableSetは、対多の関係を表すクラスです。

4. マップは、一意のキーを持つキーと値のペアの連想配列を表すクラスです。

5. AnyRealmCollection は、結果、リスト、またはリンクオブジェクトなどの具体的なRealmコレクションへの呼び出しを転送できる型消去クラス。

コレクションはライブ

ライブ オブジェクトと同様に、Realm コレクションは通常ライブ されます。

• ライブ結果のコレクションには、関連付けられているクエリの現在の結果が常に反映されます。

• ライブ リストには、Realm インスタンス上の関係の現在の状態が常に反映されます。

コレクションがライブでない場合は、次の 2 つのケースがあります。

• コレクションは管理されていません。 たとえば、Realm にまだ追加されていない Realm オブジェクトの List プロパティは、Realm からコピーされたものではありません。

• コレクションは固定されています。

コレクション通知と組み合わせると、ライブ コレクションによりクリーンでリアクティブなコードが可能になります。 たとえば、ビューにクエリの結果が表示されるとします。 ビュー クラスで結果コレクションへの参照を保持すると、結果コレクションを更新したり最新であることを検証したりすることなく、必要に応じて結果コレクションを読み取ることができます。

プロパティ チャート シート

@Persisted var boolName: Bool

@Persisted var optBoolName: Bool?

@Persisted var intName: Int

@Persisted var optIntName: Int?

@Persisted var floatName: Float

@Persisted var optFloatName: Float?

@Persisted var doubleName: Double

@Persisted var optDoubleName: Double?

@Persisted var stringName: String

@Persisted var optStringName: String?

@Persisted var dataName: Data

@Persisted var optDataName: Data?

@Persisted var dateName: Date

@Persisted var optDateName: Date?

@Persisted var decimalName: Decimal128

@Persisted var optDecimalName: Decimal128?

@Persisted var uuidName: UUID

@Persisted var optUuidName: UUID?

@Persisted var objectIdName: ObjectId

@Persisted var optObjectIdName: ObjectId?

@Persisted var listName: List<MyCustomObjectType>

@Persisted var mutableSetName: MutableSet<String>

@Persisted var mapName: Map<String, String>

@Persisted var anyRealmValueName: AnyRealmValue

@Persisted var optObjectPropertyName: MyCustomObjectType?

@Persisted var optEmbeddedObjectPropertyName: MyEmbeddedObjectType?

@Persisted var enumName: MyPersistableEnum

@Persisted var optEnumName: MyPersistableEnum?

@property BOOL boolName;

@property NSNumber<RLMBool> *optBoolName;

@property int intName;

@property NSNumber<RLMInt> *optIntName;

@property float floatName;

@property NSNumber<RLMFloat> *optFloatName;

@property double doubleName;

@property NSNumber<RLMDouble> *optDoubleName;

@property NSString *stringName;

@property NSString *optStringName;

@property NSData *dataName;

@property NSData *optDataName;

@property NSDate *dateName;

@property NSDate *optDateName;

@property RLMDecimal128 *decimalName;

@property RLMDecimal128 *optDecimalName;

@property NSUUID *uuidName;

@property NSUUID *optUuidName;

@property RLMObjectId *objectIdName;

@property RLMObjectId *optObjectIdName;

@property RLMArray<MyObject *><MyObject> *arrayName;

@property RLMSet<RLMString> *setName;

@property RLMDictionary<NSString *, NSString *><RLMString, RLMString> *dictionaryName;

@property MyObject *optObjectPropertyName;

@property MyEmbeddedObject *optEmbeddedObjectPropertyName;

@objc dynamic var value = false

let value = RealmProperty<Bool?>()

@objc dynamic var value = 0

let value = RealmProperty<Int?>()

@objc dynamic var value: Float = 0.0

let value = RealmProperty<Float?>()

@objc dynamic var value: Double = 0.0

let value = RealmProperty<Double?>()

@objc dynamic var value = ""

@objc dynamic var value: String? = nil

@objc dynamic var value = Data()

@objc dynamic var value: Data? = nil

@objc dynamic var value = Date()

@objc dynamic var value: Date? = nil

@objc dynamic var decimal: Decimal128 = 0

@objc dynamic var decimal: Decimal128?

@objc dynamic var uuid = UUID()

@objc dynamic var uuidOpt: UUID?

@objc dynamic var objectId = ObjectId.generate()

@objc dynamic var objectId: ObjectId?

let value = List<Type>()

let value = MutableSet<Type>()

let value = Map<String, String>()

let value = RealmProperty<AnyRealmValue>()

@objc dynamic var value: MyClass?

Unique Identifiers

ObjectId は、MongoDB 固有の 12 バイトの一意の値です。 UUIDは 16 バイトのグローバル一意の値です。 両方のタイプのインデックスを作成し、いずれかをプライマリキーとして使用します。

サイズ制限

データおよび string プロパティは 16 MB を超える値を保持できません。 大量のデータを保存するには、次のいずれかを実行します。

• データを 16MB のチャンクに分割します。または、

• ファイル システムにデータを直接保存し、ファイルへのパスを Realm 内のファイルに保存します。

アプリが 1 つのプロパティに 16 MB を超える保存を試みる場合、Realm は実行時例外をスローします。

サイズの制限やパフォーマンスへの影響を避けるためには、画像ファイルやビデオ ファイルなどの大きな API を Realm に直接保存しないことをお勧めします。 代わりに、ファイルをファイルストアに保存し、ファイルの場所と関連するメタデータのみを Realm 内に保持します。

AnyRealmCollection

具体的なコレクション型を知っていなくても、コレクションをプロパティまたは変数として保存するには、Swift の型システムに「AnyRealmCollection」のような型消去されたラッパーが必要です。

class ViewController {
//    let collection: RealmCollection
//                    ^
//                    error: protocol 'RealmCollection' can only be used
//                    as a generic constraint because it has Self or
//                    associated type requirements
//
//    init<C: RealmCollection>(collection: C) where C.ElementType == MyModel {
//        self.collection = collection
//    }
    let collection: AnyRealmCollection<MyModel>
    init<C: RealmCollection & _ObjcBridgeable>(collection: C) where C.ElementType == MyModel {
        self.collection = AnyRealmCollection(collection)
    }
}

可変セット

MutableSetコレクションは、個別の値を含む対多の関係を表します。 MutableSetは次のタイプ（およびそれらの任意のバージョン）をサポートしています。

• ブール

• データ

• 日付

• Decimal128

• Double

• Float

• Int

• Int8

• Int16

• Int32

• Int64

• オブジェクト

• ObjectId

• 文字列

• UUID

Swift の Set と同様に、MutableSet は、保存する型をパラメータ化するジェネリック型です。ネイティブSwiftコレクション と違い、 Realm可変セットは参照型であり、値型（構造体）とは対照的です。

MutableSetsミューテーション メソッドは、書込みトランザクション中にのみ呼び出せます。 その結果、管理Realmを読み取り専用のRealmとして開くと、 MutableSetsは不変になります。

結果 と同じ述語 を持つMutableSet をフィルタリングして並べ替えることができます。他の Realm コレクションと同様に、 MutableSetで変更リスナーを登録できます。

たとえば、 DogクラスモデルにはcitiesVisitedのMutableSetが含まれる場合があります。

class Dog: Object {
    @Persisted var name = ""
    @Persisted var currentCity = ""
    @Persisted var citiesVisited: MutableSet<String>
}

マップ/辞書

マップは、一意のキーを持つキーと値のペアを含む連想配列です。

Swift の 辞書 と同様に、Map は、キーと値の型がパラメータ化されるジェネリック型です。ネイティブSwiftコレクション と違い、 Realmマップは参照型（クラス）であり、値型（構造体）ではありません。

マップはオブジェクトのプロパティとして宣言できます。

class Dog: Object {
    @Persisted var name = ""
    @Persisted var currentCity = ""
    // Map of city name -> favorite park in that city
    @Persisted var favoriteParksByCity: Map<String, String>
}

Realm では、マップキーに.または$文字を使用できません。 パーセント エンコーディングとデコーディング を使用して、これらの許可されていない文字の 1 つを含むマップキーを保存できます。

// Percent encode . or $ characters to use them in map keys
let mapKey = "New York.Brooklyn"
let encodedMapKey = "New York%2EBrooklyn"

AnyRealmValue

AnyRealmValue は、さまざまなデータ型を保持できる Realm プロパティ型です。 サポートされているAnyRealmValueデータ型は次のとおりです。

• Int

• Float

• Double

• Decimal128

• ObjectID

• UUID

• ブール

• 日付

• データ

• 文字列

• リスト

• Map

• オブジェクト

AnyRealmValue MutableSetまたは埋め込みオブジェクトを保持できません。

この混合データ型はインデックス可能ですが、プライマリキーとして使用することはできません。 nullは許可値であるため、 AnyRealmValueを任意として宣言することはできません。

class Dog: Object {
    @Persisted var name = ""
    @Persisted var currentCity = ""
    @Persisted var companion: AnyRealmValue
}

地理空間データ

地理空間データ（「geodata」）では、地表の点と幾何学的オブジェクトを指定します。

地理空間データを永続化する場合は、 GeoJSON 仕様 に準拠する必要があります。

Swift SDK で地理空間データを永続化するには、データモデルで使用できる GeoJSON 互換の埋め込みクラスを作成します。

カスタム埋め込みオブジェクトには、GeoJSON 仕様に必要な 2 つのフィールドが含まれている必要があります。

• "Point"の値を持つtypeプロパティにマッピングするStringプロパティのフィールド: @Persisted var type: String = "Point"

• 緯度と経度のペアを含むcoordinatesプロパティにマッピングするList<Double>タイプのフィールド: @Persisted private var coordinates: List<Double>

class CustomGeoPoint: EmbeddedObject {
    @Persisted private var type: String = "Point"
    @Persisted private var coordinates: List<Double>
    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])
    }
}

型プロジェクションの宣言

Realm で 型プロジェクション を使用するには、次の手順に従います。

1. Realm のカスタム型プロトコルの 1 つを使用して、サポートされていないデータ型を Realm がサポートする型にマッピングします。

2. Realm オブジェクトモデルでプロジェクションされた型を @Perlisted プロパティとして使用する

// Extend a type as a CustomPersistable if if is impossible for
// conversion between the mapped type and the persisted type to fail.
extension CLLocationCoordinate2D: CustomPersistable {
    // Define the storage object that is persisted to the database.
    // The `PersistedType` must be a type that Realm supports.
    // In this example, the PersistedType is an embedded object.
    public typealias PersistedType = Location
    // Construct an instance of the mapped type from the persisted type.
    // When reading from the database, this converts the persisted type to the mapped type.
    public init(persistedValue: PersistedType) {
        self.init(latitude: persistedValue.latitude, longitude: persistedValue.longitude)
    }
    // Construct an instance of the persisted type from the mapped type.
    // When writing to the database, this converts the mapped type to a persistable type.
    public var persistableValue: PersistedType {
        Location(value: [self.latitude, self.longitude])
    }
}
// Extend a type as a FailableCustomPersistable if it is possible for
// conversion between the mapped type and the persisted type to fail.
// This returns nil on read if the underlying column contains nil or
// something that can't be converted to the specified type.
extension URL: FailableCustomPersistable {
    // Define the storage object that is persisted to the database.
    // The `PersistedType` must be a type that Realm supports.
    public typealias PersistedType = String
    // Construct an instance of the mapped type from the persisted type.
    // When reading from the database, this converts the persisted type to the mapped type.
    // This must be a failable initilizer when the conversion may fail.
    public init?(persistedValue: String) { self.init(string: persistedValue) }
    // Construct an instance of the persisted type from the mapped type.
    // When writing to the database, this converts the mapped type to a persistable type.
    public var persistableValue: String { self.absoluteString }
}

extension URL: FailableCustomPersistable {
   // The `PersistedType` cannot be an optional, so this is not a valid
   // conformance to the FailableCustomPersistable protocol.
   public typealias PersistedType = String?
   ...
}
class Club: Object {
   @Persisted var id: ObjectId
   @Persisted var name: String
   // Although the `PersistedType` cannot be optional, you can use the
   // custom-mapped type as an optional in your object model.
   @Persisted var url: URL?
}

モデルでの型プロジェクションの使用

タイプ プロジェクション プロトコルの 1 つに準拠するタイプは、Swift SDK バージョン 10.10.0 で導入された@Persistedプロパティ宣言構文で使用できます。 @objc dynamic構文では機能しません。

プロジェクションされたタイプは、以下に使用できます。

• 最上位の型

• タイプの任意のバージョン

• コレクションの 型

FailableCustomPersistableをプロパティとして使用する場合は、任意のプロパティとして定義します。 任意の場合、 FailableCustomPersistableプロトコルは無効な値をnilにマッピングします。 必須 プロパティの場合は、強制的にラップ解除されます。 プロジェクションの型に変換できない値がある場合、そのプロパティを読み取るとラップされていない失敗の例外がスローされます。

class Club: Object {
    @Persisted var id: ObjectId
    @Persisted var name: String
    // Since we declared the URL as a FailableCustomPersistable,
    // it must be optional.
    @Persisted var url: URL?
    // Here, the `location` property maps to an embedded object.
    // We can declare the property as required.
    // If the underlying field contains nil, this becomes
    // a default-constructed instance of CLLocationCoordinate
    // with field values of `0`.
    @Persisted var location: CLLocationCoordinate2D
}
public class Location: EmbeddedObject {
    @Persisted var latitude: Double
    @Persisted var longitude: Double
}

モデルにプロジェクションされたタイプが含まれている場合は、永続化されたタイプを使用するか、プロジェクションされたタイプを使用して初期化されたオブジェクトのフィールド プロパティを割り当てることで、 値を持つオブジェクトを作成できます。

// Initialize objects and assign values
let club = Club(value: ["name": "American Kennel Club", "url": "https://akc.org"])
let club2 = Club()
club2.name = "Continental Kennel Club"
// When assigning the value to a type-projected property, type safety
// checks for the mapped type - not the persisted type.
club2.url = URL(string: "https://ckcusa.com/")!
club2.location = CLLocationCoordinate2D(latitude: 40.7509, longitude: 73.9777)

スキーマにおける型プロジェクション

型を型プロジェクション プロトコルに準拠していると宣言するときは、Realm に永続化する必要がある型を指定します。 たとえば、カスタムタイプURLを永続タイプStringにマッピングすると、 URLプロパティはスキーマにStringとして表示され、プロパティへの動的アクセスは string に操作されます。

スキーマは、マップされた型を直接表すものではありません。 プロパティを永続化された型からマッピングされた型に、またはその逆に変更する場合、移行は必要ありません。