Perubahan dalam APIs pemetaan/dokumen DynamoDB dari versi 1 ke versi 2 - AWS SDK for Java 2.x

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

Perubahan dalam APIs pemetaan/dokumen DynamoDB dari versi 1 ke versi 2

Topik ini merinci perubahan tingkat tinggi SDK Java APIs untuk Amazon DynamoDB dari versi 1.x (v1) ke (v2). AWS SDK for Java 2.x Kami pertama-tama membahas object-to-table pemetaan API dan kemudian mendiskusikan dokumen API untuk bekerja dengan dokumen JSON -style.

Perubahan tingkat tinggi

Nama-nama klien pemetaan di setiap pustaka berbeda di v1 dan v2:

  • v1 - D ynamoDBMapper

  • v2 - Klien yang Ditingkatkan DynamoDB

Anda berinteraksi dengan dua pustaka dengan cara yang hampir sama: Anda membuat instance mapper/klien dan kemudian menyediakan Java POJO untuk membaca dan menulis item ini ke tabel APIs DynamoDB. Kedua pustaka juga menawarkan anotasi untuk kelas POJO untuk mengarahkan bagaimana klien menangani. POJO

Perbedaan penting saat Anda pindah ke v2 meliputi:

  • V2 dan v1 menggunakan nama metode yang berbeda untuk operasi DynamoDB tingkat rendah. Sebagai contoh:

    v1 v2
    muat getItem
    save putItem
    batchLoad batchGetItem
  • V2 menawarkan beberapa cara untuk menentukan skema tabel dan memetakan POJOs ke tabel. Anda dapat memilih dari penggunaan anotasi atau skema yang dihasilkan dari kode menggunakan pembangun. V2 juga menawarkan versi skema yang dapat berubah dan tidak dapat diubah.

  • Dengan v2, Anda secara khusus membuat skema tabel sebagai salah satu langkah pertama, sedangkan di v1, skema tabel disimpulkan dari kelas beranotasi sesuai kebutuhan.

  • V2 mencakup APIklien Dokumen di klien yang disempurnakanAPI, sedangkan v1 menggunakan terpisah API.

  • Semua APIs tersedia dalam versi sinkron dan asinkron di v2.

Lihat bagian pemetaan DynamoDB dalam panduan ini untuk informasi lebih rinci tentang klien yang disempurnakan v2.

Impor dependensi

v1 v2
<dependencyManagement> <dependencies> <dependency> <groupId>com.amazonaws</groupId> <artifactId>aws-java-sdk-bom</artifactId> <version>1.X.X</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>com.amazonaws</groupId> <artifactId>aws-java-sdk-dynamodb</artifactId> </dependency> </dependencies>
<dependencyManagement> <dependencies> <dependency> <groupId>software.amazon.awssdk</groupId> <artifactId>bom</artifactId> <version>2.X.X*</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>software.amazon.awssdk</groupId> <artifactId>dynamodb-enhanced</artifactId> </dependency> </dependencies>

* Versi terbaru.

Di v1, dependensi tunggal mencakup DynamoDB tingkat rendah dan pemetaan/dokumen, sedangkan di v2, Anda menggunakan ketergantungan API API artefak untuk mengakses pemetaan/dokumen. dynamodb-enhanced API dynamodb-enhancedModul ini berisi ketergantungan transitif pada modul tingkat rendahdynamodb.

APIperubahan

Buat klien

Kasus penggunaan v1 v2

Instantiasi normal

AmazonDynamoDB standardClient = AmazonDynamoDBClientBuilder.standard() .withCredentials(credentialsProvider) .withRegion(Regions.US_EAST_1) .build(); DynamoDBMapper mapper = new DynamoDBMapper(standardClient);
DynamoDbClient standardClient = DynamoDbClient.builder() .credentialsProvider(ProfileCredentialsProvider.create()) .region(Region.US_EAST_1) .build(); DynamoDbEnhancedClient enhancedClient = DynamoDbEnhancedClient.builder() .dynamoDbClient(standardClient) .build();

Instantiasi minimal

