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

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

Kotlin SDK は、次のKotlin型 、 BSON型、Realm 固有の型をサポートしており、一意の識別子、タイムスタンプ、カウンター、コレクションに使用できます。

Kotlin SDK は次のネイティブ サポートをサポートしていません。

• ユーザー定義の列挙プロパティ。 Realm オブジェクトで列挙を使用する方法の詳細については、「列挙 」セクションを参照してください。

• Kotlin の組み込み DateまたはInstant 。 Realm オブジェクトでタイムスタンプを使用する方法の詳細については、「 Realmインスタンス 」セクションを参照してください。

Realm オブジェクトのプロパティは、宣言時に可変で初期化されている必要があります。 Kotlin SDK は現在、抽象プロパティをサポートしていません。 組み込みの? Kotlin 演算子を使用して、プロパティは任意（nullable）であるか、プロパティが宣言するときにプロパティにデフォルト値を割り当てることができます。

Kotlin データ型

次の表は、サポートされている Kotlin データ型と、オブジェクトモデルでそれらを必須またはオプションのプロパティとして宣言する方法の例を示しています。

var stringReq: String = ""

var stringOpt: String? = null

var byteReq: Byte = 0

var byteOpt: Byte? = null

var shortReq: Short = 0

var shortOpt: Short? = null

var intReq: Int = 0

var intOpt: Int? = null

var longReq: Long = 0L

var longOpt: Long? = null

var floatReq: Float = 0.0f

var floatOpt: Float? = null

var doubleReq: Double = 0.0

var doubleOpt: Double? = null

var boolReq: Boolean = false

var boolOpt: Boolean? = null

var charReq: Char = 'a'

var charOpt: Char? = null

MongoDB BSON types

次の表は、サポートされているMongoDB BSONデータ型と、オブジェクトモデルでそれらを必須またはオプション プロパティとして宣言する方法の例を示しています。これらのタイプを使用するには、 org.mongodb.kbson パッケージからインポートする必要があります。

var objectIdReq: ObjectId = ObjectId()

var objectIdOpt: ObjectId? = null

var decimal128Req: Decimal128 = Decimal128("123.456")

var decimal128Opt: Decimal128? = null

Realm 固有のタイプ

次の表は、サポートされている Realm 固有のデータ型と、オブジェクトモデルでそれらを必須またはオプションのプロパティとして宣言する方法の例を示しています。

var uuidReq: RealmUUID = RealmUUID.random()

var uuidOpt: RealmUUID? = null

var realmInstantReq: RealmInstant = RealmInstant.now()

var realmInstantOpt: RealmInstant? = null

var realmAnyOpt: RealmAny? = RealmAny.create("foo")

var mutableRealmIntReq: MutableRealmInt = MutableRealmInt.create(0)

var mutableRealmIntOpt: MutableRealmInt? = null

var listReq: RealmList<CustomObjectType> = realmListOf()

var setReq: RealmSet<String> = realmSetOf()

var dictionaryReq: RealmDictionary<String> = realmDictionaryOf()

var realmObjectPropertyOpt: CustomObjectType? = null

var embeddedProperty: EmbeddedObjectType? = null

Unique Identifiers

Kotlin SDK は、 ObjectIdRealmオブジェクトの一意の識別子として UUID と をサポートしています。

val uuid1 = RealmUUID.from("46423f1b-ce3e-4a7e-812f-004cf9c42d76")
val uuid2 = RealmUUID.random()

MutableRealmInt（counter）

Kotlin SDK は、複数の分散クライアント間で数値の変更を正確に同期するための論理カウンターとして使用できる特殊な整数型として MutableRealmInt を提供します。Longincrement動作はdecrement と似ていますが、 競合のない複製データ型を実装する メソッドと メソッドもサポートしています。これにより、同じ値に変換する順序に関係なく、数値更新を実行できるようになります。

MutableRealmIntプロパティ:

• は プライマリキー として使用 できません

• は null 値を保存できませんが、null 可能であると宣言できます（ MutableRealmInt? ）

さらに、 MutableRealmIntフィールドは次の操作を行います。

• は Kotlin の数値型によってサポートされているため、数値フィールドを MutableRealmInt に変更するときに移行は必要ありません。

• は、 Longが提供するものと同様の演算子とインデックス関数を使用できます。 ただし、 set 、 increment 、 decrement以外の操作では、操作が実行されるインスタンスがミューテーションされないことに注意してください。 代わりに、更新された 値を持つ新しい非マネージドMutableRealmIntインスタンスを作成します。

MutableRealmInt（counter）プロパティの作成方法と MutableRealmInt（counter）プロパティを更新する方法を学びます。

Realmインスタンス（タイムスタンプ）

Kotlin の組み込みDateまたはInstant型は Realm では保存できません。

代わりに、 Kotlin SDK はRealmインスタンス 型を使用して時間情報を UNIXエポック タイムスタンプ として保存します。

