batch_write_item ( $opt )

Allows to execute a batch of Put and/or Delete Requests for many tables in a single call. A total of 25 requests are allowed.

There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • RequestItems - array - Required - A map of table name to list-of-write-requests. Used as input to the BatchWriteItem API call
    • [custom-key] - array - Optional - This key is variable (e.g., user-specified).
      • x - array - Optional - This represents a simple array index.
        • PutRequest - array - Optional - A container for a Put BatchWrite request
          • Item - array - Required - The item to put
            • [custom-key] - array - Optional - AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.
              • S - string - Optional - Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
              • N - string - Optional - Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
              • B - blob - Optional - Binary attributes are sequences of unsigned bytes.
              • SS - string|array - Optional - A set of strings. Pass a string for a single value, or an indexed array for multiple values.
              • NS - string|array - Optional - A set of numbers. Pass a string for a single value, or an indexed array for multiple values.
              • BS - blob - Optional - A set of binary attributes.
        • DeleteRequest - array - Optional - A container for a Delete BatchWrite request
          • Key - array - Required - The item’s key to be delete
            • HashKeyElement - array - Required - A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.
              • S - string - Optional - Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
              • N - string - Optional - Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
              • B - blob - Optional - Binary attributes are sequences of unsigned bytes.
              • SS - string|array - Optional - A set of strings. Pass a string for a single value, or an indexed array for multiple values.
              • NS - string|array - Optional - A set of numbers. Pass a string for a single value, or an indexed array for multiple values.
              • BS - blob - Optional - A set of binary attributes.
            • RangeKeyElement - array - Optional - A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.
              • S - string - Optional - Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
              • N - string - Optional - Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
              • B - blob - Optional - Binary attributes are sequences of unsigned bytes.
              • SS - string|array - Optional - A set of strings. Pass a string for a single value, or an indexed array for multiple values.
              • NS - string|array - Optional - A set of numbers. Pass a string for a single value, or an indexed array for multiple values.
              • BS - blob - Optional - A set of binary attributes.
    • value - array - Optional - AttributeValue can be String, Number, Binary, StringSet, NumberSet, BinarySet.
      • S - string - Optional - Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).
      • N - string - Optional - Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.
      • B - blob - Optional - Binary attributes are sequences of unsigned bytes.
      • SS - string|array - Optional - A set of strings. Pass a string for a single value, or an indexed array for multiple values.
      • NS - string|array - Optional - A set of numbers. Pass a string for a single value, or an indexed array for multiple values.
      • BS - blob - Optional - A set of binary attributes.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Create a new table with a Hash Key.

// Instantiate the class
$dynamodb = new AmazonDynamoDB();

$table_name = 'my-table-' . time();
$current_time = (int) time();

####################################################################
# Create a new DynamoDB table

$response = $dynamodb->create_table(array(
	'TableName' => $table_name,
	'KeySchema' => array(
		'HashKeyElement' => array(
			'AttributeName' => 'id',
			'AttributeType' => AmazonDynamoDB::TYPE_NUMBER
		),
		'RangeKeyElement' => array(
			'AttributeName' => 'date',
			'AttributeType' => AmazonDynamoDB::TYPE_NUMBER
		)
	),
	'ProvisionedThroughput' => array(
		'ReadCapacityUnits' => 50,
		'WriteCapacityUnits' => 50
	)
));

// Check for success...
if ($response->isOK())
{
	echo '# Kicked off the creation of the DynamoDB table...' . PHP_EOL;
}
else
{
	print_r($response);
}

####################################################################
# Sleep and poll until the table has been created

$count = 0;
do {
	sleep(1);
	$count++;

	$response = $dynamodb->describe_table(array(
		'TableName' => $table_name
	));
}
while ((string) $response->body->Table->TableStatus !== 'ACTIVE');

echo "The table \"${table_name}\" has been created (slept ${count} seconds)." . PHP_EOL;

####################################################################
# Adding data to the table

echo PHP_EOL . PHP_EOL;
echo "# Adding data to the table..." . PHP_EOL;

// Add items to the batch
$response = $dynamodb->batch_write_item(array(
	'RequestItems' => array(
		$table_name => array(
			array(
				'PutRequest' => array(
					'Item' => $dynamodb->attributes(array(
						'id'   => 1,             // Primary (Hash) Key
						'date' => $current_time, // Range Key
						'key1' => 'value1',
						'key2' => 'value2',
						'key3' => array('sub-value1', 'sub-value2'),
					))
				)
			),
			array(
				'PutRequest' => array(
					'Item' => $dynamodb->attributes(array(
						'id'   => 2,             // Primary (Hash) Key
						'date' => $current_time, // Range Key
						'key1' => 'value3',
						'key2' => 'value4',
						'key3' => array('sub-value1', 'sub-value2'),
					))
				)
			),
			array(
				'PutRequest' => array(
					'Item' => $dynamodb->attributes(array(
						'id'   => 3,             // Primary (Hash) Key
						'date' => $current_time, // Range Key
						'key1' => 'value5',
						'key2' => 'value6',
						'key3' => array('sub-value1', 'sub-value2'),
					))
				)
			),
		)
	)
));