AmazonDynamoDB standardClient = AmazonDynamoDBClientBuilder.standard(); DynamoDBMapper mapper = new DynamoDBMapper(standardClient);
DynamoDbEnhancedClient enhancedClient = DynamoDbEnhancedClient.create();

Dengan trafo atribut*

DynamoDBMapper mapper = new DynamoDBMapper(standardClient, attributeTransformerInstance);
DynamoDbEnhancedClient enhancedClient = DynamoDbEnhancedClient.builder() .dynamoDbClient(standardClient) .extensions(extensionAInstance, extensionBInstance) .build();

* Ekstensi di v2 kira-kira sesuai dengan atribut transformer di v1. Gunakan ekstensiBagian ini berisi informasi lebih lanjut tentang ekstensi di v2.

Menetapkan pemetaan ke tabel/indeks DynamoDB

Di v1, Anda menentukan nama tabel DynamoDB melalui anotasi kacang. Dalam v2, metode pabrik,table(), menghasilkan instance DynamoDbTable yang mewakili tabel DynamoDB jarak jauh. Parameter pertama dari table() metode ini adalah nama tabel DynamoDB.

Kasus penggunaan v1 v2

Memetakan POJO kelas Java ke tabel DynamoDB

@DynamoDBTable(tableName ="Customer") public class Customer { ... }
DynamoDbTable<Customer> customerTable = enhancedClient.table("Customer", TableSchema.fromBean(Customer.class));

Peta ke indeks sekunder DynamoDB

  1. Tentukan POJO kelas yang mewakili indeks.

    • Anotasi kelas dengan @DynamoDBTable menyediakan nama tabel yang memiliki indeks.

    • Anotasi properti dengan @DynamoDBIndexHashKey dan opsional. @DynamoDBIndexRangeKey

  2. Buat ekspresi kueri.

  3. Query menggunakan referensi ke POJO kelas yang mewakili indeks. Sebagai contoh

    mapper.query(IdEmailIndex.class, queryExpression)

    IdEmailIndexdimana kelas pemetaan untuk indeks.

Bagian dalam DynamoDB Developer Guide yang membahas metode query v1 menunjukkan contoh lengkap.

  1. Anotasi atribut POJO kelas dengan @DynamoDbSecondaryPartitionKey (untuk a GSI) dan @DynamoDbSecondarySortKey (untuk dan GSI atau LSI). Misalnya,

    @DynamoDbSecondarySortKey(indexNames = "IdEmailIndex") public String getEmail() { return this.email; }
  2. Ambil referensi ke indeks. Misalnya,

    DynamoDbIndex<Customer> customerIndex = customerTable.index("IdEmailIndex");
  3. Kueri indeks.

Gunakan indeks sekunderBagian dalam panduan ini memberikan informasi lebih lanjut.

Operasi tabel

Bagian ini menjelaskan operasi APIs yang berbeda antara v1 dan v2 untuk sebagian besar kasus penggunaan standar.

Di v2, semua operasi yang melibatkan satu tabel dipanggil pada DynamoDbTable instance, bukan pada klien yang disempurnakan. Klien yang disempurnakan berisi metode yang dapat menargetkan beberapa tabel.

Dalam tabel bernama operasi Tabel di bawah ini, sebuah POJO contoh disebut sebagai item atau sebagai jenis tertentu seperticustomer1. Untuk contoh v2 instance bernama, table adalah hasil dari pemanggilan sebelumnya enhancedClient.table() yang mengembalikan referensi ke DynamoDbTable instance.

Perhatikan bahwa sebagian besar operasi v2 dapat dipanggil dengan pola konsumen yang lancar bahkan ketika tidak ditampilkan. Misalnya,

Customer customer = table.getItem(r → r.key(key)); or Customer customer = table.getItem(r → r.key(k -> k.partitionValue("id").sortValue("email")))

Untuk operasi v1, tabel berisi beberapa formulir yang umum digunakan dan tidak semua formulir yang kelebihan beban. Misalnya, load() metode ini memiliki kelebihan beban berikut:

mapper.load(Customer.class, hashKey) mapper.load(Customer.class, hashKey, rangeKey) mapper.load(Customer.class, hashKey, config) mapper.load(Customer.class, hashKey, rangeKey, config) mapper.load(item) mapper.load(item, config)

