org.springframework.cloud.gcp.data.spanner.repository.query

Class SpannerStatementQueryExecutor

java.lang.Object

org.springframework.cloud.gcp.data.spanner.repository.query.SpannerStatementQueryExecutor

public final class SpannerStatementQueryExecutor
extends Object

Executes Cloud Spanner query statements using PartTree parsed method definitions.

Since:

1.1

Author:

Chengyuan Zhao, Balint Pato, Mike Eltsufin

Method Summary

Modifier and Type	Method and Description
static StringBuilder	applySort(org.springframework.data.domain.Sort sort, StringBuilder sql, Function<org.springframework.data.domain.Sort.Order,String> sortedPropertyNameFunction)
static <T> String	applySortingPagingQueryOptions(Class<T> entityClass, SpannerPageableQueryOptions options, String sql, SpannerMappingContext mappingContext) Apply paging and sorting options to a query string.
static com.google.cloud.spanner.Statement	buildStatementFromSqlWithArgs(String sql, List<String> tags, Function<Object,com.google.cloud.spanner.Struct> paramStructConvertFunc, SpannerCustomConverter spannerCustomConverter, Object[] params) Creates a Cloud Spanner statement.
static <T> List<T>	executeQuery(Class<T> type, org.springframework.data.repository.query.parser.PartTree tree, Object[] params, SpannerTemplate spannerTemplate, SpannerMappingContext spannerMappingContext) Executes a PartTree-based query.
static <A,T> List<A>	executeQuery(Function<com.google.cloud.spanner.Struct,A> rowFunc, Class<T> type, org.springframework.data.repository.query.parser.PartTree tree, Object[] params, SpannerTemplate spannerTemplate, SpannerMappingContext spannerMappingContext) Executes a PartTree-based query and applies a custom row-mapping function to the result.
static <T> com.google.cloud.spanner.Statement	getChildrenRowsQuery(com.google.cloud.spanner.Key parentKey, SpannerPersistentEntity<T> childPersistentEntity) Gets a query that returns the rows associated with a parent entity.
static String	getColumnsStringForSelect(SpannerPersistentEntity spannerPersistentEntity)

Methods inherited from class java.lang.Object

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

Method Detail

executeQuery

public static <T> List<T> executeQuery(Class<T> type,
                                       org.springframework.data.repository.query.parser.PartTree tree,
                                       Object[] params,
                                       SpannerTemplate spannerTemplate,
                                       SpannerMappingContext spannerMappingContext)

Executes a PartTree-based query.

Type Parameters:

T - the type of the underlying entity

Parameters:

type - the type of the underlying entity

tree - the parsed metadata of the query

params - the parameters of this specific query

spannerTemplate - used to execute the query

spannerMappingContext - used to get metadata about the entity type

Returns:

list of entities.

executeQuery

public static <A,T> List<A> executeQuery(Function<com.google.cloud.spanner.Struct,A> rowFunc,
                                         Class<T> type,
                                         org.springframework.data.repository.query.parser.PartTree tree,
                                         Object[] params,
                                         SpannerTemplate spannerTemplate,
                                         SpannerMappingContext spannerMappingContext)

Executes a PartTree-based query and applies a custom row-mapping function to the result.

Type Parameters:

A - the type to which to convert Struct params

T - the type of the underlying entity on which to query

Parameters:

rowFunc - the function to apply to each row of the result.

type - the type of the underlying entity

tree - the parsed metadata of the query

params - the parameters of this specific query

spannerTemplate - used to execute the query

spannerMappingContext - used to get metadata about the entity type

Returns:

list of objects mapped using the given function.

applySortingPagingQueryOptions

public static <T> String applySortingPagingQueryOptions(Class<T> entityClass,
                                                        SpannerPageableQueryOptions options,
                                                        String sql,
                                                        SpannerMappingContext mappingContext)

Apply paging and sorting options to a query string.

Type Parameters:

T - the domain type.

Parameters:

entityClass - the domain type whose table is being queried.

options - query options containing the sorting and paging options

sql - the sql that will be wrapped with sorting and paging options.

mappingContext - a mapping context to convert between Cloud Spanner column names and underlying property names.

Returns:

the final SQL string with paging and sorting applied.

getChildrenRowsQuery

public static <T> com.google.cloud.spanner.Statement getChildrenRowsQuery(com.google.cloud.spanner.Key parentKey,
                                                                          SpannerPersistentEntity<T> childPersistentEntity)

Gets a query that returns the rows associated with a parent entity. This function is intended to be used with parent-child interleaved tables, so that the retrieval of all child rows having the parent's key values is efficient.

Type Parameters:

T - the type of the child persistent entity

Parameters:

parentKey - the parent key whose children to get.

childPersistentEntity - the persistent entity of the child table.

Returns:

the Spanner statement to perform the retrieval.

buildStatementFromSqlWithArgs

public static com.google.cloud.spanner.Statement buildStatementFromSqlWithArgs(String sql,
                                                                               List<String> tags,
                                                                               Function<Object,com.google.cloud.spanner.Struct> paramStructConvertFunc,
                                                                               SpannerCustomConverter spannerCustomConverter,
                                                                               Object[] params)

Creates a Cloud Spanner statement.

Parameters:

sql - the SQL string with tags.

tags - the tags that appear in the SQL string.

paramStructConvertFunc - a function to use to convert params to Struct objects if they cannot be directly mapped to Cloud Spanner supported param types. If null then this last-attempt conversion is skipped.

spannerCustomConverter - a converter used to convert params that aren't Cloud Spanner native types. if null then this conversion is not attempted.

params - the parameters to substitute the tags. The ordering must be the same as the tags.

Returns:

an SQL statement ready to use with Spanner.

Throws:

IllegalArgumentException - if the number of tags does not match the number of params, or if a param of an unsupported type is given.

getColumnsStringForSelect

public static String getColumnsStringForSelect(SpannerPersistentEntity spannerPersistentEntity)

applySort

public static StringBuilder applySort(org.springframework.data.domain.Sort sort,
                                      StringBuilder sql,
                                      Function<org.springframework.data.domain.Sort.Order,String> sortedPropertyNameFunction)