2022-12-20 11:23:09 -05:00
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
/**
* Before running this C++ code example, set up your development environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html
*
* For information on the structure of the code examples and how to build and run the examples, see
* https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started-code-examples.html.
*
**/
# include <aws/core/Aws.h>
# include <aws/dynamodb/DynamoDBClient.h>
# include <aws/dynamodb/model/AttributeDefinition.h>
# include <dynamodb/model/BatchWriteItemRequest.h>
# include <iostream>
# include <fstream>
# include "dynamodb_samples.h"
namespace AwsDoc {
namespace DynamoDB {
//! Convert requests in JSON format to a vector of WriteRequest objects.
/*!
\sa addWriteRequests()
\param tableName: Name of the table for the write operations.
\param requestsJson: Request data in JSON format.
\param writeRequests: Vector to receive the WriteRequest objects.
\return bool: Function succeeded.
*/
static bool addWriteRequests ( const Aws : : String & tableName ,
const Aws : : Utils : : Array < Aws : : Utils : : Json : : JsonView > & requestsJson ,
Aws : : Vector < Aws : : DynamoDB : : Model : : WriteRequest > & writeRequests ) ;
//! Generate a map of AttributeValue objects from JSON records.
/*!
\sa getAttributeObjectsMap()
\param jsonView: JSONView of attribute records.
\param writeRequests: Map to receive the AttributeValue objects.
\return bool: Function succeeded.
*/
static bool getAttributeObjectsMap ( const Aws : : Utils : : Json : : JsonView & jsonView ,
Aws : : Map < Aws : : String , Aws : : DynamoDB : : Model : : AttributeValue > & attributes ) ;
} // namespace DynamoDB
} // namespace AwsDoc
// snippet-start:[cpp.example_code.dynamodb.batch_write_item]
//! Batch write items from a JSON file.
/*!
\sa batchWriteItem()
\param jsonFilePath: JSON file path.
\param clientConfiguration: AWS client configuration.
\return bool: Function succeeded.
*/
/*
* The input for this routine is a JSON file that you can download from the following URL:
* https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/SampleData.html.
*
* The JSON data uses the BatchWriteItem API request syntax. The JSON strings are
* converted to AttributeValue objects. These AttributeValue objects will then generate
* JSON strings when constructing the BatchWriteItem request, essentially outputting
* their input.
*
* This is perhaps an artificial example, but it demonstrates the APIs.
*/
bool AwsDoc : : DynamoDB : : batchWriteItem ( const Aws : : String & jsonFilePath ,
const Aws : : Client : : ClientConfiguration & clientConfiguration ) {
std : : ifstream fileStream ( jsonFilePath ) ;
if ( ! fileStream ) {
std : : cerr < < " Error: could not open file ' " < < jsonFilePath < < " '. "
< < std : : endl ;
}
std : : stringstream stringStream ;
stringStream < < fileStream . rdbuf ( ) ;
Aws : : Utils : : Json : : JsonValue jsonValue ( stringStream ) ;
Aws : : DynamoDB : : Model : : BatchWriteItemRequest batchWriteItemRequest ;
Aws : : Map < Aws : : String , Aws : : Utils : : Json : : JsonView > level1Map = jsonValue . View ( ) . GetAllObjects ( ) ;
for ( const auto & level1Entry : level1Map ) {
const Aws : : Utils : : Json : : JsonView & entriesView = level1Entry . second ;
const Aws : : String & tableName = level1Entry . first ;
// The JSON entries at this level are as follows:
// key - table name
// value - list of request objects
if ( ! entriesView . IsListType ( ) ) {
std : : cerr < < " Error: JSON file entry ' "
< < tableName < < " ' is not a list. " < < std : : endl ;
continue ;
}
Aws : : Utils : : Array < Aws : : Utils : : Json : : JsonView > entries = entriesView . AsArray ( ) ;
Aws : : Vector < Aws : : DynamoDB : : Model : : WriteRequest > writeRequests ;
if ( AwsDoc : : DynamoDB : : addWriteRequests ( tableName , entries ,
writeRequests ) ) {
batchWriteItemRequest . AddRequestItems ( tableName , writeRequests ) ;
}
}
Aws : : DynamoDB : : DynamoDBClient dynamoClient ( clientConfiguration ) ;
Aws : : DynamoDB : : Model : : BatchWriteItemOutcome outcome = dynamoClient . BatchWriteItem (
batchWriteItemRequest ) ;
if ( outcome . IsSuccess ( ) ) {
std : : cout < < " DynamoDB::BatchWriteItem was successful. " < < std : : endl ;
}
else {
std : : cerr < < " Error with DynamoDB::BatchWriteItem. "
< < outcome . GetError ( ) . GetMessage ( )
< < std : : endl ;
2024-10-01 15:30:45 -04:00
return false ;
2022-12-20 11:23:09 -05:00
}
2024-10-01 15:30:45 -04:00
return outcome . IsSuccess ( ) ;
2022-12-20 11:23:09 -05:00
}
//! Convert requests in JSON format to a vector of WriteRequest objects.
/*!
\sa addWriteRequests()
\param tableName: Name of the table for the write operations.
\param requestsJson: Request data in JSON format.
\param writeRequests: Vector to receive the WriteRequest objects.
\return bool: Function succeeded.
*/
bool AwsDoc : : DynamoDB : : addWriteRequests ( const Aws : : String & tableName ,
const Aws : : Utils : : Array < Aws : : Utils : : Json : : JsonView > & requestsJson ,
Aws : : Vector < Aws : : DynamoDB : : Model : : WriteRequest > & writeRequests ) {
for ( size_t i = 0 ; i < requestsJson . GetLength ( ) ; + + i ) {
const Aws : : Utils : : Json : : JsonView & requestsEntry = requestsJson [ i ] ;
if ( ! requestsEntry . IsObject ( ) ) {
std : : cerr < < " Error: incorrect requestsEntry type "
< < requestsEntry . WriteReadable ( ) < < std : : endl ;
return false ;
}
Aws : : Map < Aws : : String , Aws : : Utils : : Json : : JsonView > requestsMap = requestsEntry . GetAllObjects ( ) ;
for ( const auto & request : requestsMap ) {
const Aws : : String & requestType = request . first ;
const Aws : : Utils : : Json : : JsonView & requestJsonView = request . second ;
if ( requestType = = " PutRequest " ) {
if ( ! requestJsonView . ValueExists ( " Item " ) ) {
std : : cerr < < " Error: item key missing for requests "
< < requestJsonView . WriteReadable ( ) < < std : : endl ;
return false ;
}
Aws : : Map < Aws : : String , Aws : : DynamoDB : : Model : : AttributeValue > attributes ;
if ( ! getAttributeObjectsMap ( requestJsonView . GetObject ( " Item " ) ,
attributes ) ) {
std : : cerr < < " Error getting attributes "
< < requestJsonView . WriteReadable ( ) < < std : : endl ;
return false ;
}
Aws : : DynamoDB : : Model : : PutRequest putRequest ;
putRequest . SetItem ( attributes ) ;
writeRequests . push_back (
Aws : : DynamoDB : : Model : : WriteRequest ( ) . WithPutRequest (
putRequest ) ) ;
}
else {
std : : cerr < < " Error: unimplemented request type ' " < < requestType
< < " '. " < < std : : endl ;
}
}
}
return true ;
}
//! Generate a map of AttributeValue objects from JSON records.
/*!
\sa getAttributeObjectsMap()
\param jsonView: JSONView of attribute records.
\param writeRequests: Map to receive the AttributeValue objects.
\return bool: Function succeeded.
*/
bool
AwsDoc : : DynamoDB : : getAttributeObjectsMap ( const Aws : : Utils : : Json : : JsonView & jsonView ,
Aws : : Map < Aws : : String , Aws : : DynamoDB : : Model : : AttributeValue > & attributes ) {
Aws : : Map < Aws : : String , Aws : : Utils : : Json : : JsonView > objectsMap = jsonView . GetAllObjects ( ) ;
for ( const auto & entry : objectsMap ) {
const Aws : : String & attributeKey = entry . first ;
const Aws : : Utils : : Json : : JsonView & attributeJsonView = entry . second ;
if ( ! attributeJsonView . IsObject ( ) ) {
std : : cerr < < " Error: attribute not an object "
< < attributeJsonView . WriteReadable ( ) < < std : : endl ;
return false ;
}
attributes . emplace ( attributeKey ,
Aws : : DynamoDB : : Model : : AttributeValue ( attributeJsonView ) ) ;
}
return true ;
}
// snippet-end:[cpp.example_code.dynamodb.batch_write_item]
/*
*
* main function
*
* Usage: 'run_batch_write_item <json_file_path>'
*
* Prerequisites:
* 1. Download the JSON file from the following URL:
* https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/SampleData.html.
* 2. Create a DynamoDB table. Use the table name in the JSON file.
*
*/
# ifndef TESTING_BUILD
int main ( int argc , char * * argv ) {
if ( argc < 2 ) {
std : : cout < < R " (
Usage :
run_batch_write_item < json_file_path >
Where :
json_file_path - path to JSON file containing requests
) " << std::endl;
return 1 ;
}
Aws : : SDKOptions options ;
Aws : : InitAPI ( options ) ;
{
const Aws : : String jsonFilePath = ( argv [ 1 ] ) ;
Aws : : Client : : ClientConfiguration clientConfig ;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
AwsDoc : : DynamoDB : : batchWriteItem ( jsonFilePath , clientConfig ) ;
}
Aws : : ShutdownAPI ( options ) ;
return 0 ;
}
# endif // TESTING_BUILD
