Package com.google.cloud.spanner

Class SpannerOptions.Builder

java.lang.Object
com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>
com.google.cloud.spanner.SpannerOptions.Builder
Enclosing class:
SpannerOptions
public static class SpannerOptions.Builder extends com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>
Builder for SpannerOptions instances.

  • Constructor Details

    • Builder

      protected Builder()

  • Method Details

    • setTransportOptions

      public SpannerOptions.Builder setTransportOptions(com.google.cloud.TransportOptions transportOptions)
      Overrides:
      setTransportOptions in class com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

    • getAllowedClientLibTokens

      protected Set<String> getAllowedClientLibTokens()
      Overrides:
      getAllowedClientLibTokens in class com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

    • setClientLibToken

      @InternalApi public SpannerOptions.Builder setClientLibToken(String clientLibToken)
      Overrides:
      setClientLibToken in class com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

    • setChannelProvider

      public SpannerOptions.Builder setChannelProvider(com.google.api.gax.rpc.TransportChannelProvider channelProvider)
      Sets the ChannelProvider. GapicSpannerRpc would create a default one if none is provided.

      Setting a custom TransportChannelProvider also overrides any other settings that affect the default channel provider. These must be set manually on the custom TransportChannelProvider instead of on SpannerOptions. The settings of SpannerOptions that have no effect if you set a custom TransportChannelProvider are:

      1. setChannelConfigurator(ApiFunction)
      2. setHost(String)
      3. setNumChannels(int)
      4. setInterceptorProvider(GrpcInterceptorProvider)
      5. ServiceOptions.Builder.setHeaderProvider(com.google.api.gax.rpc.HeaderProvider)

    • setChannelConfigurator

      public SpannerOptions.Builder setChannelConfigurator(com.google.api.core.ApiFunction<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder> channelConfigurator)
      Sets an ApiFunction that will be used to configure the transport channel. This will only be used if no custom TransportChannelProvider has been set.

    • setInterceptorProvider

      public SpannerOptions.Builder setInterceptorProvider(com.google.api.gax.grpc.GrpcInterceptorProvider interceptorProvider)
      Sets the GrpcInterceptorProvider. GapicSpannerRpc would create a default one if none is provided.

    • setNumChannels

      public SpannerOptions.Builder setNumChannels(int numChannels)
      Sets the number of gRPC channels to use. By default 4 channels are created per SpannerOptions.

    • setSessionPoolOption

      public SpannerOptions.Builder setSessionPoolOption(SessionPoolOptions sessionPoolOptions)
      Sets the options for managing the session pool. If not specified then the default SessionPoolOptions is used.

    • setDatabaseRole

      public SpannerOptions.Builder setDatabaseRole(String databaseRole)
      Sets the database role that should be used for connections that are created by this instance. The database role that is used determines the access permissions that a connection has. This can for example be used to create connections that are only permitted to access certain tables.

    • setSessionLabels

      public SpannerOptions.Builder setSessionLabels(Map<String,String> sessionLabels)
      Sets the labels to add to all Sessions created in this client.
      Parameters:
      sessionLabels - Map from label key to label value. Label key and value cannot be null. For more information on valid syntax see api docs .

    • setRetrySettings

      public SpannerOptions.Builder setRetrySettings(com.google.api.gax.retrying.RetrySettings retrySettings)
      SpannerOptions.Builder does not support global retry settings, as it creates three different gRPC clients: Spanner, DatabaseAdminClient and InstanceAdminClient. Instead of calling this method, you should set specific RetrySettings for each of the underlying gRPC clients by calling respectively getSpannerStubSettingsBuilder(), getDatabaseAdminStubSettingsBuilder() or getInstanceAdminStubSettingsBuilder().
      Overrides:
      setRetrySettings in class com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

    • getSpannerStubSettingsBuilder

      public SpannerStubSettings.Builder getSpannerStubSettingsBuilder()
      Returns the SpannerStubSettings.Builder that will be used to build the SpannerRpc. Use this to set custom RetrySettings for individual gRPC methods.

      The library will automatically use the defaults defined in SpannerStubSettings if no custom settings are set. The defaults are the same as the defaults that are used by SpannerSettings, and are generated from the file spanner_gapic.yaml. Retries are configured for idempotent methods but not for non-idempotent methods.

      You can set the same RetrySettings for all unary methods by calling this: 

      
 builder
     .getSpannerStubSettingsBuilder()
     .applyToAllUnaryMethods(
         new ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>() {
           public Void apply(Builder<?, ?> input) {
             input.setRetrySettings(retrySettings);
             return null;
           }
         });

    • getInstanceAdminStubSettingsBuilder

      public InstanceAdminStubSettings.Builder getInstanceAdminStubSettingsBuilder()
      Returns the InstanceAdminStubSettings.Builder that will be used to build the SpannerRpc. Use this to set custom RetrySettings for individual gRPC methods.

      The library will automatically use the defaults defined in InstanceAdminStubSettings if no custom settings are set. The defaults are the same as the defaults that are used by InstanceAdminSettings, and are generated from the file spanner_admin_instance_gapic.yaml. Retries are configured for idempotent methods but not for non-idempotent methods.

      You can set the same RetrySettings for all unary methods by calling this: 

      
 builder
     .getInstanceAdminStubSettingsBuilder()
     .applyToAllUnaryMethods(
         new ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>() {
           public Void apply(Builder<?, ?> input) {
             input.setRetrySettings(retrySettings);
             return null;
           }
         });

    • getDatabaseAdminStubSettingsBuilder

      public DatabaseAdminStubSettings.Builder getDatabaseAdminStubSettingsBuilder()
      Returns the DatabaseAdminStubSettings.Builder that will be used to build the SpannerRpc. Use this to set custom RetrySettings for individual gRPC methods.

      The library will automatically use the defaults defined in DatabaseAdminStubSettings if no custom settings are set. The defaults are the same as the defaults that are used by DatabaseAdminSettings, and are generated from the file spanner_admin_database_gapic.yaml. Retries are configured for idempotent methods but not for non-idempotent methods.

      You can set the same RetrySettings for all unary methods by calling this: 

      
 builder
     .getDatabaseAdminStubSettingsBuilder()
     .applyToAllUnaryMethods(
         new ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>() {
           public Void apply(Builder<?, ?> input) {
             input.setRetrySettings(retrySettings);
             return null;
           }
         });

    • setPartitionedDmlTimeout

      public SpannerOptions.Builder setPartitionedDmlTimeout(org.threeten.bp.Duration timeout)
      Sets a timeout specifically for Partitioned DML statements executed through DatabaseClient.executePartitionedUpdate(Statement, UpdateOption...). The default is 2 hours.

    • setAutoThrottleAdministrativeRequests

      public SpannerOptions.Builder setAutoThrottleAdministrativeRequests()
      Instructs the client library to automatically throttle the number of administrative requests if the rate of administrative requests generated by this Spanner instance will exceed the administrative limits Cloud Spanner. The default behavior is to not throttle any requests. If the limit is exceeded, Cloud Spanner will return a RESOURCE_EXHAUSTED error. More information on the administrative limits can be found here: https://cloud.google.com/spanner/quotas#administrative_limits. Setting this option is not a guarantee that the rate will never be exceeded, as this option will only throttle requests coming from this client. Additional requests from other clients could still cause the limit to be exceeded.

    • disableAdministrativeRequestRetries

      public SpannerOptions.Builder disableAdministrativeRequestRetries()
      Disables automatic retries of administrative requests that fail if the https://cloud.google.com/spanner/quotas#administrative_limits have been exceeded. You should disable these retries if you intend to handle these errors in your application.

    • setTrackTransactionStarter

      public SpannerOptions.Builder setTrackTransactionStarter()
      Instructs the client library to track the first request of each read/write transaction. This statement will include a BeginTransaction option and will return a transaction id as part of its result. All other statements in the same transaction must wait for this first statement to finish before they can proceed. By setting this option the client library will throw a SpannerException with ErrorCode.DEADLINE_EXCEEDED for any subsequent statement that has waited for at least 60 seconds for the first statement to return a transaction id, including the stacktrace of the initial statement that should have returned a transaction id.

    • setDefaultQueryOptions

      public SpannerOptions.Builder setDefaultQueryOptions(DatabaseId database, ExecuteSqlRequest.QueryOptions defaultQueryOptions)
      Sets the default ExecuteSqlRequest.QueryOptions that will be used for all queries on the specified database. Query options can also be specified on a per-query basis and as environment variables. The precedence of these settings are:
      1. Query options for a specific query
      2. Environment variables
      3. These default query options
      Each Options.QueryOption value that is used for a query is determined individually based on the above precedence. If for example a value for ExecuteSqlRequest.QueryOptions.getOptimizerVersion() is specified in an environment variable and a value for ExecuteSqlRequest.QueryOptions.getOptimizerStatisticsPackage() is specified for a specific query, both values will be used for the specific query. Environment variables are only read during the initialization of a SpannerOptions instance. Changing an environment variable after initializing a SpannerOptions instance will not have any effect on that instance.

    • setCallCredentialsProvider

      public SpannerOptions.Builder setCallCredentialsProvider(SpannerOptions.CallCredentialsProvider callCredentialsProvider)
      Sets a SpannerOptions.CallCredentialsProvider that can deliver CallCredentials to use on a per-gRPC basis.

    • setCompressorName

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/1704") public SpannerOptions.Builder setCompressorName(@Nullable String compressorName)
      Sets the compression to use for all gRPC calls. The compressor must be a valid name known in the CompressorRegistry. This will enable compression both from the client to the server and from the server to the client.

      Supported values are:

      • gzip: Enable gzip compression
      • identity: Disable compression
      • null: Use default compression

    • setAsyncExecutorProvider

      public SpannerOptions.Builder setAsyncExecutorProvider(SpannerOptions.CloseableExecutorProvider provider)
      Sets the ExecutorProvider to use for high-level async calls that need an executor, such as fetching results for an AsyncResultSet.

      Async methods will use a sensible default if no custom ExecutorProvider has been set. The default ExecutorProvider uses a cached thread pool containing a maximum of 8 threads. The pool is lazily initialized and will not create any threads if the user application does not use any async methods. It will also scale down the thread usage if the async load allows for that.

      Call SpannerOptions.createAsyncExecutorProvider(int, long, TimeUnit) to create a provider with a custom pool size or call SpannerOptions.FixedCloseableExecutorProvider.create(ScheduledExecutorService) to create a SpannerOptions.CloseableExecutorProvider from a standard Java ScheduledExecutorService.

    • setDirectedReadOptions

      public SpannerOptions.Builder setDirectedReadOptions(DirectedReadOptions directedReadOptions)
      Sets the Options.DirectedReadOption that specify which replicas or regions should be used for non-transactional reads or queries.

      DirectedReadOptions set at the request level will take precedence over the options set using this method.

      An example below of how DirectedReadOptions can be constructed by including a replica. 

      
 DirectedReadOptions.newBuilder()
           .setIncludeReplicas(
               IncludeReplicas.newBuilder()
                   .addReplicaSelections(
                       ReplicaSelection.newBuilder().setLocation("us-east1").build()))
           .build();
           }

    • setPrefetchChunks

      public SpannerOptions.Builder setPrefetchChunks(int prefetchChunks)
      Specifying this will allow the client to prefetch up to prefetchChunks PartialResultSet chunks for each read and query. The data size of each chunk depends on the server implementation but a good rule of thumb is that each chunk will be up to 1 MiB. Larger values reduce the likelihood of blocking while consuming results at the cost of greater memory consumption. prefetchChunks should be greater than 0. To get good performance choose a value that is large enough to allow buffering of chunks for an entire row. Apart from the buffered chunks, there can be at most one more row buffered in the client. This can be overridden on a per read/query basis by Options.prefetchChunks(). If unspecified, we will use a default value (currently 4).

    • setDecodeMode

      public SpannerOptions.Builder setDecodeMode(DecodeMode decodeMode)
      Specifies how values that are returned from a query should be decoded and converted from protobuf values into plain Java objects.

    • setHost

      public SpannerOptions.Builder setHost(String host)
      Overrides:
      setHost in class com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

    • enableGrpcGcpExtension

      public SpannerOptions.Builder enableGrpcGcpExtension()
      Enables gRPC-GCP extension with the default settings. Do not set GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS to true in combination with this option, as Multiplexed sessions are not supported for gRPC-GCP.

    • enableGrpcGcpExtension

      public SpannerOptions.Builder enableGrpcGcpExtension(com.google.cloud.grpc.GcpManagedChannelOptions options)
      Enables gRPC-GCP extension and uses provided options for configuration. The metric registry and default Spanner metric labels will be added automatically. Do not set GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS to true in combination with this option, as Multiplexed sessions are not supported for gRPC-GCP.

    • disableGrpcGcpExtension

      public SpannerOptions.Builder disableGrpcGcpExtension()
      Disables gRPC-GCP extension.

    • setEmulatorHost

      public SpannerOptions.Builder setEmulatorHost(String emulatorHost)
      Sets the host of an emulator to use. By default the value is read from an environment variable. If the environment variable is not set, this will be null.

    • setOpenTelemetry

      public SpannerOptions.Builder setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)
      Sets OpenTelemetry object to be used for Spanner Metrics and Traces. GlobalOpenTelemetry will be used as fallback if this options is not set.

    • enableLeaderAwareRouting

      public SpannerOptions.Builder enableLeaderAwareRouting()
      Enable leader aware routing. Leader aware routing would route all requests in RW/PDML transactions to the leader region.

    • disableLeaderAwareRouting

      public SpannerOptions.Builder disableLeaderAwareRouting()
      Disable leader aware routing. Disabling leader aware routing would route all requests in RW/PDML transactions to any region.

    • disableDirectPath

      @BetaApi public SpannerOptions.Builder disableDirectPath()

    • setUseVirtualThreads

      @BetaApi protected SpannerOptions.Builder setUseVirtualThreads(boolean useVirtualThreads)
      Enables/disables the use of virtual threads for the gRPC executor. Setting this option only has any effect on Java 21 and higher. In all other cases, the option will be ignored.

    • setEnableApiTracing

      public SpannerOptions.Builder setEnableApiTracing(boolean enableApiTracing)
      Creates and sets an ApiTracer for the RPCs that are executed by this client. Enabling this creates traces for each individual RPC execution, including events/annotations when an RPC is retried or fails. The traces are only exported if an OpenTelemetry or OpenCensus trace exporter has been configured for the client.

    • setEnableExtendedTracing

      public SpannerOptions.Builder setEnableExtendedTracing(boolean enableExtendedTracing)
      Sets whether to enable extended OpenTelemetry tracing. Enabling this option will add the following additional attributes to the traces that are generated by the client:
      • db.statement: Contains the SQL statement that is being executed.
      • thread.name: The name of the thread that executes the statement.

    • build

      public SpannerOptions build()
      Specified by:
      build in class com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>