View a markdown version of this page

DeleteItem - AWS AppSync GraphQL
DeleteItem bidangContoh 1Contoh 2

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

DeleteItem

Dokumen pemetaan DeleteItem permintaan memungkinkan Anda memberi tahu resolver AWS AppSync DynamoDB untuk membuat DeleteItem permintaan ke DynamoDB, dan memungkinkan Anda untuk menentukan yang berikut:

  • Kunci item di DynamoDB

  • Kondisi agar operasi berhasil

Dok DeleteItem umen pemetaan memiliki struktur sebagai berikut:

{
    "version" : "2018-05-29",
    "operation" : "DeleteItem",
    "customPartitionKey" : "foo",
    "populateIndexFields" : boolean value,
    "key": {
        "foo" : ... typed value,
        "bar" : ... typed value
    },
    "condition" : {
        ...
    },
    "_version" : 1
}

Bidang didefinisikan sebagai berikut:

DeleteItem bidang

version

Versi definisi template. 2017-02-28dan 2018-05-29 saat ini didukung. Nilai ini diperlukan.

operation

Operasi DynamoDB untuk melakukan. Untuk melakukan operasi DeleteItem DynamoDB, ini harus disetel ke. DeleteItem Nilai ini diperlukan.

key

Kunci item di DynamoDB. Item DynamoDB mungkin memiliki kunci hash tunggal, atau kunci hash dan kunci pengurutan, tergantung pada struktur tabel. Untuk informasi selengkapnya tentang menentukan “nilai yang diketik”, lihat Sistem tipe (pemetaan permintaan). Nilai ini diperlukan.

condition

Kondisi untuk menentukan apakah permintaan harus berhasil atau tidak, berdasarkan status objek yang sudah ada di DynamoDB. Jika tidak ada kondisi yang ditentukan, DeleteItem permintaan akan menghapus item terlepas dari statusnya saat ini. Untuk informasi selengkapnya tentang kondisi, lihat Ek spresi kondisi. Nilai ini bersifat opsional.

_version

Nilai numerik yang mewakili versi terbaru dari item yang diketahui. Nilai ini bersifat opsional. Bidang ini digunakan untuk Det eksi Konf lik dan hanya didukung pada sumber data berversi.

customPartitionKey

Saat diaktifkan, nilai string ini mengubah format ds_sk dan ds_pk catatan yang digunakan oleh tabel sinkronisasi delta saat pembuatan versi telah diaktifkan (untuk informasi selengkapnya, lihat Deteksi dan sinkronisasi konflik di Panduan Peng AWS AppSync embang). Saat diaktifkan, pemrosesan populateIndexFields entri juga diaktifkan. Ini adalah bidang opsional.

populateIndexFields

Nilai boolean yang, ketika diaktifkan bersama dengan customPartitionKey, membuat entri baru untuk setiap catatan dalam tabel sinkronisasi delta, khususnya di kolom gsi_ds_pk dangsi_ds_sk. Untuk informasi selengkapnya, lihat Deteksi dan sinkronisasi konflik di Panduan AWS AppSync Pengembang. Ini adalah bidang opsional.

Item yang dihapus dari DynamoDB secara otomatis diubah menjadi tipe primitif GraphQL dan JSON dan tersedia dalam konteks pemetaan (). $context.result

Untuk informasi selengkapnya tentang konversi tipe DynamoDB, lihat Sistem tipe (pemetaan respons).

Untuk informasi selengkapnya tentang templat pemetaan respons, lihat ikhtisar templ at pemetaan Resolver.

Contoh 1

Contoh berikut adalah template pemetaan untuk mut deleteItem(id: ID!) asi GraphQL. Jika ada item dengan ID ini, item tersebut akan dihapus.

{
    "version" : "2017-02-28",
    "operation" : "DeleteItem",
    "key" : {
        "id" : $util.dynamodb.toDynamoDBJson($ctx.args.id)
    }
}

Contoh 2

Contoh berikut adalah template pemetaan untuk mut deleteItem(id: ID!, expectedVersion: Int!) asi GraphQL. Jika ada item dengan ID ini, item akan dihapus, tetapi hanya jika version bidangnya disetel keexpectedVersion:

{
    "version" : "2017-02-28",
    "operation" : "DeleteItem",
    "key" : {
        "id" : $util.dynamodb.toDynamoDBJson($ctx.args.id)
    },
    "condition" : {
        "expression"       : "attribute_not_exists(id) OR version = :expectedVersion",
        "expressionValues" : {
            ":expectedVersion" : $util.dynamodb.toDynamoDBJson($expectedVersion)
        }
    }
}

Untuk informasi selengkapnya tentang DynamoDB DeleteItem API, lihat dokumentasi DynamoDB API.