Tabel menunjukkan bentuk yang umum digunakan:

mapper.load(item) mapper.load(item, config)
Operasi tabel
Kasus penggunaan v1 Operasi DynamoDB v2

Menulis Java POJO ke tabel DynamoDB

mapper.save(item) mapper.save(item, config) mapper.save(item, saveExpression, config)

Dalam v1, DynamoDBMapperConfig.SaveBehavior dan anotasi menentukan metode DynamoDB tingkat rendah mana yang akan dipanggil. Secara umum, UpdateItem disebut kecuali saat menggunakan SaveBehavior.CLOBBER danSaveBehavior.PUT. Kunci yang dihasilkan secara otomatis adalah kasus penggunaan khusus, dan kadang-kadang keduanya PutItem dan UpdateItem digunakan.

PutItem, UpdateItem
table.putItem(putItemRequest) table.putItem(item) table.putItemWithResponse(item) //Returns metadata. updateItem(updateItemRequest) table.updateItem(item) table.updateItemWithResponse(item) //Returns metadata.
Membaca item dari tabel DynamoDB ke Java POJO
mapper.load(item) mapper.load(item, config)
GetItem
table.getItem(getItemRequest) table.getItem(item) table.getItem(key) table.getItemWithResponse(key) //Returns POJO with metadata.
Menghapus item dari tabel DynamoDB
mapper.delete(item, deleteExpression, config)
DeleteItem
table.deleteItem(deleteItemRequest) table.deleteItem(item) table.deleteItem(key)
Kueri tabel DynamoDB atau indeks sekunder dan kembalikan daftar paginasi
mapper.query(Customer.class, queryExpression) mapper.query(Customer.class, queryExpression, mapperConfig)
Query
table.query(queryRequest) table.query(queryConditional)

Gunakan yang dikembalikan PageIterable.stream() (pemuatan lambat) untuk respons sinkronisasi dan PagePublisher.subscribe() untuk respons asinkron

Kueri tabel DynamoDB atau indeks sekunder dan kembalikan daftar
mapper.queryPage(Customer.class, queryExpression) mapper.queryPage(Customer.class, queryExpression, mapperConfig)
Query
table.query(queryRequest) table.query(queryConditional)

Gunakan yang dikembalikan PageIterable.items() (pemuatan lambat) untuk respons sinkronisasi dan PagePublisher.items.subscribe() untuk respons asinkron

Memindai tabel DynamoDB atau indeks sekunder dan mengembalikan daftar paginasi
mapper.scan(Customer.class, scanExpression) mapper.scan(Customer.class, scanExpression, mapperConfig)
Scan
table.scan() table.scan(scanRequest)

Gunakan yang dikembalikan PageIterable.stream() (pemuatan lambat) untuk respons sinkronisasi dan PagePublisher.subscribe() untuk respons asinkron

Pindai tabel DynamoDB atau indeks sekunder dan kembalikan daftar
mapper.scanPage(Customer.class, scanExpression) mapper.scanPage(Customer.class, scanExpression, mapperConfig)
Scan
table.scan() table.scan(scanRequest)

Gunakan yang dikembalikan PageIterable.items() (pemuatan lambat) untuk respons sinkronisasi dan PagePublisher.items.subscribe() untuk respons asinkron

