com.google.cloud.spanner.watcher

Interface SpannerDatabaseTailer.Builder

All Known Subinterfaces:

SpannerDatabaseTailer.TableExcluder

Enclosing class:

SpannerDatabaseTailer

public static interface SpannerDatabaseTailer.Builder

Builder for a SpannerDatabaseTailer.

Method Summary

Modifier and Type	Method and Description
SpannerDatabaseTailer	build() Creates a SpannerDatabaseTailer from this builder.
SpannerDatabaseTailer.Builder	setCommitTimestampColumnFunction(Function<TableId,String> commitTimestampFunction) This should only be set if your tables contain more than one commit timestamp column.
SpannerDatabaseTailer.Builder	setCommitTimestampRepository(CommitTimestampRepository repository) Sets a specific CommitTimestampRepository to use for the SpannerDatabaseTailer.
SpannerDatabaseTailer.Builder	setExecutor(ScheduledExecutorService executor) Sets a specific ScheduledExecutorService to use for this SpannerDatabaseTailer.
SpannerDatabaseTailer.Builder	setPollInterval(org.threeten.bp.Duration interval) Sets the poll interval to use for this SpannerDatabaseTailer.
SpannerDatabaseTailer.Builder	setShardProvider(ShardProvider shardProvider) Sets the ShardProvider that this SpannerDatabaseTailer should use for all tables that do not have a specific ShardProvider set through setShardProviders(Map).
SpannerDatabaseTailer.Builder	setShardProviders(Map<TableId,ShardProvider> shardProviders) Sets the ShardProviders to use for specific tables.

Method Detail

setCommitTimestampRepository

SpannerDatabaseTailer.Builder setCommitTimestampRepository(CommitTimestampRepository repository)

Sets a specific CommitTimestampRepository to use for the SpannerDatabaseTailer.

The default will use a SpannerCommitTimestampRepository which stores the last seen commit timestamp in a table named LAST_SEEN_COMMIT_TIMESTAMPS in the Spanner database that this SpannerDatabaseTailer is monitoring. The table will be created if it does not already exist.

setShardProvider

SpannerDatabaseTailer.Builder setShardProvider(ShardProvider shardProvider)

Sets the ShardProvider that this SpannerDatabaseTailer should use for all tables that do not have a specific ShardProvider set through setShardProviders(Map).

setShardProviders

SpannerDatabaseTailer.Builder setShardProviders(Map<TableId,ShardProvider> shardProviders)

Sets the ShardProviders to use for specific tables. Any ShardProvider that is supplied through this method will override any global ShardProvider that has been set using setShardProvider(ShardProvider).

setPollInterval

SpannerDatabaseTailer.Builder setPollInterval(org.threeten.bp.Duration interval)

Sets the poll interval to use for this SpannerDatabaseTailer. The default is 1 second.

setExecutor

SpannerDatabaseTailer.Builder setExecutor(ScheduledExecutorService executor)

Sets a specific ScheduledExecutorService to use for this SpannerDatabaseTailer. This executor will be used to execute the poll queries on the tables and to call the SpannerTableChangeWatcher.RowChangeCallbacks. The default will use a ScheduledThreadPoolExecutor with a core size equal to the number of tables that is being monitored.

setCommitTimestampColumnFunction

SpannerDatabaseTailer.Builder setCommitTimestampColumnFunction(Function<TableId,String> commitTimestampFunction)

This should only be set if your tables contain more than one commit timestamp column.

Sets a function that returns the commit timestamp column to use for a specific table. This is only needed in case your tables contain more than one commit timestamp column. SpannerDatabaseTailer can automatically find the commit timestamp column for tables that only contain one column with allow_commit_timestamp=true.

Parameters:

commitTimestampFunction - The function to use to determine which commit timestamp column should be used for a specific table. If no function has been specified, or if the function returns null for a given TableId, the SpannerDatabaseTailer will automatically use the first column of the table that has the option allow_commit_timestamp=true.

Returns:

The Builder.

build

SpannerDatabaseTailer build()

Creates a SpannerDatabaseTailer from this builder.