Class RemoteSpannerHelper

public class RemoteSpannerHelper

Utility that provides access to a Cloud Spanner instance to use for tests, and allows uniquely named test databases to be created within that instance.

Inheritance

java.lang.Object > RemoteSpannerHelper

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

RemoteSpannerHelper(SpannerOptions options, InstanceId instanceId, Spanner client)

protected RemoteSpannerHelper(SpannerOptions options, InstanceId instanceId, Spanner client)

Parameters

Name	Description
options	`SpannerOptions`
instanceId	`InstanceId`
client	`Spanner`

Methods

cleanUp()

public void cleanUp()

Deletes all the databases created via createTestDatabase. Shuts down the client.

create(InstanceId instanceId)

public static RemoteSpannerHelper create(InstanceId instanceId)

Creates a RemoteSpannerHelper bound to the given instance ID. All databases created using this will be created in the given instance.

Parameter

Name	Description
instanceId	`InstanceId`

Returns

Type	Description
RemoteSpannerHelper

create(SpannerOptions options, InstanceId instanceId)

public static RemoteSpannerHelper create(SpannerOptions options, InstanceId instanceId)

Creates a RemoteSpannerHelper for the given option and bound to the given instance ID. All databases created using this will be created in the given instance.

Parameters

Name	Description
options	`SpannerOptions`
instanceId	`InstanceId`

Returns

Type	Description
RemoteSpannerHelper

createTestDatabase(Iterable<String> statements)

public Database createTestDatabase(Iterable<String> statements)

Creates a test database defined by statements in the test instance. A CREATE DATABASE ... statement should not be included; an appropriate name will be chosen and the statement generated accordingly.

Parameter

Name	Description
statements	`Iterable<String>`

Returns

Type	Description
Database

Exceptions

Type	Description
SpannerException

createTestDatabase(String[] statements)

public Database createTestDatabase(String[] statements)

Creates a test database defined by statements. A CREATE DATABASE ... statement should not be included; an appropriate name will be chosen and the statement generated accordingly.

Parameter

Name	Description
statements	`String[]`

Returns

Type	Description
Database

Exceptions

Type	Description
SpannerException

getBatchClient(Database db)

public BatchClient getBatchClient(Database db)

Parameter

Name	Description
db	`Database`

Returns

Type	Description
BatchClient

getClient()

public Spanner getClient()

Returns

Type	Description
Spanner

getDatabaseClient(Database db)

public DatabaseClient getDatabaseClient(Database db)

Parameter

Name	Description
db	`Database`

Returns

Type	Description
DatabaseClient

getInstanceId()

public InstanceId getInstanceId()

Returns

Type	Description
InstanceId

getOptions()

public SpannerOptions getOptions()

Returns

Type	Description
SpannerOptions

getUniqueBackupId()

public String getUniqueBackupId()

Returns a backup id which is guaranteed to be unique within the context of this environment.

Returns

Type	Description
String

getUniqueDatabaseId()

public String getUniqueDatabaseId()

Returns a database id which is guaranteed to be unique within the context of this environment.

Returns

Type	Description
String

isEmulator() (deprecated)

public boolean isEmulator()

(deprecated) use EmulatorSpannerHelper#isUsingEmulator() instead.

Checks whether the emulator is being used.

Returns

Type	Description
boolean	true if the emulator is being used. Returns false otherwise.