org.janusgraph.diskstorage.indexing

Class IndexTransaction

java.lang.Object

org.janusgraph.diskstorage.indexing.IndexTransaction

All Implemented Interfaces:

BaseTransaction, LoggableTransaction

public class IndexTransaction
extends Object
implements BaseTransaction, LoggableTransaction

Wraps the transaction handle of an index and buffers all mutations against an index for efficiency. Also acts as a proxy to the IndexProvider methods.

Author:

Matthias Broecheler (me@matthiasb.com)

Constructor Summary

Constructors

Constructor and Description
IndexTransaction(IndexProvider index, KeyInformation.IndexRetriever keyInformation, BaseTransactionConfig config, Duration maxWriteTime)

Method Summary

Modifier and Type	Method and Description
void	add(String store, String documentId, IndexEntry entry, boolean isNew)
void	add(String store, String documentId, String key, Object value, boolean isNew)
void	clearStorage()
void	clearStore(String storeName)
void	commit() Commits the transaction and persists all modifications to the backend.
void	delete(String store, String documentId, String key, Object value, boolean deleteAll)
void	invalidate(String store)
void	logMutations(DataOutput out)
Number	queryAggregation(IndexQuery query, Aggregation aggregation)
Stream<String>	queryStream(IndexQuery query)
Stream<RawQuery.Result<String>>	queryStream(RawQuery query)
void	register(String store, String key, KeyInformation information)
void	restore(Map<String,Map<String,List<IndexEntry>>> documents)
void	rollback() Aborts (or rolls back) the transaction.
Long	totals(RawQuery query)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexTransaction

public IndexTransaction(IndexProvider index,
                        KeyInformation.IndexRetriever keyInformation,
                        BaseTransactionConfig config,
                        Duration maxWriteTime)
                 throws BackendException

Throws:

BackendException

Method Detail

add

public void add(String store,
                String documentId,
                IndexEntry entry,
                boolean isNew)

add

public void add(String store,
                String documentId,
                String key,
                Object value,
                boolean isNew)

delete

public void delete(String store,
                   String documentId,
                   String key,
                   Object value,
                   boolean deleteAll)

clearStorage

public void clearStorage()
                  throws BackendException

Throws:

BackendException

clearStore

public void clearStore(String storeName)
                throws BackendException

Throws:

BackendException

register

public void register(String store,
                     String key,
                     KeyInformation information)
              throws BackendException

Throws:

BackendException

queryStream

public Stream<String> queryStream(IndexQuery query)
                           throws BackendException

Throws:

BackendException

queryAggregation

public Number queryAggregation(IndexQuery query,
                               Aggregation aggregation)
                        throws BackendException

Throws:

BackendException

queryStream

public Stream<RawQuery.Result<String>> queryStream(RawQuery query)
                                            throws BackendException

Throws:

BackendException

totals

public Long totals(RawQuery query)
            throws BackendException

Throws:

BackendException

restore

public void restore(Map<String,Map<String,List<IndexEntry>>> documents)
             throws BackendException

Throws:

BackendException

commit

public void commit()
            throws BackendException

Description copied from interface: BaseTransaction

Commits the transaction and persists all modifications to the backend. Call either this method or BaseTransaction.rollback() at most once per instance.

Specified by:

commit in interface BaseTransaction

Throws:

BackendException

rollback

public void rollback()
              throws BackendException

Description copied from interface: BaseTransaction

Aborts (or rolls back) the transaction. Call either this method or BaseTransaction.commit() at most once per instance.

Specified by:

rollback in interface BaseTransaction

Throws:

BackendException

logMutations

public void logMutations(DataOutput out)

Specified by:

logMutations in interface LoggableTransaction

invalidate

public void invalidate(String store)