同期された Realm へのデータの書き込み - Swift SDK

App Services の構成

Device Sync は、次のクエリ可能なフィールドで構成されています。

• _id （常に含まれる）

• complexity

• ownerId

App Services App には、ユーザーが自分のデータのみを読み書きできるように構成された権限があります。

{
  "name": "owner-read-write",
  "apply_when": {},
  "document_filters": {
    "read": { "ownerId": "%%user.id" },
    "write": { "ownerId": "%%user.id" }
  },
  "read": true,
  "write": true
}

クライアント データモデルと構成

このページの例では、次のオブジェクトモデルを使用します。

class Item: Object {
    @Persisted(primaryKey: true) var _id: ObjectId
    @Persisted var ownerId: String
    @Persisted var itemName: String
    @Persisted var complexity: Int
}

そのオブジェクトモデルを使用すると、同期された Realm 構成は、 complexityプロパティの値が4以下のサブスクライブ クエリに一致するオブジェクトを同期します。

let app = App(id: YOUR_APP_ID_HERE)
do {
    let user = try await app.login(credentials: Credentials.anonymous)
    do {
        var flexSyncConfig = user.flexibleSyncConfiguration()
        flexSyncConfig.objectTypes = [Item.self]
        let realm = try await Realm(configuration: flexSyncConfig)
        let subscriptions = realm.subscriptions
        try await subscriptions.update {
            subscriptions.append(
                QuerySubscription<Item>(name: "simple-items") {
                 $0.complexity <= 4
            })
        }
        print("Successfully opened realm: \(realm)")
    } catch {
        print("Failed to open realm: \(error.localizedDescription)")
        // handle error
    }
} catch {
    fatalError("Login failed: \(error.localizedDescription)")
}

どのデータ同期

サブスクライブ クエリと権限を組み合わせた場合、同期された Realm は次のオブジェクトのみを同期します。

• ownerIdはログインユーザーのuser.idと一致します（ 権限による）

• complexityプロパティの値は4 （サブスクライブ クエリ）以下です

ownerIdがログインユーザーのuser.idと一致しない場合、またはcomplexityプロパティの値が4より大きい Atlas コレクション内のオブジェクトは、この Realm に同期できません。

成功した書込み

書き込みがクライアント内の権限とFlexible Sync サブスクライブ クエリの両方に一致する場合、Realm Swift SDK は同期された Realm にオブジェクトを正常に書込むことができます。 このオブジェクトは、デバイスがネットワークに接続している場合に App Services バックエンドと同期します。

// This write falls within the subscription query and complies
// with the Device Sync permissions, so this write should succeed.
do {
    let learnRealm = Item()
    learnRealm.ownerId = user.id
    learnRealm.itemName = "Learn Realm CRUD stuff"
    learnRealm.complexity = 3
    try realm.write {
        realm.add(learnRealm)
    }
} catch {
    print("Failed to write to realm: \(error.localizedDescription)")
}

書込みの考慮

最初は成功したように見えた書込みが、実際には不正な書込みである場合もあります。 このような場合、オブジェクトはデータベースに書込み (write) を行いますが、データベースがバックエンドに同期すると、Realm は修復書込み (write) と呼ばれる致命的でないエラー操作で書込みを元に戻します。 次の場合、書込み保証 (write) が発生する可能性があります。

• 書き込みが クエリ サブスクリプションと一致しません: 書き込まれたオブジェクトはユーザーの権限と一致しますが、クエリ サブスクリプションには一致しません。

• 書込み (write)は権限と一致しません: 書込まれたオブジェクトはクエリ サブスクリプションと一致しますが、ユーザーの権限と一致しません。

詳しくは、クエリ サブスクリプションの範囲外のデータ、またはユーザーの権限と一致しないデータを書き込むと、次の状況が発生します。

1. クライアント Realm には「不正」書込みの概念が存在しないため、書込みは最初は Realm が App Services バックエンドで変更セットを解決するまで成功します。

2. 同期時に、サーバーはルールと権限を適用します。 サーバーは、ユーザーには書込み (write) を実行する権限がないと判断します。

3. サーバーは、「書き込み補正」と呼ばれる元に戻す操作をクライアントに送信します。

4. クライアントの Realm は不正な書込み (write) 操作を元に戻します。

