com.amazonaws.services.dynamodbv2.util

Class Tables

java.lang.Object

com.amazonaws.services.dynamodbv2.util.Tables

public class Tables
extends Object

Utility methods for working with AWS DynamoDB tables.

 if (Tables.doesTableExist(dynamoDB, myTableName) == false) {
    // ... create your table ...
    Tables.awaitTableToBecomeActive(dynamoDB, myTableName);
 }
 

Constructor Summary

Constructors

Constructor and Description
Tables()

Method Summary

Methods

Modifier and Type	Method and Description
static void	awaitTableToBecomeActive(AmazonDynamoDB dynamo, String tableName) Waits up to 10 minutes for a specified AWS DynamoDB table to move into the ACTIVE state.
static void	awaitTableToBecomeActive(AmazonDynamoDB dynamo, String tableName, int timeout, int interval) Waits up to a specified amount of time for a specified AWS DynamoDB table to move into the ACTIVE state.
static boolean	doesTableExist(AmazonDynamoDB dynamo, String tableName) Checks if a specified table exists and is in ACTIVE state.
static void	waitForTableToBecomeActive(AmazonDynamoDB dynamo, String tableName) Deprecated. Use awaitTableToBecomeActive(AmazonDynamoDB, String).
static void	waitForTableToBecomeActive(AmazonDynamoDB dynamo, String tableName, int timeout, int interval) Deprecated. Use awaitTableToBecomeActive(AmazonDynamoDB, String, int, int).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tables

public Tables()

Method Detail

doesTableExist

public static boolean doesTableExist(AmazonDynamoDB dynamo,
                     String tableName)

Checks if a specified table exists and is in ACTIVE state.

Parameters:

dynamo - The AWS DynamoDB client to use to make requests.

tableName - The name of the table being searched for.

Returns:

True if a table already exists with the specified name, otherwise false.

waitForTableToBecomeActive

@Deprecated
public static void waitForTableToBecomeActive(AmazonDynamoDB dynamo,
                                         String tableName)

Deprecated. Use awaitTableToBecomeActive(AmazonDynamoDB, String).

Waits up to 10 minutes for a specified AWS DynamoDB table to move into the ACTIVE state. If the table doesn't transition to the ACTIVE state, then an AmazonClientException is thrown.

Parameters:

dynamo - The AWS DynamoDB client to use to make requests.

tableName - The name of the table whose status is being checked.

Throws:

AmazonClientException - If the specified table does not transition into the ACTIVE state before this method times out and stops polling.

awaitTableToBecomeActive

public static void awaitTableToBecomeActive(AmazonDynamoDB dynamo,
                            String tableName)
                                     throws InterruptedException

Waits up to 10 minutes for a specified AWS DynamoDB table to move into the ACTIVE state. If the table doesn't transition to the ACTIVE state, then an AmazonClientException is thrown.

Parameters:

dynamo - The AWS DynamoDB client to use to make requests.

tableName - The name of the table whose status is being checked.

Throws:

AmazonClientException - If the specified table does not transition into the ACTIVE state before this method times out and stops polling.

InterruptedException - If the thread is interrupted while waiting for the table to transition into the ACTIVE state.

waitForTableToBecomeActive

@Deprecated
public static void waitForTableToBecomeActive(AmazonDynamoDB dynamo,
                                         String tableName,
                                         int timeout,
                                         int interval)

Deprecated. Use awaitTableToBecomeActive(AmazonDynamoDB, String, int, int).

Waits up to a specified amount of time for a specified AWS DynamoDB table to move into the ACTIVE state. If the table doesn't transition to the ACTIVE state, then an AmazonClientException is thrown.

Parameters:

dynamo - The AWS DynamoDB client to use to make requests.

tableName - The name of the table whose status is being checked.

timeout - The maximum number of milliseconds to wait.

interval - The poll interval in milliseconds.

Throws:

AmazonClientException - If the specified table does not transition into the ACTIVE state before this method times out and stops polling.

awaitTableToBecomeActive

public static void awaitTableToBecomeActive(AmazonDynamoDB dynamo,
                            String tableName,
                            int timeout,
                            int interval)
                                     throws InterruptedException

Waits up to a specified amount of time for a specified AWS DynamoDB table to move into the ACTIVE state. If the table doesn't transition to the ACTIVE state, then an AmazonClientException is thrown.

Parameters:

dynamo - The AWS DynamoDB client to use to make requests.

tableName - The name of the table whose status is being checked.

timeout - The maximum number of milliseconds to wait.

interval - The poll interval in milliseconds.

Throws:

AmazonClientException - If the specified table does not transition into the ACTIVE state before this method times out and stops polling.

InterruptedException - If the thread is interrupted while waiting for the table to transition into the ACTIVE state.