Package com.google.cloud.spanner.admin.database.v1

The interfaces provided are listed below, along with usage samples.

DatabaseAdminClient

Service Description: Cloud Spanner Database Admin API

The Cloud Spanner Database Admin API can be used to: * create, drop, and list databases * update the schema of pre-existing databases * create, delete and list backups for a database * restore a database from an existing backup

Sample for DatabaseAdminClient:


 try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Database response = databaseAdminClient.getDatabase(name);
 }

Classes

DatabaseAdminClient

Service Description: Cloud Spanner Database Admin API

The Cloud Spanner Database Admin API can be used to: * create, drop, and list databases * update the schema of pre-existing databases * create, delete and list backups for a database * restore a database from an existing backup

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
   Database response = databaseAdminClient.getDatabase(name);
 }

Note: close() needs to be called on the DatabaseAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DatabaseAdminSettings to create(). For example:

To customize credentials:


 DatabaseAdminSettings databaseAdminSettings =
     DatabaseAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create(databaseAdminSettings);

To customize the endpoint:


 DatabaseAdminSettings databaseAdminSettings =
     DatabaseAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create(databaseAdminSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DatabaseAdminClient.ListBackupOperationsFixedSizeCollection

DatabaseAdminClient.ListBackupOperationsPage

DatabaseAdminClient.ListBackupOperationsPagedResponse

DatabaseAdminClient.ListBackupsFixedSizeCollection

DatabaseAdminClient.ListBackupsPage

DatabaseAdminClient.ListBackupsPagedResponse

DatabaseAdminClient.ListDatabaseOperationsFixedSizeCollection

DatabaseAdminClient.ListDatabaseOperationsPage

DatabaseAdminClient.ListDatabaseOperationsPagedResponse

DatabaseAdminClient.ListDatabasesFixedSizeCollection

DatabaseAdminClient.ListDatabasesPage

DatabaseAdminClient.ListDatabasesPagedResponse

DatabaseAdminSettings

Settings class to configure an instance of DatabaseAdminClient.

The default instance has everything set to sensible defaults:

  • The default service address (spanner.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getDatabase to 30 seconds:


 DatabaseAdminSettings.Builder databaseAdminSettingsBuilder = DatabaseAdminSettings.newBuilder();
 databaseAdminSettingsBuilder
     .getDatabaseSettings()
     .setRetrySettings(
         databaseAdminSettingsBuilder
             .getDatabaseSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DatabaseAdminSettings databaseAdminSettings = databaseAdminSettingsBuilder.build();

DatabaseAdminSettings.Builder

Builder for DatabaseAdminSettings.