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

Class SpannerTemplate

java.lang.Object

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

All Implemented Interfaces:

SpannerOperations

public class SpannerTemplate
extends Object
implements SpannerOperations

Author:

Ray Tsang, Chengyuan Zhao

Constructor Summary

Constructors

Constructor and Description
SpannerTemplate(com.google.cloud.spanner.DatabaseClient databaseClient, SpannerMappingContext mappingContext, SpannerEntityProcessor spannerEntityProcessor, SpannerMutationFactory spannerMutationFactory)

Method Summary

Modifier and Type	Method and Description
protected <T,U> void	applyMutationTwoArgs(BiFunction<T,U,com.google.cloud.spanner.Mutation> function, T arg1, U arg2)
<T> String	applySortingPagingQueryOptions(Class<T> entityClass, SpannerQueryOptions options, String sql)
long	count(Class entityClass) Count how many objects are stored of the given type.
<T> void	delete(Class<T> entityClass, Iterable<? extends T> entities) Deletes multiple objects from storage.
void	delete(Class entityClass, com.google.cloud.spanner.Key key) Deletes an object based on a key.
void	delete(Class entityClass, com.google.cloud.spanner.KeySet keys) Deletes objects given a set of keys.
void	delete(Object entity) Deletes an object from storage.
com.google.cloud.spanner.ResultSet	executeQuery(com.google.cloud.spanner.Statement statement, SpannerQueryOptions options)
SpannerMappingContext	getMappingContext()
protected com.google.cloud.spanner.ReadContext	getReadContext()
protected com.google.cloud.spanner.ReadContext	getReadContext(com.google.cloud.Timestamp timestamp)
SpannerEntityProcessor	getSpannerEntityProcessor()
void	insert(Object object) Insert an object into storage.
<T> T	performReadOnlyTransaction(Function<SpannerTemplate,T> operations, SpannerReadOptions readOptions) Performs multiple read-only operations in a single transaction.
<T> T	performReadWriteTransaction(Function<SpannerTemplate,T> operations) Performs multiple read and write operations in a single transaction.
<T> List<T>	query(Class<T> entityClass, com.google.cloud.spanner.Statement statement) Finds objects by using an SQL statement.
<T> List<T>	query(Class<T> entityClass, String sql, List<String> tags, Object[] params, SpannerQueryOptions options) Finds objects by using an SQL statement.
<T> List<T>	queryAll(Class<T> entityClass, SpannerQueryOptions options) Finds all objects of the given type.
<T> T	read(Class<T> entityClass, com.google.cloud.spanner.Key key) Finds a single stored object using a key.
<T> List<T>	read(Class<T> entityClass, com.google.cloud.spanner.KeySet keys) Finds objects stored from their keys.
<T> List<T>	read(Class<T> entityClass, com.google.cloud.spanner.KeySet keys, SpannerReadOptions options) Finds objects stored from their keys.
<T> T	read(Class<T> entityClass, com.google.cloud.spanner.Key key, SpannerReadOptions options) Finds a single stored object using a key.
<T> List<T>	readAll(Class<T> entityClass) Finds all objects of the given type.
<T> List<T>	readAll(Class<T> entityClass, SpannerReadOptions options) Finds all objects of the given type.
void	update(Object object) Update an object already in storage.
void	update(Object object, Optional<Set<String>> includeColumns) Update an object in storage.
void	update(Object object, String... includeColumns) Update an object in storage.
void	upsert(Object object) Update or insert an object into storage.
void	upsert(Object object, Optional<Set<String>> includeColumns) Update or insert an object into storage.
void	upsert(Object object, String... includeColumns) Update or insert an object into storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpannerTemplate

public SpannerTemplate(com.google.cloud.spanner.DatabaseClient databaseClient,
                       SpannerMappingContext mappingContext,
                       SpannerEntityProcessor spannerEntityProcessor,
                       SpannerMutationFactory spannerMutationFactory)

Method Detail

getReadContext

protected com.google.cloud.spanner.ReadContext getReadContext()

getReadContext

protected com.google.cloud.spanner.ReadContext getReadContext(com.google.cloud.Timestamp timestamp)

getMappingContext

public SpannerMappingContext getMappingContext()

getSpannerEntityProcessor

public SpannerEntityProcessor getSpannerEntityProcessor()

read

public <T> T read(Class<T> entityClass,
                  com.google.cloud.spanner.Key key)

Description copied from interface: SpannerOperations

Finds a single stored object using a key.

Specified by:

read in interface SpannerOperations