特定のオブジェクトへの不正な書込み (write) と、それに対応する書込み (write) の間にあるクライアント側の書込み (write) は、いずれもなくなります。

実際には、オブジェクトが Realm に書き込まれ、サーバーがクライアントに補完書込み (write) を送信した後に消えます。

権限拒否エラー、書込み (write) エラー、およびその他の Device Sync エラーのタイプの詳細については、App Services ドキュメントの「同期エラー 」を参照してください。

App Services ログには、 の書き込みエラーが発生する理由に関する詳細情報が記載されています。

myApp.syncManager.errorHandler = { syncError, session in
    if let thisError = syncError as? SyncError {
        switch thisError.code {
        // ... additional SyncError.code cases ...
        case .writeRejected:
            if let compensatingWriteErrorInfo = thisError.compensatingWriteInfo {
                for anError in compensatingWriteErrorInfo {
                    print("A write was rejected with a compensating write error")
                    print("The write to object type: \(anError.objectType)")
                    print("With primary key of: \(anError.primaryKey)")
                    print("Was rejected because: \(anError.reason)")
                }
            }
        }
    }
}

A write was rejected with a compensating write error
The write to object type: Optional("Item")
With primary key of: objectId(641382026852d9220b2e2bbf)
Was rejected because: Optional("write to \"641382026852d9220b2e2bbf\" in table \"Item\" not
allowed; object is outside of the current query view")

do {
    let fixTheBug = Item()
    fixTheBug.ownerId = user.id
    fixTheBug.itemName = "Fix the bug with the failing method"
    // The complexity of this item is `7`. This is outside the bounds
    // of the subscription query, so this write triggers a compensating write.
    fixTheBug.complexity = 7
    try realm.write {
        realm.add(fixTheBug)
    }
} catch {
    print("Failed to write to realm: \(error.localizedDescription)")
}

Sync: Connection[1]: Session[1]: Received: ERROR "Client attempted a
write that is outside of permissions or query filters; it has been
reverted" (error_code=231, try_again=true, error_action=Warning)

"FlexibleSync_Item": {
    "63bdfc40f16be7b1e8c7e4b7": "write to \"63bdfc40f16be7b1e8c7e4b7\"
    in table \"FlexibleSync_Item\" not allowed; object is outside of
    the current query view"
}

do {
    let itemWithWrongOwner = Item()
    // The `ownerId` of this item does not match the `user.id` of the logged-in
    // user. The user does not have permissions to make this write, so
    // it triggers a compensating write.
    itemWithWrongOwner.ownerId = "This string does not match the user.id"
    itemWithWrongOwner.itemName = "Write code that generates a permission error"
    itemWithWrongOwner.complexity = 1
    try realm.write {
        realm.add(itemWithWrongOwner)
    }
} catch {
    print("Failed to write to realm: \(error.localizedDescription)")
}

Sync: Connection[1]: Session[1]: Received: ERROR "Client attempted a
write that is outside of permissions or query filters; it has been
reverted" (error_code=231, try_again=true, error_action=Warning)

"FlexibleSync_Item": {
    "63bdfc40f16be7b1e8c7e4b8": "write to \"63bdfc40f16be7b1e8c7e4b8\"
    in table \"FlexibleSync_Item\" was denied by write filter in role
    \"owner-read-write\""
}

複数のプロセスで同期された Realm の起動に関連するクラッシュ

共有拡張機能 またはその他のアプリ拡張機能で同期された Realm を開こうとすると、その Realm がメイン アプリで開かれていない場合、共有拡張機能からの書込み (write) が成功する可能性があります。 ただし、同期された Realm がメインアプリですでに開いている場合、またはバックグラウンドでデータを同期している場合は、 Realm::MultiSyncAgentsに関連するクラッシュが発生する可能性があります。 このシナリオでは、デバイスを再起動する必要がある場合があります。

アプリ 拡張機能で同期された Realm への書き込みの代替手段

アプリ拡張機能から同期された Realm からの読み取りまたは書き込みが必要な場合は、推奨される代替手段がいくつかあります。

• オフライン ファースト: ディスク上のデータをメイン アプリとの間で渡す

• 常に最新の状態: ネットワーク接続を介してバッキング Atlas コレクションと直接通信します