/*
* Copyright 2014-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.document;
import java.util.Collection;
import java.util.Map;
import org.apache.http.annotation.ThreadSafe;
import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
import com.amazonaws.services.dynamodbv2.document.api.DeleteItemApi;
import com.amazonaws.services.dynamodbv2.document.api.GetItemApi;
import com.amazonaws.services.dynamodbv2.document.api.PutItemApi;
import com.amazonaws.services.dynamodbv2.document.api.QueryApi;
import com.amazonaws.services.dynamodbv2.document.api.ScanApi;
import com.amazonaws.services.dynamodbv2.document.api.UpdateItemApi;
import com.amazonaws.services.dynamodbv2.document.internal.DeleteItemImpl;
import com.amazonaws.services.dynamodbv2.document.internal.GetItemImpl;
import com.amazonaws.services.dynamodbv2.document.internal.InternalUtils;
import com.amazonaws.services.dynamodbv2.document.internal.PutItemImpl;
import com.amazonaws.services.dynamodbv2.document.internal.QueryImpl;
import com.amazonaws.services.dynamodbv2.document.internal.ScanImpl;
import com.amazonaws.services.dynamodbv2.document.internal.UpdateItemImpl;
import com.amazonaws.services.dynamodbv2.document.spec.DeleteItemSpec;
import com.amazonaws.services.dynamodbv2.document.spec.GetItemSpec;
import com.amazonaws.services.dynamodbv2.document.spec.PutItemSpec;
import com.amazonaws.services.dynamodbv2.document.spec.QuerySpec;
import com.amazonaws.services.dynamodbv2.document.spec.ScanSpec;
import com.amazonaws.services.dynamodbv2.document.spec.UpdateItemSpec;
import com.amazonaws.services.dynamodbv2.document.spec.UpdateTableSpec;
import com.amazonaws.services.dynamodbv2.model.DeleteTableResult;
import com.amazonaws.services.dynamodbv2.model.DescribeTableRequest;
import com.amazonaws.services.dynamodbv2.model.DescribeTableResult;
import com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
import com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException;
import com.amazonaws.services.dynamodbv2.model.TableDescription;
import com.amazonaws.services.dynamodbv2.model.UpdateTableResult;
/**
* A DynamoDB table. Instance of this class is typically obtained via
* {@link DynamoDB#getTable(String)}.
*/
@ThreadSafe
public class Table implements PutItemApi, GetItemApi, QueryApi, ScanApi,
UpdateItemApi, DeleteItemApi {
private static final long SLEEP_TIME_MILLIS = 5000;
private final String tableName;
private final AmazonDynamoDB client;
private volatile TableDescription tableDescription;
private final PutItemImpl putItemDelegate;
private final GetItemImpl getItemDelegate;
private final UpdateItemImpl updateItemDelegate;
private final DeleteItemImpl deleteItemDelegate;
private final QueryImpl queryDelegate;
private final ScanImpl scanDelegate;
public Table(AmazonDynamoDB client, String tableName) {
this(client, tableName, null);
}
public Table(AmazonDynamoDB client, String tableName,
TableDescription tableDescription) {
if (client == null)
throw new IllegalArgumentException("client must be specified");
if (tableName == null || tableName.trim().length() == 0)
throw new IllegalArgumentException("table name must not be null or empty");
this.client = client;
this.tableName = tableName;
this.tableDescription = tableDescription;
this.putItemDelegate = new PutItemImpl(client, this);
this.getItemDelegate = new GetItemImpl(client, this);
this.updateItemDelegate = new UpdateItemImpl(client, this);
this.deleteItemDelegate = new DeleteItemImpl(client, this);
this.queryDelegate = new QueryImpl(client, this);
this.scanDelegate = new ScanImpl(client, this);
}
public String getTableName() {
return tableName;
}
/**
* Returns the table description; or null if the table description has not
* yet been described via {@link #describe()}. No network call.
*/
public TableDescription getDescription() {
return tableDescription;
}
/**
* Retrieves the table description from DynamoDB. Involves network calls.
* Meant to be called as infrequently as possible to avoid throttling
* exception from the server side.
*/
public TableDescription describe() {
DescribeTableResult result = client.describeTable(
InternalUtils.applyUserAgent(new DescribeTableRequest(tableName)));
return tableDescription = result.getTable();
}
/**
* Gets a reference to the specified index. No network call.
*/
public Index getIndex(String indexName) {
return new Index(client, indexName, this);
}
@Override
public PutItemOutcome putItem(Item item) {
return putItemDelegate.putItem(item);
}
@Override
public PutItemOutcome putItem(Item item, Expected... expected) {
return putItemDelegate.putItem(item, expected);
}
@Override
public PutItemOutcome putItem(Item item, String conditionExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return putItemDelegate.putItem(item, conditionExpression, nameMap,
valueMap);
}
@Override
public PutItemOutcome putItem(PutItemSpec spec) {
return putItemDelegate.putItem(spec);
}
@Override
public GetItemOutcome getItemOutcome(KeyAttribute... primaryKeyComponents) {
return getItemDelegate.getItemOutcome(primaryKeyComponents);
}
@Override
public GetItemOutcome getItemOutcome(PrimaryKey primaryKey) {
return getItemDelegate.getItemOutcome(primaryKey);
}
@Override
public GetItemOutcome getItemOutcome(PrimaryKey primaryKey,
String projectionExpression, Map<String, String> nameMap) {
return getItemDelegate.getItemOutcome(primaryKey, projectionExpression,
nameMap);
}
@Override
public GetItemOutcome getItemOutcome(GetItemSpec params) {
return getItemDelegate.getItemOutcome(params);
}
@Override
public UpdateItemOutcome updateItem(PrimaryKey primaryKey,
AttributeUpdate... attributeUpdates) {
return updateItemDelegate.updateItem(primaryKey, attributeUpdates);
}
@Override
public UpdateItemOutcome updateItem(PrimaryKey primaryKey,
Collection<Expected> expected, AttributeUpdate... attributeUpdates) {
return updateItemDelegate.updateItem(primaryKey, expected,
attributeUpdates);
}
@Override
public UpdateItemOutcome updateItem(PrimaryKey primaryKey,
String updateExpression, Map<String, String> nameMap,
Map<String, Object> valueMap) {
return updateItemDelegate.updateItem(primaryKey, updateExpression,
nameMap, valueMap);
}
@Override
public UpdateItemOutcome updateItem(PrimaryKey primaryKey,
String updateExpression, String conditionExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return updateItemDelegate.updateItem(primaryKey, updateExpression,
conditionExpression, nameMap, valueMap);
}
@Override
public UpdateItemOutcome updateItem(UpdateItemSpec updateItemSpec) {
return updateItemDelegate.updateItem(updateItemSpec);
}
@Override
public ItemCollection<QueryOutcome> query(String hashKeyName, Object hashKeyValue) {
return queryDelegate.query(hashKeyName, hashKeyValue);
}
@Override
public ItemCollection<QueryOutcome> query(KeyAttribute hashKey) {
return queryDelegate.query(hashKey);
}
@Override
public ItemCollection<QueryOutcome> query(KeyAttribute hashKey,
RangeKeyCondition rangeKeyCondition) {
return queryDelegate.query(hashKey, rangeKeyCondition);
}
@Override
public ItemCollection<QueryOutcome> query(KeyAttribute hashKey,
RangeKeyCondition rangeKeyCondition, String filterExpression,
String projectionExpression,Map<String, String> nameMap,
Map<String, Object> valueMap) {
return queryDelegate.query(hashKey, rangeKeyCondition,
filterExpression, projectionExpression, nameMap, valueMap);
}
@Override
public ItemCollection<QueryOutcome> query(KeyAttribute hashKey,
RangeKeyCondition rangeKeyCondition, QueryFilter... queryFilters) {
return queryDelegate.query(hashKey, rangeKeyCondition, queryFilters);
}
@Override
public ItemCollection<QueryOutcome> query(KeyAttribute hashKey,
RangeKeyCondition rangeKeyCondition, String filterExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return queryDelegate.query(hashKey, rangeKeyCondition,
filterExpression, nameMap, valueMap);
}
@Override
public ItemCollection<QueryOutcome> query(QuerySpec spec) {
return queryDelegate.query(spec);
}
@Override
public ItemCollection<ScanOutcome> scan(ScanFilter... scanFilters) {
return scanDelegate.scan(scanFilters);
}
@Override
public ItemCollection<ScanOutcome> scan(String filterExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return scanDelegate.scan(filterExpression, nameMap, valueMap);
}
@Override
public ItemCollection<ScanOutcome> scan(String filterExpression,
String projectionExpression, Map<String, String> nameMap,
Map<String, Object> valueMap) {
return scanDelegate.scan(filterExpression, projectionExpression, nameMap, valueMap);
}
@Override
public ItemCollection<ScanOutcome> scan(ScanSpec params) {
return scanDelegate.scan(params);
}
@Override
public DeleteItemOutcome deleteItem(KeyAttribute... primaryKeyComponents) {
return deleteItemDelegate.deleteItem(primaryKeyComponents);
}
@Override
public DeleteItemOutcome deleteItem(PrimaryKey primaryKey) {
return deleteItemDelegate.deleteItem(primaryKey);
}
@Override
public DeleteItemOutcome deleteItem(PrimaryKey primaryKey,
Expected... expected) {
return deleteItemDelegate.deleteItem(primaryKey, expected);
}
@Override
public DeleteItemOutcome deleteItem(PrimaryKey primaryKey,
String conditionExpression, Map<String, String> nameMap,
Map<String, Object> valueMap) {
return deleteItemDelegate.deleteItem(primaryKey,
conditionExpression, nameMap, valueMap);
}
@Override
public DeleteItemOutcome deleteItem(DeleteItemSpec spec) {
return deleteItemDelegate.deleteItem(spec);
}
/**
* Updates the provisioned throughput for this table. Setting the
* throughput for a table helps you manage performance and is part of the
* provisioned throughput feature of DynamoDB.
* <p>
* The provisioned throughput values can be upgraded or downgraded based
* on the maximums and minimums listed in the
* <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"> Limits </a>
* section in the Amazon DynamoDB Developer Guide.
* <p>
* This table must be in the <code>ACTIVE</code> state for this operation
* to succeed. <i>UpdateTable</i> is an asynchronous operation; while
* executing the operation, the table is in the <code>UPDATING</code>
* state. While the table is in the <code>UPDATING</code> state, the
* table still has the provisioned throughput from before the call. The
* new provisioned throughput setting is in effect only when the table
* returns to the <code>ACTIVE</code> state after the <i>UpdateTable</i>
* operation.
* <p>
* You cannot add, modify or delete indexes using <i>UpdateTable</i> .
* Indexes can only be defined at table creation time.
* </p>
*
* @param spec used to specify all the detailed parameters
*
* @return the updated table description returned from DynamoDB.
*/
public TableDescription updateTable(UpdateTableSpec spec) {
UpdateTableResult result = client.updateTable(spec.getRequest());
return this.tableDescription = result.getTableDescription();
}
/**
* Updates the provisioned throughput for this table. Setting the
* throughput for a table helps you manage performance and is part of the
* provisioned throughput feature of DynamoDB.
* <p>
* The provisioned throughput values can be upgraded or downgraded based
* on the maximums and minimums listed in the
* <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"> Limits </a>
* section in the Amazon DynamoDB Developer Guide.
* <p>
* This table must be in the <code>ACTIVE</code> state for this operation
* to succeed. <i>UpdateTable</i> is an asynchronous operation; while
* executing the operation, the table is in the <code>UPDATING</code>
* state. While the table is in the <code>UPDATING</code> state, the
* table still has the provisioned throughput from before the call. The
* new provisioned throughput setting is in effect only when the table
* returns to the <code>ACTIVE</code> state after the <i>UpdateTable</i>
* operation.
* <p>
* You cannot add, modify or delete indexes using <i>UpdateTable</i> .
* Indexes can only be defined at table creation time.
* </p>
*
* @param provisionedThroughput target provisioned throughput
*
* @return the updated table description returned from DynamoDB.
*/
public TableDescription updateTable(
ProvisionedThroughput provisionedThroughput) {
return updateTable(new UpdateTableSpec()
.withProvisionedThroughput(provisionedThroughput));
}
/**
* A convenient blocking call that can be used, typically during table
* creation, to wait for the table to become active by polling the table
* every 5 seconds.
*/
public TableDescription waitForActive() throws InterruptedException {
TableDescription desc = describe();
String status = desc.getTableStatus();
for (;; status = desc.getTableStatus()) {
if ("ACTIVE".equals(status))
return desc;
if ("CREATING".equals(status) || "UPDATING".equals(status)) {
Thread.sleep(SLEEP_TIME_MILLIS);
desc = describe();
continue;
}
throw new IllegalArgumentException("Table " + tableName
+ " is not being created (with status=" + status + ")");
}
}
/**
* A convenient blocking call that can be used, typically during table
* deletion, to wait for the table to become deleted by polling the table
* every 5 seconds.
*/
public void waitForDelete() throws InterruptedException {
try {
TableDescription desc = describe();
String status = desc.getTableStatus();
for (;; status = desc.getTableStatus()) {
if ("DELETING".equals(status)) {
Thread.sleep(SLEEP_TIME_MILLIS);
desc = describe();
continue;
}
throw new IllegalArgumentException("Table " + tableName
+ " is not being deleted (with status=" + status + ")");
}
} catch(ResourceNotFoundException deleted) {
}
return;
}
/**
* A convenient blocking call that can be used to wait on a table until it
* has either become active or deleted (ie no longer exists) by polling the
* table every 5 seconds.
*
* @return the table description if the table has become active; or null if
* the table has been deleted (or has never exists.);
*/
public TableDescription waitForActiveOrDelete() throws InterruptedException {
try {
TableDescription desc = describe();
String status = desc.getTableStatus();
for (;; status = desc.getTableStatus()) {
if ("ACTIVE".equals(status))
return desc;
if ("CREATING".equals(status)
|| "UPDATING".equals(status)
|| "DELETING".equals(status)) {
Thread.sleep(SLEEP_TIME_MILLIS);
desc = describe();
continue;
}
throw new IllegalStateException();
}
} catch(ResourceNotFoundException deleted) {
}
return null;
}
/**
* Deletes the table from DynamoDB. Involves network calls.
*/
public DeleteTableResult delete() {
return client.deleteTable(tableName);
}
@Override
public Item getItem(KeyAttribute... primaryKeyComponents) {
return getItemDelegate.getItem(primaryKeyComponents);
}
@Override
public Item getItem(PrimaryKey primaryKey) {
return getItemDelegate.getItem(primaryKey);
}
@Override
public Item getItem(PrimaryKey primaryKey, String projectionExpression,
Map<String, String> nameMap) {
return getItemDelegate.getItem(primaryKey, projectionExpression, nameMap);
}
@Override
public Item getItem(GetItemSpec spec) {
return getItemDelegate.getItem(spec);
}
@Override
public GetItemOutcome getItemOutcome(String hashKeyName, Object hashKeyValue) {
return getItemDelegate.getItemOutcome(hashKeyName, hashKeyValue);
}
@Override
public GetItemOutcome getItemOutcome(String hashKeyName, Object hashKeyValue,
String rangeKeyName, Object rangeKeyValue) {
return getItemDelegate.getItemOutcome(hashKeyName, hashKeyValue, rangeKeyName, rangeKeyValue);
}
@Override
public Item getItem(String hashKeyName, Object hashKeyValue) {
return getItemDelegate.getItem(hashKeyName, hashKeyValue);
}
@Override
public Item getItem(String hashKeyName, Object hashKeyValue,
String rangeKeyName, Object rangeKeyValue) {
return getItemDelegate.getItem(hashKeyName, hashKeyValue, rangeKeyName, rangeKeyValue);
}
@Override
public ItemCollection<QueryOutcome> query(String hashKeyName,
Object hashKeyValue, RangeKeyCondition rangeKeyCondition) {
return queryDelegate.query(hashKeyName, hashKeyValue, rangeKeyCondition);
}
@Override
public ItemCollection<QueryOutcome> query(String hashKeyName,
Object hashKeyValue, RangeKeyCondition rangeKeyCondition,
QueryFilter... queryFilters) {
return queryDelegate.query(hashKeyName, hashKeyValue,
rangeKeyCondition, queryFilters);
}
@Override
public ItemCollection<QueryOutcome> query(String hashKeyName,
Object hashKeyValue, RangeKeyCondition rangeKeyCondition,
String filterExpression, Map<String, String> nameMap,
Map<String, Object> valueMap) {
return queryDelegate.query(hashKeyName, hashKeyValue,
rangeKeyCondition, filterExpression, nameMap, valueMap);
}
@Override
public ItemCollection<QueryOutcome> query(String hashKeyName,
Object hashKeyValue, RangeKeyCondition rangeKeyCondition,
String filterExpression, String projectionExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return queryDelegate.query(hashKeyName, hashKeyValue,
rangeKeyCondition, filterExpression, projectionExpression,
nameMap, valueMap);
}
@Override
public UpdateItemOutcome updateItem(String hashKeyName,
Object hashKeyValue, AttributeUpdate... attributeUpdates) {
return updateItemDelegate.updateItem(hashKeyName, hashKeyValue,
attributeUpdates);
}
@Override
public UpdateItemOutcome updateItem(String hashKeyName,
Object hashKeyValue, String rangeKeyName, Object rangeKeyValue,
AttributeUpdate... attributeUpdates) {
return updateItemDelegate.updateItem(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue, attributeUpdates);
}
@Override
public UpdateItemOutcome updateItem(String hashKeyName,
Object hashKeyValue, Collection<Expected> expected,
AttributeUpdate... attributeUpdates) {
return updateItemDelegate.updateItem(hashKeyName, hashKeyValue,
expected, attributeUpdates);
}
@Override
public UpdateItemOutcome updateItem(String hashKeyName,
Object hashKeyValue, String rangeKeyName, Object rangeKeyValue,
Collection<Expected> expected, AttributeUpdate... attributeUpdates) {
return updateItemDelegate.updateItem(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue,
expected, attributeUpdates);
}
@Override
public UpdateItemOutcome updateItem(String hashKeyName,
Object hashKeyValue, String updateExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return updateItemDelegate.updateItem(hashKeyName, hashKeyValue,
updateExpression, nameMap, valueMap);
}
@Override
public UpdateItemOutcome updateItem(String hashKeyName, Object hashKeyValue,
String rangeKeyName, Object rangeKeyValue,
String updateExpression,
Map<String, String> nameMap,
Map<String, Object> valueMap) {
return updateItemDelegate.updateItem(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue,
updateExpression, nameMap, valueMap);
}
@Override
public UpdateItemOutcome updateItem(String hashKeyName, Object hashKeyValue,
String updateExpression, String conditionExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return updateItemDelegate.updateItem(hashKeyName, hashKeyValue,
updateExpression, conditionExpression,
nameMap, valueMap);
}
@Override
public UpdateItemOutcome updateItem(String hashKeyName, Object hashKeyValue,
String rangeKeyName, Object rangeKeyValue,
String updateExpression, String conditionExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return updateItemDelegate.updateItem(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue,
updateExpression, conditionExpression,
nameMap, valueMap);
}
@Override
public GetItemOutcome getItemOutcome(String hashKeyName,
Object hashKeyValue, String projectionExpression,
Map<String, String> nameMap) {
return getItemDelegate.getItemOutcome(hashKeyName, hashKeyValue,
projectionExpression, nameMap);
}
@Override
public GetItemOutcome getItemOutcome(String hashKeyName,
Object hashKeyValue, String rangeKeyName, Object rangeKeyValue,
String projectionExpression, Map<String, String> nameMap) {
return getItemDelegate.getItemOutcome(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue, projectionExpression, nameMap);
}
@Override
public Item getItem(String hashKeyName, Object hashKeyValue,
String projectionExpression, Map<String, String> nameMap) {
return getItemDelegate.getItem(hashKeyName, hashKeyValue,
projectionExpression, nameMap);
}
@Override
public Item getItem(String hashKeyName, Object hashKeyValue,
String rangeKeyName, Object rangeKeyValue,
String projectionExpression, Map<String, String> nameMap) {
return getItemDelegate.getItem(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue, projectionExpression, nameMap);
}
@Override
public DeleteItemOutcome deleteItem(String hashKeyName, Object hashKeyValue) {
return deleteItemDelegate.deleteItem(hashKeyName, hashKeyValue);
}
@Override
public DeleteItemOutcome deleteItem(String hashKeyName,
Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) {
return deleteItemDelegate.deleteItem(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue);
}
@Override
public DeleteItemOutcome deleteItem(String hashKeyName,
Object hashKeyValue, Expected... expected) {
return deleteItemDelegate.deleteItem(hashKeyName, hashKeyValue,
expected);
}
@Override
public DeleteItemOutcome deleteItem(String hashKeyName,
Object hashKeyValue, String rangeKeyName, Object rangeKeyValue,
Expected... expected) {
return deleteItemDelegate.deleteItem(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue, expected);
}
@Override
public DeleteItemOutcome deleteItem(String hashKeyName,
Object hashKeyValue, String conditionExpression,
Map<String, String> nameMap, Map<String, Object> valueMap) {
return deleteItemDelegate.deleteItem(hashKeyName, hashKeyValue,
conditionExpression, nameMap, valueMap);
}
@Override
public DeleteItemOutcome deleteItem(String hashKeyName,
Object hashKeyValue, String rangeKeyName, Object rangeKeyValue,
String conditionExpression, Map<String, String> nameMap,
Map<String, Object> valueMap) {
return deleteItemDelegate.deleteItem(hashKeyName, hashKeyValue,
rangeKeyName, rangeKeyValue,
conditionExpression, nameMap, valueMap);
}
@Override
public String toString() {
return "{" + tableName + ": " + tableDescription + "}";
}
}