Skip to content

Latest commit

 

History

History
56 lines (45 loc) · 4.31 KB

README.md

File metadata and controls

56 lines (45 loc) · 4.31 KB
Raw

Transactions for Amazon DynamoDB

Amazon DynamoDB Transactions enables Java developers to easily perform atomic writes and isolated reads across multiple items and tables when building high scale applications on Amazon DynamoDB. You can get started in minutes using Maven.

The Amazon DynamoDB Transactions library is built on top of the low-level Amazon DynamoDB client in the AWS SDK for Java. For support in using and installing the AWS SDK for Java, see:

Features

  • Atomic writes: Write operations to multiple items are either all go through, or none go through.
  • Isolated reads: Read operations to multiple items are not interfered with by other transactions.
  • Sweepers: In-flight transaction state is stored in a separate table, and convenience methods are provided to "sweep" this table for "stuck" transactions.
  • Easy to use: Mimics the Amazon DynamoDB API by using the request and response objects from the low-level APIs, including PutItem, UpdateItem, DeleteItem, and GetItem.
  • Table helpers: Includes useful methods for creating tables such as and waiting for them to become ACTIVE.

Getting Started

  1. Sign up for AWS - Before you begin, you need an AWS account. Please see the AWS Account and Credentials section of the developer guide for information about how to create an AWS account and retrieve your AWS credentials.
  2. Minimum requirements - To run the SDK you will need Java 1.6+. For more information about the requirements and optimum settings for the SDK, please see the Java Development Environment section of the developer guide.
  3. Install the Amazon DynamoDB Transactions Library - Using Maven is the recommended way to install the Amazon DynamoDB Transactions Library and its dependencies, including the AWS SDK for Java. To download the code from GitHub, simply clone the repository by typing: git clone https://github.com/awslabs/dynamodb-transactions, and run the Maven command described below in "Building From Source".
  4. Run the examples - The included TransactionExamples automatically creates the necessary transactions tables, an example table for data and executes several operations with transactions. You can run the examples using Maven by:
  5. Ensure you have already built the library using Maven (see "Building From Source" below)
  6. Change into the examples directory of the project
  7. Add your AWS Credentials to the file: src/main/resources/com/amazonaws/services/dynamodbv2/transactions/examples/AwsCredentials.properties
  8. Compile the subproject by typing: mvn clean install
  9. Run the examples by typing: mvn exec:java -Dexec.mainClass="com.amazonaws.services.dynamodbv2.transactions.examples.TransactionExamples"

Building From Source

Once you check out the code from GitHub, you can build it using Maven. To disable the GPG-signing in the build, use: mvn clean install -Dgpg.skip=true