Baca beberapa item dari beberapa tabel dalam satu batch
mapper.batchLoad(Arrays.asList(customer1, customer2, book1)) mapper.batchLoad(itemsToGet) // itemsToGet: Map<Class<?>, List<KeyPair>>
BatchGetItem
enhancedClient.batchGetItem(batchGetItemRequest) enhancedClient.batchGetItem(r -> r.readBatches( ReadBatch.builder(Record1.class) .mappedTableResource(mappedTable1) .addGetItem(i -> i.key(k -> k.partitionValue(0))) .build(), ReadBatch.builder(Record2.class) .mappedTableResource(mappedTable2) .addGetItem(i -> i.key(k -> k.partitionValue(0))) .build())) // Iterate over pages with lazy loading or over all items from the same table.
Tulis beberapa item ke beberapa tabel dalam satu batch
mapper.batchSave(Arrays.asList(customer1, customer2, book1))
BatchWriteItem
enhancedClient.batchWriteItem(batchWriteItemRequest) enhancedClient.batchWriteItem(r -> r.writeBatches( WriteBatch.builder(Record1.class) .mappedTableResource(mappedTable1) .addPutItem(item1) .build(), WriteBatch.builder(Record2.class) .mappedTableResource(mappedTable2) .addPutItem(item2) .build()))
Hapus beberapa item dari beberapa tabel dalam satu batch
mapper.batchDelete(Arrays.asList(customer1, customer2, book1))
BatchWriteItem
enhancedClient.batchWriteItem(r -> r.writeBatches( WriteBatch.builder(Record1.class) .mappedTableResource(mappedTable1) .addDeleteItem(item1key) .build(), WriteBatch.builder(Record2.class) .mappedTableResource(mappedTable2) .addDeleteItem(item2key) .build()))
Tulis/hapus beberapa item dalam satu batch
mapper.batchWrite(Arrays.asList(customer1, book1), Arrays.asList(customer2))
BatchWriteItem
enhancedClient.batchWriteItem(r -> r.writeBatches( WriteBatch.builder(Record1.class) .mappedTableResource(mappedTable1) .addPutItem(item1) .build(), WriteBatch.builder(Record2.class) .mappedTableResource(mappedTable2) .addDeleteItem(item2key) .build()))
Lakukan penulisan transaksional
mapper.transactionWrite(transactionWriteRequest)
TransactWriteItems
enhancedClient.transactWriteItems(transasctWriteItemsRequest)
Lakukan pembacaan transaksional
mapper.transactionLoad(transactionLoadRequest)
TransactGetItems
enhancedClient.transactGetItems(transactGetItemsRequest)
Dapatkan hitungan item yang cocok dari pemindaian atau kueri
mapper.count(Customer.class, queryExpression) mapper.count(Customer.class, scanExpression)
Query, Scan dengan Select.COUNT Tidak didukung
Buat tabel di DynamoDB sesuai dengan kelas POJO
mapper.generateCreateTableRequest(Customer.class)

Pernyataan sebelumnya menghasilkan permintaan tabel buat tingkat rendah; pengguna harus memanggil klien createTable DynamoDB.

CreateTable
table.createTable(createTableRequest) table.createTable(r -> r.provisionedThroughput(getDefaultProvisionedThroughput()) .globalSecondaryIndices( EnhancedGlobalSecondaryIndex.builder() .indexName("gsi_1") .projection(p -> p.projectionType(ProjectionType.ALL)) .provisionedThroughput(getDefaultProvisionedThroughput()) .build()));
Lakukan pemindaian paralel di DynamoDB
mapper.parallelScan(Customer.class, scanExpression, numTotalSegments)
Scandengan Segment dan TotalSegments parameter

Pengguna diminta untuk menangani thread pekerja dan memanggil scan untuk setiap segmen:

table.scan(r -> r.segment(0).totalSegments(5))
Integrasikan Amazon S3 dengan DynamoDB untuk menyimpan tautan S3 cerdas
mapper.createS3Link(bucket, key) mapper.getS3ClientCache()
-

Tidak didukung karena memasangkan Amazon S3 dan DynamoDB.

Kelas peta dan properti

Di v1 dan v2, Anda memetakan kelas ke tabel menggunakan anotasi gaya kacang. V2 juga menawarkan cara lain untuk mendefinisikan skema untuk kasus penggunaan tertentu, seperti bekerja dengan kelas yang tidak dapat diubah.

Anotasi kacang

Tabel berikut menunjukkan anotasi kacang setara untuk kasus penggunaan tertentu yang digunakan dalam v1 dan v2. Skenario Customer kelas digunakan untuk menggambarkan parameter.

Anotasi — serta kelas dan pencacahan — di v2 ikuti konvensi kasus unta dan gunakan '', bukan 'DynamoDB'. DynamoDb

Kasus penggunaan v1 v2
Petakan kelas ke tabel
@DynamoDBTable (tableName ="CustomerTable")
@DynamoDbBean @DynamoDbBean(converterProviders = {...})
Nama tabel didefinisikan saat memanggil DynamoDbEDnhancedClient#table() metode.
Menunjuk anggota kelas sebagai atribut tabel
@DynamoDBAttribute(attributeName = "customerName")
@DynamoDbAttribute("customerName")
Menunjuk anggota kelas adalah kunci hash/partisi
@DynamoDBHashKey
@DynamoDbPartitionKey
Menunjuk anggota kelas adalah kunci rentang/sortir
@DynamoDBHashKey
@DynamoDbSortKey
Menunjuk anggota kelas adalah kunci hash/partisi indeks sekunder
@DynamoDBIndexHashKey
@DynamoDbSecondaryPartitionKey
Menunjuk anggota kelas adalah kunci rentang/sortir indeks sekunder
@DynamoDBIndexRangeKey
@DynamoDbSecondarySortKey
Abaikan anggota kelas ini saat memetakan ke tabel
@DynamoDBIgnore
@DynamoDbIgnore
Tentukan anggota kelas sebagai atribut kunci yang dibuat secara otomatis UUID
@DynamoDBAutoGeneratedKey
@DynamoDbAutoGeneratedUuid

Ekstensi yang menyediakan ini tidak dimuat secara default; Anda harus menambahkan ekstensi ke pembuat klien.

Tentukan anggota kelas sebagai atribut timestamp yang dibuat secara otomatis
@DynamoDBAutoGeneratedTimestamp
@DynamoDbAutoGeneratedTimestampAttribute

Ekstensi yang menyediakan ini tidak dimuat secara default; Anda harus menambahkan ekstensi ke pembuat klien.

Menunjuk anggota kelas sebagai atribut versi auto-incremented
@DynamoDBVersionAttribute
@DynamoDbVersionAttribute

Ekstensi yang menyediakan ini dimuat secara otomatis.

Menunjuk anggota kelas sebagai membutuhkan konversi kustom
@DynamoDBTypeConverted
@DynamoDbConvertedBy
Menunjuk anggota kelas untuk disimpan sebagai jenis atribut yang berbeda
@DynamoDBTyped(<DynamoDBAttributeType>)
Tanpa padanan
Tentukan kelas yang dapat diserialisasikan ke dokumen DynamoDB (-style document) atau sub-dokumen JSON
@DynamoDBDocument
Tidak ada anotasi setara langsung. Gunakan dokumen yang disempurnakanAPI.

V2 anotasi tambahan

Kasus penggunaan v1 v2
Menunjuk anggota kelas untuk tidak disimpan sebagai NULL atribut jika nilai Java adalah null N/A
@DynamoDbIgnoreNulls
Menunjuk anggota kelas untuk menjadi objek kosong jika semua atribut adalah null N/A
@DynamoDbPreserveEmptyObject
Tentukan tindakan pembaruan khusus untuk anggota kelas N/A
@DynamoDbUpdateBehavior
Tentukan kelas yang tidak dapat diubah N/A
@DynamoDbImmutable
Menunjuk anggota kelas sebagai atribut counter auto-incremented N/A
@DynamoDbAtomicCounter

Ekstensi yang menyediakan fungsi ini dimuat secara otomatis.

Konfigurasi

Di v1, Anda biasanya mengontrol perilaku tertentu dengan menggunakan instance. DynamoDBMapperConfig Anda dapat menyediakan objek konfigurasi baik ketika Anda membuat mapper atau ketika Anda membuat permintaan. Di v2, konfigurasi khusus untuk objek permintaan untuk operasi.

Kasus penggunaan v1 Default di v1 v2
DynamoDBMapperConfig.builder()
Strategi coba lagi pemuatan batch
.withBatchLoadRetryStrategy(batchLoadRetryStrategy)
coba lagi item yang gagal
Batch menulis strategi coba lagi
.withBatchWriteRetryStrategy(batchWriteRetryStrategy)
coba lagi item yang gagal
Bacaan yang konsisten
.withConsistentReads(CONSISTENT)
EVENTUAL Secara default, pembacaan konsisten salah untuk operasi baca. Ganti dengan .consistentRead(true) objek permintaan.
Skema konversi dengan set marshallers/unmarshallers
.withConversionSchema(conversionSchema)