// Check for success...
if ($response->isOK())
{
	echo "The data has been added to the table." . PHP_EOL;
}
else
{
	print_r($response);
}

####################################################################
# Getting an item

echo PHP_EOL . PHP_EOL;
echo "# Getting an item from the table..." . PHP_EOL;

// Get an item
$response = $dynamodb->get_item(array(
	'TableName' => $table_name,
	'Key' => $dynamodb->attributes(array(
		'HashKeyElement'  => 3,             // "id" column
		'RangeKeyElement' => $current_time, // "date" column
	)),
	'AttributesToGet' => array('id', 'date', 'key1', 'key2', 'key3'),
	'ConsistentRead' => 'true'
));

// Check for success...
if ($response->isOK())
{
	var_dump((string) $response->body->Item->key1->{AmazonDynamoDB::TYPE_STRING});
}
else
{
	print_r($response);
}

####################################################################
# Updating an item

echo PHP_EOL . PHP_EOL;
echo "# Updating an item from the table..." . PHP_EOL;

// Updating an item
$response = $dynamodb->update_item(array(
	'TableName' => $table_name,
	'Key' => $dynamodb->attributes(array(
		'HashKeyElement'  => 3, // "id" column
		'RangeKeyElement' => $current_time, // "date" column
	)),
	'AttributeUpdates' => array(
		'key1' => array(
			'Action' => AmazonDynamoDB::ACTION_PUT,
			'Value'  => array(AmazonDynamoDB::TYPE_STRING => 'updated-value1')
		),
		'key2' => array(
			'Action' => AmazonDynamoDB::ACTION_DELETE
		),
		'key3' => array(
			'Action' => AmazonDynamoDB::ACTION_ADD,
			'Value'  => array(AmazonDynamoDB::TYPE_STRING_SET => array('sub-value3'))
		),
		'key4' => array(
			'Action' => AmazonDynamoDB::ACTION_PUT,
			'Value'  => $dynamodb->binary('binary-value')
		),
	),
	'Expected' => array(
		'key1' => array(
			'Value' => array( AmazonDynamoDB::TYPE_STRING => 'value5' )
		)
	)
));

// Check for success...
if ($response->isOK())
{
	echo 'Updating the item...' . PHP_EOL;
}
else
{
	print_r($response);
}

####################################################################
# Checking the binary result

echo PHP_EOL . PHP_EOL;
echo "# Getting an item from the table..." . PHP_EOL;

// Get an item
$response = $dynamodb->get_item(array(
	'TableName' => $table_name,
	'Key' => $dynamodb->attributes(array(
		'HashKeyElement'  => 3,             // "id" column
		'RangeKeyElement' => $current_time, // "date" column
	)),
	'AttributesToGet' => array('key4'),
	'ConsistentRead' => 'true'
));

// Check for success...
if ($response->isOK())
{
	var_dump((string) $response->body->Item->key4->{AmazonDynamoDB::TYPE_BINARY});
}
else
{
	print_r($response);
}

####################################################################
# Deleting an item

echo PHP_EOL . PHP_EOL;
echo "# Deleting an item from the table..." . PHP_EOL;

// Deleting an item
$response = $dynamodb->delete_item(array(
	'TableName' => $table_name,
	'Key' => $dynamodb->attributes(array(
		'HashKeyElement'  => 1, // "id" column
		'RangeKeyElement' => $current_time, // "date" column
	)),

));

// Check for success...
if ($response->isOK())
{
	echo 'Deleting the item...' . PHP_EOL;
}
else
{
	print_r($response);
}

####################################################################
# Deleting the table

echo PHP_EOL . PHP_EOL;
echo "# Deleting the \"${table_name}\" table..." . PHP_EOL;

$response = $dynamodb->delete_table(array(
	'TableName' => $table_name
));

// Check for success...
if ($response->isOK())
{
	echo 'The table is in the process of deleting...' . PHP_EOL;
}
else
{
	print_r($response);
}

####################################################################
# Sleep and poll until the table has been deleted.

$count = 0;
do {
	echo '.';
	sleep(1);
	$count++;

	$response = $dynamodb->describe_table(array(
		'TableName' => $table_name
	));
}
while ((integer) $response->status !== 400);

echo "The table \"${table_name}\" has been deleted (slept ${count} seconds)." . PHP_EOL;

Source

Method defined in services/dynamodb.class.php | Toggle source view (6 lines) | View on GitHub

public function batch_write_item($opt = null)
{
    if (!$opt) $opt = array();
    
    return $this->authenticate('BatchWriteItem', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback