org.apache.beam.it.gcp.spanner

Class SpannerResourceManager

java.lang.Object

org.apache.beam.it.gcp.spanner.SpannerResourceManager

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

public final class SpannerResourceManager
extends java.lang.Object
implements org.apache.beam.it.common.ResourceManager

Client for managing Spanner resources.

The class supports one instance, one database, and multiple tables per manager object. The instance and database are created when the first table is created.

The instance and database ids are formed using testId. The database id will be {testId}, with some extra formatting. The instance id will be "{testId}-{ISO8601 time, microsecond precision}", with additional formatting. Note: If testId is more than 30 characters, a new testId will be formed for naming: {first 21 chars of long testId} + “-” + {8 char hash of testId}.

The class is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpannerResourceManager.Builder Builder for SpannerResourceManager.

Method Summary

Modifier and Type	Method and Description
static SpannerResourceManager.Builder	builder(java.lang.String testId, java.lang.String projectId, java.lang.String region)
static SpannerResourceManager.Builder	builder(java.lang.String testId, java.lang.String projectId, java.lang.String region, com.google.cloud.spanner.Dialect dialect)
static SpannerResourceManager.Builder	builder(java.lang.String testId, java.lang.String projectId, java.lang.String region, int nodeCount)
void	cleanupAll() Deletes all created resources (instance, database, and tables) and cleans up all Spanner sessions, making the manager object unusable.
void	executeDdlStatement(java.lang.String statement) Executes a DDL statement.
java.lang.String	getDatabaseId() Return the dataset ID this Resource Manager uses to create and manage tables in.
java.lang.String	getInstanceId() Return the instance ID this Resource Manager uses to create and manage tables in.
com.google.common.collect.ImmutableList<com.google.cloud.spanner.Struct>	readTableRecords(java.lang.String tableId, java.lang.Iterable<java.lang.String> columnNames) Reads all the rows in a table.This method requires executeDdlStatement(String) to be called for the target table beforehand.
com.google.common.collect.ImmutableList<com.google.cloud.spanner.Struct>	readTableRecords(java.lang.String tableId, java.lang.String... columnNames) Reads all the rows in a table.
void	write(java.lang.Iterable<com.google.cloud.spanner.Mutation> tableRecords) Writes a collection of table records into one or more tables.
void	write(com.google.cloud.spanner.Mutation tableRecord) Writes a given record into a table.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SpannerResourceManager.Builder builder(java.lang.String testId,
                                                     java.lang.String projectId,
                                                     java.lang.String region)

builder

public static SpannerResourceManager.Builder builder(java.lang.String testId,
                                                     java.lang.String projectId,
                                                     java.lang.String region,
                                                     int nodeCount)

builder

public static SpannerResourceManager.Builder builder(java.lang.String testId,
                                                     java.lang.String projectId,
                                                     java.lang.String region,
                                                     com.google.cloud.spanner.Dialect dialect)

getInstanceId

public java.lang.String getInstanceId()

Return the instance ID this Resource Manager uses to create and manage tables in.

Returns:

the instance ID.

getDatabaseId

public java.lang.String getDatabaseId()

Return the dataset ID this Resource Manager uses to create and manage tables in.

Returns:

the dataset ID.

executeDdlStatement

public void executeDdlStatement(java.lang.String statement)
                         throws java.lang.IllegalStateException

Executes a DDL statement.

Note: Implementations may do instance creation and database creation here.

Parameters:

statement - The DDL statement.

Throws:

java.lang.IllegalStateException - if method is called after resources have been cleaned up.

write

public void write(com.google.cloud.spanner.Mutation tableRecord)
           throws java.lang.IllegalStateException

Writes a given record into a table. This method requires executeDdlStatement(String) to be called for the target table beforehand.

Parameters:

tableRecord - A mutation object representing the table record.

Throws:

java.lang.IllegalStateException - if method is called after resources have been cleaned up or if the manager object has no instance or database.

write

public void write(java.lang.Iterable<com.google.cloud.spanner.Mutation> tableRecords)
           throws java.lang.IllegalStateException

Writes a collection of table records into one or more tables. This method requires executeDdlStatement(String) to be called for the target table beforehand.

Parameters:

tableRecords - A collection of mutation objects representing table records.

Throws:

java.lang.IllegalStateException - if method is called after resources have been cleaned up or if the manager object has no instance or database.

readTableRecords

public com.google.common.collect.ImmutableList<com.google.cloud.spanner.Struct> readTableRecords(java.lang.String tableId,
                                                                                                 java.lang.String... columnNames)
                                                                                          throws java.lang.IllegalStateException

Reads all the rows in a table. This method requires executeDdlStatement(String) to be called for the target table beforehand.

Parameters:

tableId - The id of the table to read rows from.

columnNames - The table's column names.

Returns:

A ResultSet object containing all the rows in the table.

Throws:

java.lang.IllegalStateException - if method is called after resources have been cleaned up or if the manager object has no instance or database.

readTableRecords

public com.google.common.collect.ImmutableList<com.google.cloud.spanner.Struct> readTableRecords(java.lang.String tableId,
                                                                                                 java.lang.Iterable<java.lang.String> columnNames)
                                                                                          throws java.lang.IllegalStateException

Reads all the rows in a table.This method requires executeDdlStatement(String) to be called for the target table beforehand.

Parameters:

tableId - The id of table to read rows from.

columnNames - A collection of the table's column names.

Returns:

A ResultSet object containing all the rows in the table.

Throws:

java.lang.IllegalStateException - if method is called after resources have been cleaned up or if the manager object has no instance or database.

cleanupAll

public void cleanupAll()

Deletes all created resources (instance, database, and tables) and cleans up all Spanner sessions, making the manager object unusable.

Specified by:

cleanupAll in interface org.apache.beam.it.common.ResourceManager