Implementasi statis memberikan kompatibilitas mundur dengan versi yang lebih lama.

V2_COMPATIBLE Tidak berlaku. Ini adalah fitur lama yang mengacu pada bagaimana versi awal DynamoDB (v1) menyimpan tipe data, dan perilaku ini tidak akan dipertahankan di klien yang disempurnakan. Contoh perilaku di DynamoDB v1 adalah menyimpan boolean sebagai Number, bukan sebagai Boolean.
Nama tabel
.withObjectTableNameResolver() .withTableNameOverride() .withTableNameResolver()

Implementasi statis memberikan kompatibilitas mundur dengan versi yang lebih lama

gunakan anotasi atau tebakan dari kelas

Nama tabel didefinisikan saat memanggil DynamoDbEDnhancedClient#table() metode.

Strategi beban pagination
.withPaginationLoadingStrategy(strategy)

Pilihannya adalah: LAZY _LOADING,EAGER_LOADING, atau ITERATION_ONLY

LAZY_LOADING

Iterasi saja adalah default. Opsi v1 lainnya tidak didukung.

Minta pengumpulan metrik
.withRequestMetricCollector(collector)
null Gunakan metricPublisher() ClientOverrideConfiguration saat membangun klien DynamoDB standar.
Simpan perilaku
.withSaveBehavior(SaveBehavior.CLOBBER)

Pilihannya adalah UPDATECLOBBER,,PUT,APPEND_SET, atauUPDATE_SKIP_NULL_ATTRIBUTES.

UPDATE

Di v2, Anda menelepon putItem() atau updateItem() secara eksplisit.

CLOBBER or PUT: Tindakan yang sesuai di v 2 memanggilputItem(). Tidak ada CLOBBER konfigurasi khusus.

UPDATE: Sesuai dengan updateItem()

UPDATE_SKIP_NULL_ATTRIBUTES: Sesuai denganupdateItem(). Kontrol perilaku pembaruan dengan setelan permintaan ignoreNulls dan anotasi/tagDynamoDbUpdateBehavior.

APPEND_SET: Tidak didukung

Jenis konverter pabrik
.withTypeConverterFactory(typeConverterFactory)
konverter tipe standar

Atur kacang dengan menggunakan

@DynamoDbBean(converterProviders = {ConverterProvider.class, DefaultAttributeConverterProvider.class})

Konfigurasi per operasi

Di v1, beberapa operasi, sepertiquery(), sangat dapat dikonfigurasi melalui objek “ekspresi” yang dikirimkan ke operasi. Sebagai contoh:

DynamoDBQueryExpression<Customer> emailBwQueryExpr = new DynamoDBQueryExpression<Customer>() .withRangeKeyCondition("Email", new Condition() .withComparisonOperator(ComparisonOperator.BEGINS_WITH) .withAttributeValueList( new AttributeValue().withS("my"))); mapper.query(Customer.class, emailBwQueryExpr);

Di v2, alih-alih menggunakan objek konfigurasi, Anda menetapkan parameter pada objek permintaan dengan menggunakan pembuat. Sebagai contoh:

QueryEnhancedRequest emailBw = QueryEnhancedRequest.builder() .queryConditional(QueryConditional .sortBeginsWith(kb -> kb .sortValue("my"))).build(); customerTable.query(emailBw);

Kondisional

Dalam v2, ekspresi kondisional dan penyaringan diekspresikan menggunakan Expression objek, yang merangkum kondisi dan pemetaan nama dan filter.