Type Parameters:

T - the type of the object to retrieve.

Parameters:

entityClass - the type of the object to retrieve.

key - the key of the object.

Returns:

an object of the requested type. Returns null if no object could be found stored with the given key.

read

public <T> T read(Class<T> entityClass,
                  com.google.cloud.spanner.Key key,
                  SpannerReadOptions options)

Description copied from interface: SpannerOperations

Finds a single stored object using a key.

Specified by:

read in interface SpannerOperations

Type Parameters:

T - the type of the object to retrieve.

Parameters:

entityClass - the type of the object to retrieve.

key - the key of the object.

options - Spanner read options with which to conduct the read operation.

Returns:

an object of the requested type. Returns null if no object could be found stored with the given key.

read

public <T> List<T> read(Class<T> entityClass,
                        com.google.cloud.spanner.KeySet keys)

Description copied from interface: SpannerOperations

Finds objects stored from their keys.

Specified by:

read in interface SpannerOperations

Type Parameters:

T - the type of the object to retrieve.

Parameters:

entityClass - the type of the object to retrieve.

keys - the keys of the objects to retrieve.

Returns:

a list of objects that could be found using the given keys. If no keys could be found the list will be empty.

read

public <T> List<T> read(Class<T> entityClass,
                        com.google.cloud.spanner.KeySet keys,
                        SpannerReadOptions options)

Description copied from interface: SpannerOperations

Finds objects stored from their keys.

Specified by:

read in interface SpannerOperations

Type Parameters:

T - the type of the object to retrieve.

Parameters:

entityClass - the type of the object to retrieve.

keys - the keys of the objects to retrieve.

options - Spanner read options with which to conduct the read operation.

Returns:

a list of objects that could be found using the given keys. If no keys could be found the list will be empty.

query

public <T> List<T> query(Class<T> entityClass,
                         String sql,
                         List<String> tags,
                         Object[] params,
                         SpannerQueryOptions options)

Description copied from interface: SpannerOperations

Finds objects by using an SQL statement.

Specified by:

query in interface SpannerOperations

Type Parameters:

T - the type of object to retrieve.

Parameters:

entityClass - the type of object to retrieve.

sql - the SQL string to execute. this string can have Spanner param tags.

tags - the names of the tags to use

params - the values to attach those tags, in the same order.

options - Spanner read options with which to conduct the read operation.

Returns:

a list of the objects found. If no keys could be found the list will be empty.

query

public <T> List<T> query(Class<T> entityClass,
                         com.google.cloud.spanner.Statement statement)

Description copied from interface: SpannerOperations

Finds objects by using an SQL statement.

Specified by:

query in interface SpannerOperations

Type Parameters:

T - the type of object to retrieve.

Parameters:

entityClass - the type of object to retrieve.

statement - the SQL statement used to select the objects.

Returns:

a list of the objects found. If no keys could be found the list will be empty.

readAll

public <T> List<T> readAll(Class<T> entityClass,
                           SpannerReadOptions options)

Description copied from interface: SpannerOperations

Finds all objects of the given type.

Specified by:

readAll in interface SpannerOperations

Type Parameters:

T - the type of the object to retrieve.

Parameters:

entityClass - the type of the object to retrieve.

options - Spanner read options with which to conduct the read operation.

Returns:

a list of all objects stored of the given type. If there are no objects an empty list is returned.

readAll

public <T> List<T> readAll(Class<T> entityClass)

Description copied from interface: SpannerOperations

Finds all objects of the given type.

Specified by:

readAll in interface SpannerOperations

Type Parameters:

T - the type of the object to retrieve.

Parameters:

entityClass - the type of the object to retrieve.

Returns:

a list of all objects stored of the given type. If there are no objects an empty list is returned.

queryAll

public <T> List<T> queryAll(Class<T> entityClass,
                            SpannerQueryOptions options)

Description copied from interface: SpannerOperations

Finds all objects of the given type.

Specified by:

queryAll in interface SpannerOperations

Type Parameters:

T - the type of the object to retrieve.

Parameters:

entityClass - the type of the object to retrieve.

options - Spanner query options with which to conduct the query operation.

Returns:

a list of all objects stored of the given type. If there are no objects an empty list is returned.

applySortingPagingQueryOptions

public <T> String applySortingPagingQueryOptions(Class<T> entityClass,
                                                 SpannerQueryOptions options,
                                                 String sql)

insert

public void insert(Object object)

Description copied from interface: SpannerOperations

Insert an object into storage.

Specified by:

insert in interface SpannerOperations