RealmInstant以外の形式のタイムスタンプ データが必要な場合は、次の例に基づいてモデル クラスに変換コードを追加できます。

// model class that stores an Instant (kotlinx-datetime) field as a RealmInstant via a conversion
class RealmInstantConversion : RealmObject {
    private var _timestamp: RealmInstant = RealmInstant.from(0, 0)
    public var timestamp: Instant
        get() {
            return _timestamp.toInstant()
        }
        set(value) {
            _timestamp = value.toRealmInstant()
        }
}
fun RealmInstant.toInstant(): Instant {
    val sec: Long = this.epochSeconds
    // The value always lies in the range `-999_999_999..999_999_999`.
    // minus for timestamps before epoch, positive for after
    val nano: Int = this.nanosecondsOfSecond
    return if (sec >= 0) { // For positive timestamps, conversion can happen directly
        Instant.fromEpochSeconds(sec, nano.toLong())
    } else {
        // For negative timestamps, RealmInstant starts from the higher value with negative
        // nanoseconds, while Instant starts from the lower value with positive nanoseconds
        // TODO This probably breaks at edge cases like MIN/MAX
        Instant.fromEpochSeconds(sec - 1, 1_000_000 + nano.toLong())
    }
}
fun Instant.toRealmInstant(): RealmInstant {
    val sec: Long = this.epochSeconds
    // The value is always positive and lies in the range `0..999_999_999`.
    val nano: Int = this.nanosecondsOfSecond
    return if (sec >= 0) { // For positive timestamps, conversion can happen directly
        RealmInstant.from(sec, nano)
    } else {
        // For negative timestamps, RealmInstant starts from the higher value with negative
        // nanoseconds, while Instant starts from the lower value with positive nanoseconds
        // TODO This probably breaks at edge cases like MIN/MAX
        RealmInstant.from(sec + 1, -1_000_000 + nano)
    }
}

RealmAny（混合）

RealmAnyは null 以外の混合データ型を表します。 値の型と同様に動作します。 RealmAnyは以下を保持できます。

• サポートされている Kotlin データ型（ Byte 、 Char 、 Int 、 Long 、 Shortの値は内部的にint64_t値に変換されることに注意してください）

• サポートされている BSON types

• RealmList 混合データの とRealmDictionaryコレクション

• 次の Realm 固有のタイプ。

  • Realmインスタンス

  • RealmUUID

  • RealmObject （オブジェクトのコピーではなく、オブジェクトへの参照を保持）

RealmAny は、 EmbeddedRealmObject型、 RealmSet 、または別のRealmAnyを保持できません。

RealmAny properties

• インデックス は可能ですが、 プライマリキー としては使用 できません

• は null 可能（ RealmAny? ）である必要がありますが、null 値は保存できません

• は RealmQuery.max で 集計 できます 、RealmQuery.min 、およびRealmQuery.sum

• はソートできます 。 最高から最低の順にソートします。

  1. Boolean

  2. Byte, Double, Decimal128, Int, Float, Long, Short

  3. byte[], String

  4. Date

  5. ObjectId

  6. UUID

  7. RealmObject

複数のRealmAnyインスタンスをRealmList 、 RealmDictionary 、またはRealmSetフィールドに保存できます。

コレクションのタイプ

Kotlin SDK は、データモデルのプロパティとして使用できるいくつかのコレクション タイプを提供します。 コレクションは、サポートされている 1 つのデータ型の 0 個以上のインスタンスを含むオブジェクトです。 Realm コレクションは同種（コレクション内のすべてのオブジェクトは同じタイプ）であり、対応する組み込み Kotlin クラスによってサポートされています。

コレクション タイプは null 以外です。 コレクション プロパティを定義するときは、それを初期化する必要があります。 詳細については、「 コレクションの作成 」を参照してください。

プロパティとしての RealmObjects

オブジェクトモデルのプロパティとして、 RealmObjectと任意のサブクラスを使用できます（ AsymmetricRealmObjectを除く）。

地理空間タイプ

Kotlin SDK は、次のデータ型を使用する地理空間クエリをサポートしています。

• 地理的ポイント

• Geo循環

• GeoBox

• GeoPolygon

地理空間データを使用したクエリの詳細については、「 地理空間データ 」を参照してください。

Enums

Kotlin SDK は列挙型、または 列挙型をネイティブでサポートしていません。 Realm オブジェクト クラスで列挙型を使用するには、列挙型の基になるデータ型と一致する型のフィールドを定義します。

次に、基礎となる値と列挙型の間でフィールド値を変換するフィールドのゲッターとセッターを作成します。

enum class EnumClass(var state: String) {
    NOT_STARTED("NOT_STARTED"),
    IN_PROGRESS("IN_PROGRESS"),
    COMPLETE("COMPLETE")
}
class EnumObject : RealmObject {
    var name: String? = null
    private var state: String = EnumClass.NOT_STARTED.state
    var stateEnum: EnumClass
        get() = EnumClass.valueOf(state)
        set(value) {
            state = value.state
        }
}