Class ConnectionOptions (6.80.1)

Internal connection API for Google Cloud Spanner. This class may introduce breaking changes without prior notice.

Options for creating a Connection to a Google Cloud Spanner database.

Usage:

 
 
 ConnectionOptions options = ConnectionOptions.newBuilder()
       .setUri("cloudspanner:/projects/my_project_id/instances/my_instance_id/databases/my_database_name?autocommit=false")
       .setCredentialsUrl("/home/cloudspanner-keys/my-key.json")
       .build();
 try(Connection connection = options.getConnection()) {
   try(ResultSet rs = connection.executeQuery(Statement.of("SELECT SingerId, AlbumId, MarketingBudget FROM Albums"))) {
     while(rs.next()) {
       // do something
     }
   }
 }
 
 
 

Name of the 'autocommit' connection property.

Name of the 'channelProvider' connection property.

Name of the 'credentials' connection property.

Name of the 'credentialsProvider' connection property.

Name of the 'databaseRole' connection property.

Name of the 'delay transaction start until first write' property.

Set this system property to true to enable transactional connection state by default for PostgreSQL-dialect databases. The default is currently false.

Name of the 'encodedCredentials' connection property.

Name of the 'endpoint' connection property.

Name of the 'keep transaction alive' property.

Name of the 'lenientMode' connection property.

Name of the 'maxSessions' connection property.

Name of the 'minSessions' connection property.

Name of the 'numChannels' connection property.

OAuth token to use for authentication. Cannot be used in combination with a credentials file.

Name of the 'readonly' connection property.

Name of the 'retry aborts internally' connection property.

Name of the 'routeToLeader' connection property.

Name of the 'rpcPriority' connection property.

Name of the 'trackStackTraceOfConnectionCreation' connection property.

Name of the 'trackStackTraceOfSessionCheckout' connection property.

Name of the property to enable/disable virtual threads for gRPC transport.

Name of the property to enable/disable virtual threads for the statement executor.

Deprecated. Replaced by ConnectionProperties#CONNECTION_PROPERTIES

All valid connection properties.

Closes all Spanner instances that have been opened by connections during the lifetime of this JVM. Call this method at the end of your application to free up resources. You must close all Connections that have been opened by your application before calling this method. Failing to do so, will cause this method to throw a SpannerException.

This method is also automatically called by a shutdown hook (see Runtime#addShutdownHook(Thread)) when the JVM is shutdown gracefully.

Gets the default project-id for the current environment as defined by ServiceOptions#getDefaultProjectId(), and if none could be found, the project-id of the given credentials if it contains any.

Create a Builder for ConnectionOptions. Use this method to create ConnectionOptions that can be used to obtain a Connection.

Calls the getChannelProvider() method from the supplied class.

Create a new Connection from this ConnectionOptions. Calling this method multiple times for the same ConnectionOptions will return multiple instances of Connections to the same database.

The Credentials of this ConnectionOptions. This is either the credentials specified in the credentialsUrl or the default Google application credentials

The credentials URL of this ConnectionOptions

The Spanner DatabaseId that this ConnectionOptions will connect to

The Spanner database name that this ConnectionOptions will connect to

The database role that is used for this connection. Assigning a role to a connection can be used to for example restrict the access of a connection to a specific set of tables.

The host and port number that this ConnectionOptions will connect to

The Spanner Instance ID that this ConnectionOptions will connect to

The max_commit_delay that should be applied to commit operations on this connection.

The maximum number of sessions in the backing session pool of this connection. The session pool is shared between all connections in the same JVM that connect to the same Cloud Spanner database using the same connection settings.

The minimum number of sessions in the backing session pool of this connection. The session pool is shared between all connections in the same JVM that connect to the same Cloud Spanner database using the same connection settings.

The number of channels to use for the connection.

The Google Project ID that this ConnectionOptions will connect to

The SessionPoolOptions of this ConnectionOptions.

The URI of this ConnectionOptions

Any warnings that were generated while creating the ConnectionOptions instance.

Whether connections created by this ConnectionOptions will automatically try to connect to the emulator using the default host/port of the emulator, and automatically create the instance and database that is specified in the connection string if these do not exist on the emulator instance.

The initial autocommit value for connections created by this ConnectionOptions

Whether end-to-end tracing is enabled.

The initial readonly value for connections created by this ConnectionOptions

The initial retryAbortsInternally value for connections created by this ConnectionOptions

Whether connections created by this ConnectionOptions return commit stats.

Whether read/write transactions and partitioned DML are preferred to be routed to the leader region.

Whether virtual threads should be used for gRPC transport.

Whether connections should use virtual threads for connection executors.