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

Interface SpannerMutationFactory

All Known Implementing Classes:

SpannerMutationFactoryImpl

public interface SpannerMutationFactory

Interface for a factory that creates Spanner mutation operation objects.

Author:

Ray Tsang, Chengyuan Zhao

Method Summary

Modifier and Type	Method and Description
<T> com.google.cloud.spanner.Mutation	delete(Class<T> entityClass, Iterable<? extends T> entities) Deletes several objects from Spanner.
com.google.cloud.spanner.Mutation	delete(Class entityClass, com.google.cloud.spanner.Key key) Deletes a key from Spanner.
com.google.cloud.spanner.Mutation	delete(Class entityClass, com.google.cloud.spanner.KeySet keys) Deletes a set of keys from Spanner.
<T> com.google.cloud.spanner.Mutation	delete(T object) Deletes a single object from Spanner.
com.google.cloud.spanner.Mutation	insert(Object object) Stores a single object in Spanner.
com.google.cloud.spanner.Mutation	update(Object object, Optional<Set<String>> includeColumns) Updates a single object in Spanner.
com.google.cloud.spanner.Mutation	upsert(Object object, Optional<Set<String>> includeColumns) Updates or inserts a single object in Spanner.

Method Detail

insert

com.google.cloud.spanner.Mutation insert(Object object)

Stores a single object in Spanner.

Parameters:

object - The object to store.

Returns:

The mutation operation which will store the object.

upsert

com.google.cloud.spanner.Mutation upsert(Object object,
                                         Optional<Set<String>> includeColumns)

Updates or inserts a single object in Spanner. The columns' values corresponding to the object's fields are treated according to Mutation.Op.INSERT_OR_UPDATE.

Parameters:

object - The object to update or newly insert.

includeColumns - The columns to use in the operation. if null or empty Optional, then all columns are used.

Returns:

The mutation operation to perform the action.

update

com.google.cloud.spanner.Mutation update(Object object,
                                         Optional<Set<String>> includeColumns)

Updates a single object in Spanner. The columns' values corresponding to the object's fields are treated according to Mutation.Op.UPDATE.

Parameters:

object - The object to update.

includeColumns - The columns to use in the operation. if null or empty Optional, then all columns are used.

Returns:

The mutation operation to perform the action.

delete

<T> com.google.cloud.spanner.Mutation delete(Class<T> entityClass,
                                             Iterable<? extends T> entities)

Deletes several objects from Spanner.

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

<T> com.google.cloud.spanner.Mutation delete(T object)

Deletes a single object from Spanner.

Parameters:

object - The object to delete.

Returns:

The delete mutation.

delete

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

Deletes a set of keys from Spanner.

Parameters:

entityClass - The type of the entity to delete.

keys - The keys of the objects to delete.

Returns:

The delete mutation.

delete

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

Deletes a key from Spanner.

Parameters:

entityClass - The type of the entity to delete.

key - The key of the object to delete.

Returns:

The delete mutation.