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

Class SpannerMutationFactoryImpl

java.lang.Object

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

All Implemented Interfaces:

SpannerMutationFactory

public class SpannerMutationFactoryImpl
extends Object
implements SpannerMutationFactory

Factory that generates mutations for writing to Spanner.

Since:

1.1

Author:

Chengyuan Zhao

Constructor Summary

Constructors

Constructor and Description
SpannerMutationFactoryImpl(SpannerEntityProcessor spannerEntityProcessor, SpannerMappingContext spannerMappingContext, SpannerSchemaUtils spannerSchemaUtils) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> Mutation	delete(Class<T> entityClass, Iterable<? extends T> entities) Deletes several objects from Spanner.
Mutation	delete(Class entityClass, Key key) Deletes a key from Spanner.
Mutation	delete(Class entityClass, KeySet keys) Deletes a set of keys from Spanner.
<T> Mutation	delete(T object) Deletes a single object from Spanner.
List<Mutation>	insert(Object object) Stores an object and its interleaved child properties in Cloud Spanner.
List<Mutation>	update(Object object, Set<String> includeProperties) Updates an object and its interleaved child properties in Cloud Spanner.
List<Mutation>	upsert(Object object, Set<String> includeProperties) Updates or inserts an object and its interleaved child properties in Cloud Spanner.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpannerMutationFactoryImpl

public SpannerMutationFactoryImpl(SpannerEntityProcessor spannerEntityProcessor,
                                  SpannerMappingContext spannerMappingContext,
                                  SpannerSchemaUtils spannerSchemaUtils)

Constructor.

Parameters:

spannerEntityProcessor - the object mapper used to convert between objects and Spanner data types.

spannerMappingContext - the mapping context used to get metadata from entity types.

spannerSchemaUtils - the schema utility to use

Method Detail

insert

public List<Mutation> insert(Object object)

Description copied from interface: SpannerMutationFactory

Stores an object and its interleaved child properties in Cloud Spanner. There will be 1 mutation for each entity corresponding to a row in Cloud Spanner. If there are no interleaved children then the returned list will contain the single mutation for the given object.

Specified by:

insert in interface SpannerMutationFactory

Parameters:

object - the object to store.

Returns:

the mutation operations which will store the object and its children.

upsert

public List<Mutation> upsert(Object object,
                             Set<String> includeProperties)

Description copied from interface: SpannerMutationFactory

Updates or inserts an object and its interleaved child properties in Cloud Spanner. There will be 1 mutation for each entity corresponding to a row in Cloud Spanner. If there are no interleaved children then the returned list will contain the single mutation for the given object.

Specified by:

upsert in interface SpannerMutationFactory

Parameters:

object - the object to update or newly insert.

includeProperties - the properties to use in the operation. if null then all properties are used.

Returns:

the mutation operations which will store the object and its children.

update

public List<Mutation> update(Object object,
                             Set<String> includeProperties)

Description copied from interface: SpannerMutationFactory

Updates an object and its interleaved child properties in Cloud Spanner. There will be 1 mutation for each entity corresponding to a row in Cloud Spanner. If there are no interleaved children then the returned list will contain the single mutation for the given object.

Specified by:

update in interface SpannerMutationFactory

Parameters:

object - the object to update.

includeProperties - the properties to use in the operation. if null then all properties are used.

Returns:

the mutation operations which will store the object and its children.

delete

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

Description copied from interface: SpannerMutationFactory

Deletes several objects from Spanner.

Specified by:

delete in interface SpannerMutationFactory

Type Parameters:

T - the type of object to delete.

Parameters:

entityClass - the type of the objects to delete.

entities - a list of objects to delete. Each object can be a subtype of entityClass.

Returns:

the delete mutation.

delete

public <T> Mutation delete(T object)

Description copied from interface: SpannerMutationFactory

Deletes a single object from Spanner.

Specified by:

delete in interface SpannerMutationFactory

Type Parameters:

T - the type of the object to delete.

Parameters:

object - the object to delete.

Returns:

the delete mutation.

delete

public Mutation delete(Class entityClass,
                       KeySet keys)

Description copied from interface: SpannerMutationFactory

Deletes a set of keys from Spanner.

Specified by:

delete in interface SpannerMutationFactory

Parameters:

entityClass - the type of the entity to delete.

keys - the keys of the objects to delete.

Returns:

the delete mutation.

delete

public Mutation delete(Class entityClass,
                       Key key)

Description copied from interface: SpannerMutationFactory

Deletes a key from Spanner.

Specified by:

delete in interface SpannerMutationFactory

Parameters:

entityClass - the type of the entity to delete.

key - the key of the object to delete.

Returns:

the delete mutation.