Package com.google.cloud.spanner
Class Options
java.lang.Object
com.google.cloud.spanner.Options
- All Implemented Interfaces:
Serializable
Specifies options for various spanner operations
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Marker interface to mark options applicable to operations in admin API.static interface
Marker interface to mark options applicable to Create operations in admin API.static interface
Marker interface to mark options applicable to Create, Update and Delete operations in admin API.static interface
Marker interface to mark options applicable to Delete operations in admin API.static interface
Marker interface to mark options applicable to list operations in admin API.static interface
Marker interface to mark options applicable to query operation.static interface
Marker interface to mark options applicable to both Read and Query operationsstatic interface
Marker interface to mark options applicable to read operationstatic interface
Marker interface to mark options applicable to Read, Query, Update and Write operationsstatic enum
Priority for an RPC invocation.static interface
Marker interface to mark options applicable to write operationsstatic interface
Marker interface to mark options applicable to Update operations in admin API.static interface
Marker interface to mark options applicable to update operation. -
Method Summary
Modifier and TypeMethodDescriptionstatic Options.ReadAndQueryOption
bufferRows
(int bufferRows) static Options.TransactionOption
Specifying this instructs the transaction to requestCommitStats
from the backend.static com.google.cloud.spanner.Options.DataBoostQueryOption
dataBoostEnabled
(Boolean dataBoostEnabled) If this is for PartitionedRead or PartitionedQuery and this field is set to `true`, the request will be executed via Spanner independent compute resources.boolean
static Options.DeleteAdminApiOption
Specifying this will help in optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other.static Options.ListOption
Specifying this will cause the given filter to be applied to the list operation.int
hashCode()
static Options.ReadOption
limit
(long limit) Specifying this will cause the read to yield at most this many rows.static Options.TransactionOption
Specifying this instructs the transaction to request Optimistic Lock from the backend.static Options.ListOption
pageSize
(int pageSize) Specifying this will cause the list operations to fetch at most this many records in a page.static Options.ListOption
Specifying this will cause the list operation to start fetching the record from this onwards.static Options.ReadAndQueryOption
prefetchChunks
(int prefetchChunks) Specifying this will allow the client to prefetch up toprefetchChunks
PartialResultSet
chunks for read and query.priority
(Options.RpcPriority priority) Specifies the priority to use for the RPC.Specifying this will cause the reads, queries, updates and writes operations statistics collection to be grouped by tag.toString()
validateOnly
(Boolean validateOnly) Specifying this will not actually execute a request, and provide the same response.
-
Method Details
-
commitStats
Specifying this instructs the transaction to requestCommitStats
from the backend. -
optimisticLock
Specifying this instructs the transaction to request Optimistic Lock from the backend. In this concurrency mode, operations during the execution phase, i.e., reads and queries, are performed without acquiring locks, and transactional consistency is ensured by running a validation process in the commit phase (when any needed locks are acquired). The validation process succeeds only if there are no conflicting committed transactions (that committed mutations to the read data at a commit timestamp after the read timestamp). -
limit
Specifying this will cause the read to yield at most this many rows. This should be greater than 0. -
prefetchChunks
Specifying this will allow the client to prefetch up toprefetchChunks
PartialResultSet
chunks for 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. -
bufferRows
-
priority
Specifies the priority to use for the RPC. -
tag
Specifying this will cause the reads, queries, updates and writes operations statistics collection to be grouped by tag. -
pageSize
Specifying this will cause the list operations to fetch at most this many records in a page. -
dataBoostEnabled
public static com.google.cloud.spanner.Options.DataBoostQueryOption dataBoostEnabled(Boolean dataBoostEnabled) If this is for PartitionedRead or PartitionedQuery and this field is set to `true`, the request will be executed via Spanner independent compute resources. -
pageToken
Specifying this will cause the list operation to start fetching the record from this onwards. -
filter
Specifying this will cause the given filter to be applied to the list operation. List operations that support this options are: If this option is passed to any other list operation, it will throw an IllegalArgumentException.- Parameters:
filter
- An expression for filtering the results of the request. Filter rules are case insensitive. Some examples of using filters are:- name:* The entity has a name.
- name:Howl The entity's name contains "howl".
- name:HOWL Equivalent to above.
- NAME:howl Equivalent to above.
- labels.env:* The entity has the label env.
- labels.env:dev The entity has a label env whose value contains "dev".
- name:howl labels.env:dev The entity's name contains "howl" and it has the label env whose value contains "dev".
-
etag
Specifying this will help in optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. Operations that support this option are: -
validateOnly
Specifying this will not actually execute a request, and provide the same response. Operations that support this option are:InstanceAdminClient.createInstanceConfig(com.google.cloud.spanner.InstanceConfigInfo, com.google.cloud.spanner.Options.CreateAdminApiOption...)
InstanceAdminClient.updateInstanceConfig(com.google.cloud.spanner.InstanceConfigInfo, java.lang.Iterable<com.google.cloud.spanner.InstanceConfigInfo.InstanceConfigField>, com.google.cloud.spanner.Options.UpdateAdminApiOption...)
InstanceAdminClient.deleteInstanceConfig(java.lang.String, com.google.cloud.spanner.Options.DeleteAdminApiOption...)
-
toString
-
equals
-
hashCode
public int hashCode()
-