software.amazon.awssdk.services.dynamodb.util

Class TableUtils

java.lang.Object

software.amazon.awssdk.services.dynamodb.util.TableUtils

public class TableUtils
extends Object

Utility methods for working with DynamoDB tables.

 // ... create DynamoDB table ...
 try {
     waitUntilActive(dynamoDB, myTableName());
 } catch (AmazonClientException e) {
     // table didn't become active
 }
 // ... start making calls to table ...
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableUtils.TableNeverTransitionedToStateException Thrown by TableUtils when a table never reaches a desired state

Constructor Summary

Constructors

Constructor and Description
TableUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	createTableIfNotExists(DynamoDBClient dynamo, CreateTableRequest createTableRequest) Creates the table and ignores any errors if it already exists.
static boolean	deleteTableIfExists(DynamoDBClient dynamo, DeleteTableRequest deleteTableRequest) Deletes the table and ignores any errors if it doesn't exist.
static void	waitUntilActive(DynamoDBClient dynamo, String tableName) Waits up to 10 minutes for a specified DynamoDB table to move into the ACTIVE state.
static void	waitUntilActive(DynamoDBClient dynamo, String tableName, int timeout, int interval) Waits up to a specified amount of time for a specified DynamoDB table to move into the ACTIVE state.
static void	waitUntilExists(DynamoDBClient dynamo, String tableName) Waits up to 10 minutes for a specified DynamoDB table to resolve, indicating that it exists.
static void	waitUntilExists(DynamoDBClient dynamo, String tableName, int timeout, int interval) Waits up to a specified amount of time for a specified DynamoDB table to resolve, indicating that it exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableUtils

public TableUtils()

Method Detail

waitUntilExists

public static void waitUntilExists(DynamoDBClient dynamo,
                                   String tableName)
                            throws InterruptedException

Waits up to 10 minutes for a specified DynamoDB table to resolve, indicating that it exists. If the table doesn't return a result after this time, a SdkClientException is thrown.

Parameters:

dynamo - The DynamoDB client to use to make requests.

tableName - The name of the table being resolved.

Throws:

SdkClientException - If the specified table does not resolve before this method times out and stops polling.

InterruptedException - If the thread is interrupted while waiting for the table to resolve.

waitUntilExists

public static void waitUntilExists(DynamoDBClient dynamo,
                                   String tableName,
                                   int timeout,
                                   int interval)
                            throws InterruptedException

Waits up to a specified amount of time for a specified DynamoDB table to resolve, indicating that it exists. If the table doesn't return a result after this time, a SdkClientException is thrown.

Parameters:

dynamo - The DynamoDB client to use to make requests.

tableName - The name of the table being resolved.

timeout - The maximum number of milliseconds to wait.

interval - The poll interval in milliseconds.

Throws:

SdkClientException - If the specified table does not resolve before this method times out and stops polling.

InterruptedException - If the thread is interrupted while waiting for the table to resolve.

waitUntilActive

public static void waitUntilActive(DynamoDBClient dynamo,
                                   String tableName)
                            throws InterruptedException,
                                   TableUtils.TableNeverTransitionedToStateException

Waits up to 10 minutes for a specified DynamoDB table to move into the ACTIVE state. If the table does not exist or does not transition to the ACTIVE state after this time, then SdkClientException is thrown.

Parameters:

dynamo - The DynamoDB client to use to make requests.

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

Throws:

TableUtils.TableNeverTransitionedToStateException - If the specified table does not exist or 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.

waitUntilActive

public static void waitUntilActive(DynamoDBClient dynamo,
                                   String tableName,
                                   int timeout,
                                   int interval)
                            throws InterruptedException,
                                   TableUtils.TableNeverTransitionedToStateException

Waits up to a specified amount of time for a specified DynamoDB table to move into the ACTIVE state. If the table does not exist or does not transition to the ACTIVE state after this time, then a SdkClientException is thrown.

Parameters:

dynamo - The 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:

TableUtils.TableNeverTransitionedToStateException - If the specified table does not exist or 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.

createTableIfNotExists

public static final boolean createTableIfNotExists(DynamoDBClient dynamo,
                                                   CreateTableRequest createTableRequest)

Creates the table and ignores any errors if it already exists.

Parameters:

dynamo - The Dynamo client to use.

createTableRequest - The create table request.

Returns:

True if created, false otherwise.

deleteTableIfExists

public static final boolean deleteTableIfExists(DynamoDBClient dynamo,
                                                DeleteTableRequest deleteTableRequest)

Deletes the table and ignores any errors if it doesn't exist.

Parameters:

dynamo - The Dynamo client to use.

deleteTableRequest - The delete table request.

Returns:

True if deleted, false otherwise.