Kasus penggunaan Operasi v1 v2
Kondisi atribut yang diharapkan save (), delete (), query (), scan ()
new DynamoDBSaveExpression() .withExpected(Collections.singletonMap( "otherAttribute", new ExpectedAttributeValue(false))) .withConditionalOperator(ConditionalOperator.AND);
Usang; gunakan sebagai gantinya. ConditionExpression
Ekspresi kondisi hapus ()
deleteExpression.setConditionExpression("zipcode = :zipcode") deleteExpression.setExpressionAttributeValues(...)
Expression conditionExpression = Expression.builder() .expression("#key = :value OR #key1 = :value1") .putExpressionName("#key", "attribute") .putExpressionName("#key1", "attribute3") .putExpressionValue(":value", AttributeValues.stringValue("wrong")) .putExpressionValue(":value1", AttributeValues.stringValue("three")) .build(); DeleteItemEnhancedRequest request = DeleteItemEnhancedRequest.builder() .conditionExpression(conditionExpression).build();
Ekspresi filter query (), scan ()
scanExpression .withFilterExpression("#statename = :state") .withExpressionAttributeValues(attributeValueMapBuilder.build()) .withExpressionAttributeNames(attributeNameMapBuilder.build())
Map<String, AttributeValue> values = singletonMap(":key", stringValue("value")); Expression filterExpression = Expression.builder() .expression("name = :key") .expressionValues(values) .build(); QueryEnhancedRequest request = QueryEnhancedRequest.builder() .filterExpression(filterExpression).build();
Ekspresi kondisi untuk kueri kueri ()
queryExpression.withKeyConditionExpression()
QueryConditional keyEqual = QueryConditional.keyEqualTo(b -> b .partitionValue("movie01")); QueryEnhancedRequest tableQuery = QueryEnhancedRequest.builder() .queryConditional(keyEqual) .build();

Jenis konversi

Konverter default

Di v2, SDK menyediakan satu set konverter default untuk semua jenis umum. Anda dapat mengubah konverter tipe baik di tingkat penyedia keseluruhan maupun untuk satu atribut. Anda dapat menemukan daftar konverter yang tersedia di AttributeConverterAPIreferensi.

Menetapkan konverter kustom untuk atribut

Di v1, Anda dapat membuat anotasi metode pengambil dengan @DynamoDBTypeConverted untuk menentukan kelas yang mengkonversi antara tipe atribut Java dan tipe atribut DynamoDB. Misalnya, CurrencyFormatConverter yang mengkonversi antara Currency tipe Java dan DynamoDB String dapat diterapkan seperti yang ditunjukkan pada cuplikan berikut.

@DynamoDBTypeConverted(converter = CurrencyFormatConverter.class) public Currency getCurrency() { return currency; }

Setara v2 dari cuplikan sebelumnya ditunjukkan di bawah ini.

@DynamoDbConvertedBy(CurrencyFormatConverter.class) public Currency getCurrency() { return currency; }
catatan

Di v1, Anda dapat menerapkan anotasi ke atribut itu sendiri, tipe atau anotasi yang ditentukan pengguna, v2 mendukung penerapan anotasi hanya ke pengambil.

Tambahkan pabrik atau penyedia konverter tipe

Di v1, Anda dapat menyediakan set konverter tipe Anda sendiri, atau mengganti tipe yang Anda pedulikan dengan menambahkan pabrik konverter tipe ke konfigurasi. Pabrik konverter tipe meluasDynamoDBTypeConverterFactory, dan penggantian dilakukan dengan mendapatkan referensi ke set default dan memperluasnya. Cuplikan berikut menunjukkan cara melakukan ini.

DynamoDBTypeConverterFactory typeConverterFactory = DynamoDBTypeConverterFactory.standard().override() .with(String.class, CustomBoolean.class, new DynamoDBTypeConverter<String, CustomBoolean>() { @Override public String convert(CustomBoolean bool) { return String.valueOf(bool.getValue()); } @Override public CustomBoolean unconvert(String string) { return new CustomBoolean(Boolean.valueOf(string)); }}).build(); DynamoDBMapperConfig config = DynamoDBMapperConfig.builder() .withTypeConverterFactory(typeConverterFactory) .build(); DynamoDBMapper mapperWithTypeConverterFactory = new DynamoDBMapper(dynamo, config);

