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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Class RemoteSpannerHelper (6.98.1)\n\nVersion latestkeyboard_arrow_down\n\n- [6.98.1 (latest)](/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.98.0](/java/docs/reference/google-cloud-spanner/6.98.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.97.1](/java/docs/reference/google-cloud-spanner/6.97.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.96.1](/java/docs/reference/google-cloud-spanner/6.96.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.95.1](/java/docs/reference/google-cloud-spanner/6.95.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.94.0](/java/docs/reference/google-cloud-spanner/6.94.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.93.0](/java/docs/reference/google-cloud-spanner/6.93.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.89.0](/java/docs/reference/google-cloud-spanner/6.89.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.88.0](/java/docs/reference/google-cloud-spanner/6.88.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.87.0](/java/docs/reference/google-cloud-spanner/6.87.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.86.0](/java/docs/reference/google-cloud-spanner/6.86.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.85.0](/java/docs/reference/google-cloud-spanner/6.85.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.83.0](/java/docs/reference/google-cloud-spanner/6.83.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.82.0](/java/docs/reference/google-cloud-spanner/6.82.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.80.1](/java/docs/reference/google-cloud-spanner/6.80.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.79.0](/java/docs/reference/google-cloud-spanner/6.79.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.77.0](/java/docs/reference/google-cloud-spanner/6.77.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.74.1](/java/docs/reference/google-cloud-spanner/6.74.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.72.0](/java/docs/reference/google-cloud-spanner/6.72.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.71.0](/java/docs/reference/google-cloud-spanner/6.71.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.69.0](/java/docs/reference/google-cloud-spanner/6.69.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.68.0](/java/docs/reference/google-cloud-spanner/6.68.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.66.0](/java/docs/reference/google-cloud-spanner/6.66.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.65.1](/java/docs/reference/google-cloud-spanner/6.65.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.62.0](/java/docs/reference/google-cloud-spanner/6.62.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.60.0](/java/docs/reference/google-cloud-spanner/6.60.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.58.0](/java/docs/reference/google-cloud-spanner/6.58.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.57.0](/java/docs/reference/google-cloud-spanner/6.57.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.56.0](/java/docs/reference/google-cloud-spanner/6.56.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.55.0](/java/docs/reference/google-cloud-spanner/6.55.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.54.0](/java/docs/reference/google-cloud-spanner/6.54.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.53.0](/java/docs/reference/google-cloud-spanner/6.53.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.52.1](/java/docs/reference/google-cloud-spanner/6.52.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.51.0](/java/docs/reference/google-cloud-spanner/6.51.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.50.1](/java/docs/reference/google-cloud-spanner/6.50.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.49.0](/java/docs/reference/google-cloud-spanner/6.49.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.25.1](/java/docs/reference/google-cloud-spanner/6.25.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.24.0](/java/docs/reference/google-cloud-spanner/6.24.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.23.4](/java/docs/reference/google-cloud-spanner/6.23.4/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.22.0](/java/docs/reference/google-cloud-spanner/6.22.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.21.2](/java/docs/reference/google-cloud-spanner/6.21.2/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.20.0](/java/docs/reference/google-cloud-spanner/6.20.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.19.1](/java/docs/reference/google-cloud-spanner/6.19.1/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.18.0](/java/docs/reference/google-cloud-spanner/6.18.0/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.17.4](/java/docs/reference/google-cloud-spanner/6.17.4/com.google.cloud.spanner.testing.RemoteSpannerHelper)\n- [6.14.1](/java/docs/reference/google-cloud-spanner/6.14.1/com.google.cloud.spanner.testing.RemoteSpannerHelper) \n\n public class RemoteSpannerHelper\n\nUtility that provides access to a Cloud Spanner instance to use for tests, and allows uniquely\nnamed test databases to be created within that instance. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e RemoteSpannerHelper \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nStatic Methods\n--------------\n\n### create(InstanceId instanceId)\n\n public static RemoteSpannerHelper create(InstanceId instanceId)\n\nCreates a `RemoteSpannerHelper` bound to the given instance ID. All databases created\nusing this will be created in the given instance.\n\n### create(SpannerOptions options, InstanceId instanceId)\n\n public static RemoteSpannerHelper create(SpannerOptions options, InstanceId instanceId)\n\nCreates a `RemoteSpannerHelper` for the given option and bound to the given instance ID.\nAll databases created using this will be created in the given instance.\n\nConstructors\n------------\n\n### RemoteSpannerHelper(SpannerOptions options, InstanceId instanceId, Spanner client)\n\n protected RemoteSpannerHelper(SpannerOptions options, InstanceId instanceId, Spanner client)\n\nMethods\n-------\n\n### cleanUp()\n\n public void cleanUp()\n\nDeletes all the databases created via `createTestDatabase`. Shuts down the client.\n\n### createTestDatabase(Dialect dialect, Iterable\\\u003cString\\\u003e statements)\n\n public Database createTestDatabase(Dialect dialect, Iterable\u003cString\u003e statements)\n\nCreates a test database defined by `statements` in the test instance. A `CREATE\nDATABASE ...` statement should not be included; an appropriate name will be chosen and the\nstatement generated accordingly.\n\n### createTestDatabase(Iterable\\\u003cString\\\u003e statements)\n\n public Database createTestDatabase(Iterable\u003cString\u003e statements)\n\n### createTestDatabase(String\\[\\] statements)\n\n public Database createTestDatabase(String[] statements)\n\nCreates a test database defined by `statements`. A `CREATE DATABASE ...` statement\nshould not be included; an appropriate name will be chosen and the statement generated\naccordingly.\n\n### getBatchClient(Database db)\n\n public BatchClient getBatchClient(Database db)\n\n### getClient()\n\n public Spanner getClient()\n\n### getDatabaseClient(Database db)\n\n public DatabaseClient getDatabaseClient(Database db)\n\n### getInstanceId()\n\n public InstanceId getInstanceId()\n\n### getOptions()\n\n public SpannerOptions getOptions()\n\n### getUniqueBackupId()\n\n public String getUniqueBackupId()\n\nReturns a backup id which is guaranteed to be unique within the context of this environment.\n\n### getUniqueDatabaseId()\n\n public String getUniqueDatabaseId()\n\nReturns a database id which is guaranteed to be unique within the context of this environment.\n\n### getUniqueDatabaseRole()\n\n public String getUniqueDatabaseRole()\n\nReturns a database role name which is guaranteed to be unique within the context of this\nenvironment.\n\n### isEmulator() (deprecated)\n\n public boolean isEmulator()\n\n**Deprecated.** *use [EmulatorSpannerHelper#isUsingEmulator()](/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.testing.EmulatorSpannerHelper#com_google_cloud_spanner_testing_EmulatorSpannerHelper_isUsingEmulator__) instead.*\n\nChecks whether the emulator is being used."]]
