com.netflix.astyanax.entitystore

Interface EntityManager<T,K>

Type Parameters:

T - entity type

K - rowKey type

All Known Implementing Classes:

CompositeEntityManager, DefaultEntityManager

public interface EntityManager<T,K>

Method Summary

Modifier and Type	Method and Description
void	commit() Commit the internal batch after multiple operations.
NativeQuery<T,K>	createNativeQuery() Execute a 'native' query using a simple API that adheres to cassandra's native model of rows and columns.
void	createStorage(java.util.Map<java.lang.String,java.lang.Object> options) Create the underlying storage for this entity.
void	delete(java.util.Collection<K> ids) Delete a set of entities by their id
void	delete(K id) delete the whole row by id
void	deleteStorage() Delete the underlying storage for this entity.
java.util.List<T>	find(java.lang.String cql) Execute a CQL query and return the found entites
java.util.List<T>	get(java.util.Collection<K> ids)
T	get(K id) fetch whole row and construct entity object mapping from columns
java.util.List<T>	getAll()
void	put(java.util.Collection<T> entities) Store a set of entities.
void	put(T entity) write entity to cassandra with mapped rowId and columns
void	remove(java.util.Collection<T> entities) Delete a set of entities
void	remove(T entity) remove an entire entity
void	truncate() Truncate all data in the underlying
void	visitAll(com.google.common.base.Function<T,java.lang.Boolean> callback) Visit all entities.

Method Detail

put

void put(T entity)
  throws javax.persistence.PersistenceException

write entity to cassandra with mapped rowId and columns

Parameters:

entity - entity object

Throws:

javax.persistence.PersistenceException

get

T get(K id)
throws javax.persistence.PersistenceException

fetch whole row and construct entity object mapping from columns

Parameters:

id - row key

Returns:

entity object. null if not exist

Throws:

javax.persistence.PersistenceException

delete

void delete(K id)
     throws javax.persistence.PersistenceException

delete the whole row by id

Parameters:

id - row key

Throws:

javax.persistence.PersistenceException

remove

void remove(T entity)
     throws javax.persistence.PersistenceException

remove an entire entity

Parameters:

id - row key

Throws:

javax.persistence.PersistenceException

getAll

java.util.List<T> getAll()
                  throws javax.persistence.PersistenceException

Returns:

Return all entities.

Throws:

javax.persistence.PersistenceException

get

java.util.List<T> get(java.util.Collection<K> ids)
               throws javax.persistence.PersistenceException

Parameters:

ids -

Returns:

Get a set of entities

Throws:

javax.persistence.PersistenceException

delete

void delete(java.util.Collection<K> ids)
     throws javax.persistence.PersistenceException

Delete a set of entities by their id

Parameters:

ids -

Throws:

javax.persistence.PersistenceException

remove

void remove(java.util.Collection<T> entities)
     throws javax.persistence.PersistenceException

Delete a set of entities

Parameters:

ids -

Throws:

javax.persistence.PersistenceException

put

void put(java.util.Collection<T> entities)
  throws javax.persistence.PersistenceException

Store a set of entities.

Parameters:

entites -

Throws:

javax.persistence.PersistenceException

visitAll

void visitAll(com.google.common.base.Function<T,java.lang.Boolean> callback)
       throws javax.persistence.PersistenceException

Visit all entities.

Parameters:

callback - Callback when an entity is read. Note that the callback may be called from multiple threads.

Throws:

javax.persistence.PersistenceException

find

java.util.List<T> find(java.lang.String cql)
                throws javax.persistence.PersistenceException

Execute a CQL query and return the found entites

Parameters:

cql -

Throws:

javax.persistence.PersistenceException

createNativeQuery

NativeQuery<T,K> createNativeQuery()

Execute a 'native' query using a simple API that adheres to cassandra's native model of rows and columns.

Returns:

createStorage

void createStorage(java.util.Map<java.lang.String,java.lang.Object> options)
            throws javax.persistence.PersistenceException

Create the underlying storage for this entity. This should only be called once when first creating store and not part of the normal startup sequence.

Throws:

javax.persistence.PersistenceException

deleteStorage

void deleteStorage()
            throws javax.persistence.PersistenceException

Delete the underlying storage for this entity.

Parameters:

options -

Throws:

javax.persistence.PersistenceException

truncate

void truncate()
       throws javax.persistence.PersistenceException

Truncate all data in the underlying

Parameters:

options -

Throws:

javax.persistence.PersistenceException

commit

void commit()
     throws javax.persistence.PersistenceException

Commit the internal batch after multiple operations. Note that an entity manager implementation may autocommit after each operation.

Throws:

javax.persistence.PersistenceException