V2 menyediakan fungsionalitas serupa melalui @DynamoDbBean anotasi. Anda dapat memberikan satu AttributeConverterProvider atau satu rantai pesananAttributeConverterProvider. Perhatikan bahwa jika Anda menyediakan rantai penyedia konverter atribut Anda sendiri, Anda akan mengganti penyedia konverter default dan harus memasukkannya ke dalam rantai untuk menggunakan konverter atributnya.

@DynamoDbBean(converterProviders = { ConverterProvider1.class, ConverterProvider2.class, DefaultAttributeConverterProvider.class}) public class Customer { ... }

Bagian tentang konversi atribut dalam panduan ini berisi contoh lengkap untuk v2.

Riwayat dokumen

Dokumen API mendukung bekerja dengan dokumen JSON -style sebagai item tunggal dalam tabel DynamoDB. Dokumen v1 API memiliki yang sesuai API di v2, tetapi alih-alih menggunakan klien terpisah untuk dokumen API seperti pada v1, v2 menggabungkan API fitur dokumen dalam klien yang ditingkatkan DynamoDB.

Di v1, Itemkelas mewakili catatan tidak terstruktur dari tabel DynamoDB. Dalam v2, catatan tidak terstruktur diwakili oleh instance EnhancedDocumentkelas. Perhatikan bahwa kunci primer didefinisikan dalam skema tabel untuk v2, dan pada item itu sendiri di v1.

Tabel di bawah ini membandingkan perbedaan antara Dokumen APIs di v1 dan v2.

Kasus penggunaan v1 v2
Buat klien dokumen
AmazonDynamoDB client = ... //Create a client. DynamoDB documentClient = new DynamoDB(client);
// The v2 Document API uses the same DynamoDbEnhancedClient // that is used for mapping POJOs. DynamoDbClient standardClient = ... //Create a standard client. DynamoDbEnhancedClient enhancedClient = ... // Create an enhanced client.
Referensi tabel
Table documentTable = docClient.documentClient("Person");
DynamoDbTable<EnhancedDocument> documentTable = enhancedClient.table("Person", TableSchema.documentSchemaBuilder() .addIndexPartitionKey(TableMetadata.primaryIndexName(),"id", AttributeValueType.S) .attributeConverterProviders(AttributeConverterProvider.defaultProvider()) .build());
Work with semi-structured data
Put item
Item item = new Item() .withPrimaryKey("id", 50) .withString("firstName", "Shirley"); PutItemOutcome outcome = documentTable.putItem(item);
EnhancedDocument personDocument = EnhancedDocument.builder() .putNumber("id", 50) .putString("firstName", "Shirley") .build(); documentTable.putItem(personDocument);
Get item
GetItemOutcome outcome = documentTable.getItemOutcome( "id", 50); Item personDocFromDb = outcome.getItem(); String firstName = personDocFromDb.getString("firstName");
EnhancedDocument personDocFromDb = documentTable .getItem(Key.builder() .partitionValue(50) .build()); String firstName = personDocFromDb.getString("firstName");
Work with JSON items
Mengkonversi JSON struktur untuk menggunakannya dengan Dokumen API
// The 'jsonPerson' identifier is a JSON string. Item item = new Item().fromJSON(jsonPerson);
// The 'jsonPerson' identifier is a JSON string. EnhancedDocument document = EnhancedDocument.builder() .json(jsonPerson).build());
Masukan JSON
documentTable.putItem(item)
documentTable.putItem(document);
Baca JSON
GetItemOutcome outcome = //Get item. String jsonPerson = outcome.getItem().toJSON();
String jsonPerson = documentTable.getItem(Key.builder() .partitionValue(50).build()) .fromJson();

APIreferensi dan panduan untuk dokumen APIs

v1 v2
Referensi API Javadoc Javadoc
Panduan dokumentasi Panduan Pengembang Amazon DynamoDB Dokumen yang Ditingkatkan API (panduan ini)

FAQ

T. Apakah penguncian optimis dengan nomor versi bekerja dengan cara yang sama di v2 seperti di v1?

A. Perilakunya serupa, tetapi v2 tidak secara otomatis menambahkan kondisi untuk operasi penghapusan. Anda harus menambahkan ekspresi kondisi secara manual jika Anda ingin mengontrol perilaku hapus.