Package org.apache.beam.sdk.io.gcp.spanner

Class SpannerIO.ReadAll

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<ReadOperation>,PCollection<Struct>>

org.apache.beam.sdk.io.gcp.spanner.SpannerIO.ReadAll

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

SpannerIO

public abstract static class SpannerIO.ReadAll
extends PTransform<PCollection<ReadOperation>,PCollection<Struct>>

Implementation of SpannerIO.readAll().

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor	Description
ReadAll()

Method Summary

Modifier and Type	Method	Description
PCollection<Struct>	expand(PCollection<ReadOperation> input)	Override this method to specify how this PTransform should be expanded on the given InputT.
SpannerIO.ReadAll	withBatching(boolean batching)	By default the PartitionQuery API is used to read data from Cloud Spanner.
SpannerIO.ReadAll	withDatabaseId(String databaseId)	Specifies the Cloud Spanner database.
SpannerIO.ReadAll	withDatabaseId(ValueProvider<String> databaseId)	Specifies the Cloud Spanner database.
SpannerIO.ReadAll	withEmulatorHost(String emulatorHost)
SpannerIO.ReadAll	withEmulatorHost(ValueProvider<String> emulatorHost)	Specifies the Cloud Spanner emulator host.
SpannerIO.ReadAll	withExperimentalHost(String experimentalHost)
SpannerIO.ReadAll	withExperimentalHost(ValueProvider<String> experimentalHost)	Specifies the SpannerOptions experimental host (setExperimentalHost).
SpannerIO.ReadAll	withHighPriority()
SpannerIO.ReadAll	withHost(String host)
SpannerIO.ReadAll	withHost(ValueProvider<String> host)	Specifies the Cloud Spanner host.
SpannerIO.ReadAll	withInstanceId(String instanceId)	Specifies the Cloud Spanner instance.
SpannerIO.ReadAll	withInstanceId(ValueProvider<String> instanceId)	Specifies the Cloud Spanner instance.
SpannerIO.ReadAll	withLowPriority()
SpannerIO.ReadAll	withProjectId(String projectId)	Specifies the Cloud Spanner project.
SpannerIO.ReadAll	withProjectId(ValueProvider<String> projectId)	Specifies the Cloud Spanner project.
SpannerIO.ReadAll	withSpannerConfig(SpannerConfig spannerConfig)	Specifies the Cloud Spanner configuration.
SpannerIO.ReadAll	withTimestamp(com.google.cloud.Timestamp timestamp)
SpannerIO.ReadAll	withTimestampBound(TimestampBound timestampBound)
SpannerIO.ReadAll	withTransaction(PCollectionView<Transaction> transaction)
SpannerIO.ReadAll	withUsingPlainTextChannel(boolean plainText)	Specifies whether to use plaintext channel.
SpannerIO.ReadAll	withUsingPlainTextChannel(ValueProvider<Boolean> plainText)	Specifies whether to use plaintext channel.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Details

ReadAll

public ReadAll()

Method Details

withSpannerConfig

public SpannerIO.ReadAll withSpannerConfig(SpannerConfig spannerConfig)

Specifies the Cloud Spanner configuration.

withProjectId

public SpannerIO.ReadAll withProjectId(String projectId)

Specifies the Cloud Spanner project.

withProjectId

public SpannerIO.ReadAll withProjectId(ValueProvider<String> projectId)

Specifies the Cloud Spanner project.

withInstanceId

public SpannerIO.ReadAll withInstanceId(String instanceId)

Specifies the Cloud Spanner instance.

withInstanceId

public SpannerIO.ReadAll withInstanceId(ValueProvider<String> instanceId)

Specifies the Cloud Spanner instance.

withDatabaseId

public SpannerIO.ReadAll withDatabaseId(String databaseId)

Specifies the Cloud Spanner database.

withHost

public SpannerIO.ReadAll withHost(ValueProvider<String> host)

Specifies the Cloud Spanner host.

withHost

public SpannerIO.ReadAll withHost(String host)

withEmulatorHost

public SpannerIO.ReadAll withEmulatorHost(ValueProvider<String> emulatorHost)

Specifies the Cloud Spanner emulator host.

withEmulatorHost

public SpannerIO.ReadAll withEmulatorHost(String emulatorHost)

withExperimentalHost

public SpannerIO.ReadAll withExperimentalHost(ValueProvider<String> experimentalHost)

Specifies the SpannerOptions experimental host (setExperimentalHost).

withExperimentalHost

public SpannerIO.ReadAll withExperimentalHost(String experimentalHost)

withUsingPlainTextChannel

public SpannerIO.ReadAll withUsingPlainTextChannel(ValueProvider<Boolean> plainText)

Specifies whether to use plaintext channel.

Note: This parameter is only valid when using an experimental host (set via withExperimentalHost).

withUsingPlainTextChannel

public SpannerIO.ReadAll withUsingPlainTextChannel(boolean plainText)

Specifies whether to use plaintext channel.

Note: This parameter is only valid when using an experimental host (set via withExperimentalHost).

withDatabaseId

public SpannerIO.ReadAll withDatabaseId(ValueProvider<String> databaseId)

Specifies the Cloud Spanner database.

withTransaction

public SpannerIO.ReadAll withTransaction(PCollectionView<Transaction> transaction)

withTimestamp

public SpannerIO.ReadAll withTimestamp(com.google.cloud.Timestamp timestamp)

withTimestampBound

public SpannerIO.ReadAll withTimestampBound(TimestampBound timestampBound)

withBatching

public SpannerIO.ReadAll withBatching(boolean batching)

By default the PartitionQuery API is used to read data from Cloud Spanner. It is useful to disable batching when the underlying query is not root-partitionable.

withLowPriority

public SpannerIO.ReadAll withLowPriority()

withHighPriority

public SpannerIO.ReadAll withHighPriority()

expand

public PCollection<Struct> expand(PCollection<ReadOperation> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<ReadOperation>,PCollection<Struct>>