Parameters:

object - the object to insert.

update

public void update(Object object)

Description copied from interface: SpannerOperations

Update an object already in storage.

Specified by:

update in interface SpannerOperations

Parameters:

object - the object to update.

update

public void update(Object object,
                   String... includeColumns)

Description copied from interface: SpannerOperations

Update an object in storage.

Specified by:

update in interface SpannerOperations

Parameters:

object - the object to update.

includeColumns - the columns to upsert. if none are given then all columns are used

update

public void update(Object object,
                   Optional<Set<String>> includeColumns)

Description copied from interface: SpannerOperations

Update an object in storage.

Specified by:

update in interface SpannerOperations

Parameters:

object - the object to update.

includeColumns - the columns to update. If null or an empty Optional is given, then all columns are used. Note that an Optional occupied by an empty Set means that no columns will be used.

upsert

public void upsert(Object object)

Description copied from interface: SpannerOperations

Update or insert an object into storage.

Specified by:

upsert in interface SpannerOperations

Parameters:

object - the object to update or insert.

upsert

public void upsert(Object object,
                   String... includeColumns)

Description copied from interface: SpannerOperations

Update or insert an object into storage.

Specified by:

upsert in interface SpannerOperations

Parameters:

object - the object to update or insert.

includeColumns - the columns to upsert. if none are given then all columns are upserted.

upsert

public void upsert(Object object,
                   Optional<Set<String>> includeColumns)

Description copied from interface: SpannerOperations

Update or insert an object into storage.

Specified by:

upsert in interface SpannerOperations

Parameters:

object - the object to update or insert.

includeColumns - the columns to upsert. If null or an empty Optional is given, then all columns are used. Note that an Optional occupied by an empty Set means that no columns will be used.

delete

public void delete(Object entity)

Description copied from interface: SpannerOperations

Deletes an object from storage.

Specified by:

delete in interface SpannerOperations

Parameters:

entity - the object to delete from storage.

delete

public void delete(Class entityClass,
                   com.google.cloud.spanner.Key key)

Description copied from interface: SpannerOperations

Deletes an object based on a key.

Specified by:

delete in interface SpannerOperations

Parameters:

entityClass - the type of the object to delete.

key - the key of the object to delete from storage.

delete

public <T> void delete(Class<T> entityClass,
                       Iterable<? extends T> entities)

Description copied from interface: SpannerOperations

Deletes multiple objects from storage.

Specified by:

delete in interface SpannerOperations

Type Parameters:

T - the type of the object to delete.

Parameters:

entityClass - the type of the object to delete.

entities - the objects to delete.

delete

public void delete(Class entityClass,
                   com.google.cloud.spanner.KeySet keys)

Description copied from interface: SpannerOperations

Deletes objects given a set of keys.

Specified by:

delete in interface SpannerOperations

Parameters:

entityClass - the type of object to delete.

keys - the keys of the objects to delete.

count

public long count(Class entityClass)

Description copied from interface: SpannerOperations

Count how many objects are stored of the given type.

Specified by:

count in interface SpannerOperations

Parameters:

entityClass - the type of object to count.

Returns:

the number of stored objects.

performReadWriteTransaction

public <T> T performReadWriteTransaction(Function<SpannerTemplate,T> operations)

Description copied from interface: SpannerOperations

Performs multiple read and write operations in a single transaction.

Specified by:

performReadWriteTransaction in interface SpannerOperations

Type Parameters:

T - the final return type of the operations.

Parameters:

operations - the function representing the operations to perform using a SpannerOperations based on a single transaction.

Returns:

the final result of the transaction.

performReadOnlyTransaction

public <T> T performReadOnlyTransaction(Function<SpannerTemplate,T> operations,
                                        SpannerReadOptions readOptions)

Description copied from interface: SpannerOperations

Performs multiple read-only operations in a single transaction.

Specified by:

performReadOnlyTransaction in interface SpannerOperations

Type Parameters:

T - the final return type of the operations.

Parameters:

operations - the function representing the operations to perform using a SpannerOperations based on a single transaction.

readOptions - allows the user to specify staleness for the read transaction

Returns:

the final result of the transaction.

executeQuery

public com.google.cloud.spanner.ResultSet executeQuery(com.google.cloud.spanner.Statement statement,
                                                       SpannerQueryOptions options)

applyMutationTwoArgs

protected <T,U> void applyMutationTwoArgs(BiFunction<T,U,com.google.cloud.spanner.Mutation> function,
                                          T arg1,
                                          U arg2)