org.springframework.cloud.gcp.data.spanner.core

Class SpannerQueryOptions

java.lang.Object

org.springframework.cloud.gcp.data.spanner.core.AbstractSpannerRequestOptions<Options.QueryOption>

org.springframework.cloud.gcp.data.spanner.core.SpannerQueryOptions

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SpannerPageableQueryOptions

public class SpannerQueryOptions
extends AbstractSpannerRequestOptions<Options.QueryOption>

Encapsulates Cloud Spanner query options. These are options that are independent of the SQL being run.

Since:

1.1

Author:

Chengyuan Zhao, Mike Eltsufin

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.cloud.gcp.data.spanner.core.AbstractSpannerRequestOptions

requestOptions, requestOptionType

Constructor Summary

Constructors

Constructor and Description
SpannerQueryOptions() Constructor to create an instance.

Method Summary

Modifier and Type	Method and Description
SpannerQueryOptions	addQueryOption(Options.QueryOption queryOption)
Options.QueryOption[]	getQueryOptions() Deprecated. as of 1.2. Please use getOptions.
SpannerQueryOptions	setAllowPartialRead(boolean allowPartialRead)
SpannerQueryOptions	setIncludeProperties(Set<String> includeProperties)
SpannerQueryOptions	setTimestamp(com.google.cloud.Timestamp timestamp)
SpannerQueryOptions	setTimestampBound(TimestampBound timestampBound) Set if this query should be executed with bounded staleness.

Methods inherited from class org.springframework.cloud.gcp.data.spanner.core.AbstractSpannerRequestOptions

getIncludeProperties, getOptions, getTimestamp, getTimestampBound, isAllowPartialRead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpannerQueryOptions

public SpannerQueryOptions()

Constructor to create an instance. Use the extension-style add/set functions to add options and settings.

Method Detail

addQueryOption

public SpannerQueryOptions addQueryOption(Options.QueryOption queryOption)

setIncludeProperties

public SpannerQueryOptions setIncludeProperties(Set<String> includeProperties)

Overrides:

setIncludeProperties in class AbstractSpannerRequestOptions<Options.QueryOption>

setTimestampBound

public SpannerQueryOptions setTimestampBound(TimestampBound timestampBound)

Description copied from class: AbstractSpannerRequestOptions

Set if this query should be executed with bounded staleness.

Overrides:

setTimestampBound in class AbstractSpannerRequestOptions<Options.QueryOption>

Parameters:

timestampBound - the timestamp bound. Can be exact or bounded staleness.

Returns:

this options object.

setTimestamp

public SpannerQueryOptions setTimestamp(com.google.cloud.Timestamp timestamp)

Overrides:

setTimestamp in class AbstractSpannerRequestOptions<Options.QueryOption>

setAllowPartialRead

public SpannerQueryOptions setAllowPartialRead(boolean allowPartialRead)

Overrides:

setAllowPartialRead in class AbstractSpannerRequestOptions<Options.QueryOption>

getQueryOptions

@Deprecated
public Options.QueryOption[] getQueryOptions()

Deprecated. as of 1.2. Please use getOptions.

Returns:

the array of query request options.