org.janusgraph.diskstorage.util

Class MetricInstrumentedIndexProvider

java.lang.Object

org.janusgraph.diskstorage.util.MetricInstrumentedIndexProvider

All Implemented Interfaces:

IndexInformation, IndexProvider

public class MetricInstrumentedIndexProvider
extends Object
implements IndexProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	M_CALLS
static String	M_EXCEPTIONS
static String	M_MIXED_COUNT_QUERY
static String	M_MUTATE
static String	M_QUERY
static String	M_RAW_QUERY
static String	M_RESTORE
static String	M_TIME
static String	M_TOTALS
static List<String>	OPERATION_NAMES

Fields inherited from interface org.janusgraph.diskstorage.indexing.IndexProvider

REPLACEMENT_CHAR

Constructor Summary

Constructors

Constructor and Description
MetricInstrumentedIndexProvider(IndexProvider indexProvider, String prefix)

Method Summary

Modifier and Type	Method and Description
BaseTransactionConfigurable	beginTransaction(BaseTransactionConfig config) Returns a transaction handle for a new index transaction.
void	clearStorage() Clears the index and removes all entries in all stores.
void	close() Closes the index
boolean	exists() Checks whether the index exists.
IndexFeatures	getFeatures() The features of this index
String	mapKey2Field(String key, KeyInformation information) Adjusts the name of the key so that it is a valid field name that can be used in the index.
void	mutate(Map<String,Map<String,IndexMutation>> mutations, KeyInformation.IndexRetriever information, BaseTransaction tx) Mutates the index (adds and removes fields or entire documents)
Stream<String>	query(IndexQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx) Executes the given query against the index.
Stream<RawQuery.Result<String>>	query(RawQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx) Executes the given raw query against the index
Long	queryCount(IndexQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)
void	register(String store, String key, KeyInformation information, BaseTransaction tx) This method registers a new key for the specified index store with the given data type.
void	restore(Map<String,Map<String,List<IndexEntry>>> documents, KeyInformation.IndexRetriever information, BaseTransaction tx) Restores the index to the state of the primary data store as given in the documents variable.
boolean	supports(KeyInformation information) Whether the index supports indexing a key with the given information
boolean	supports(KeyInformation information, JanusGraphPredicate janusgraphPredicate) Whether the index supports executing queries with the given predicate against a key with the given information
Long	totals(RawQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx) Executes the given raw query against the index and returns the total hits.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.janusgraph.diskstorage.indexing.IndexProvider

checkKeyValidity

Field Detail

M_MUTATE

public static final String M_MUTATE

See Also:

Constant Field Values

M_RESTORE

public static final String M_RESTORE

See Also:

Constant Field Values

M_QUERY

public static final String M_QUERY

See Also:

Constant Field Values

M_MIXED_COUNT_QUERY

public static final String M_MIXED_COUNT_QUERY

See Also:

Constant Field Values

M_RAW_QUERY

public static final String M_RAW_QUERY

See Also:

Constant Field Values

M_TOTALS

public static final String M_TOTALS

See Also:

Constant Field Values

M_CALLS

public static final String M_CALLS

See Also:

Constant Field Values

M_TIME

public static final String M_TIME

See Also:

Constant Field Values

M_EXCEPTIONS

public static final String M_EXCEPTIONS

See Also:

Constant Field Values

OPERATION_NAMES

public static final List<String> OPERATION_NAMES

Constructor Detail

MetricInstrumentedIndexProvider

public MetricInstrumentedIndexProvider(IndexProvider indexProvider,
                                       String prefix)

Method Detail

register

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

Description copied from interface: IndexProvider

This method registers a new key for the specified index store with the given data type. This allows the IndexProvider to prepare the index if necessary. It is expected that this method is first called with each new key to inform the index of the expected type before the key is used in any documents.

Specified by:

register in interface IndexProvider

Parameters:

store - Index store

key - New key to register

information - Information on the key to register

tx - enclosing transaction

Throws:

BackendException

mutate

public void mutate(Map<String,Map<String,IndexMutation>> mutations,
                   KeyInformation.IndexRetriever information,
                   BaseTransaction tx)
            throws BackendException

Description copied from interface: IndexProvider

Mutates the index (adds and removes fields or entire documents)

Specified by:

mutate in interface IndexProvider

Parameters:

mutations - Updates to the index. First map contains all the mutations for each store. The inner map contains all changes for each document in an IndexMutation.

information - Information on the keys used in the mutation accessible through KeyInformation.IndexRetriever.

tx - Enclosing transaction

Throws:

BackendException

See Also:

IndexMutation

restore

public void restore(Map<String,Map<String,List<IndexEntry>>> documents,
                    KeyInformation.IndexRetriever information,
                    BaseTransaction tx)
             throws BackendException

Description copied from interface: IndexProvider

Restores the index to the state of the primary data store as given in the documents variable. When this method returns, the index records for the given documents exactly matches the provided data. Unlike IndexProvider.mutate(java.util.Map, KeyInformation.IndexRetriever, BaseTransaction) this method does not do a delta-update, but entirely replaces the documents with the provided data or deletes them if the document content is empty.

Specified by:

restore in interface IndexProvider

Parameters:

documents - The outer map maps stores to documents, the inner contains the documents mapping document ids to the document content which is a list of IndexEntry. If that list is empty, that means this document should not exist and ought to be deleted.

information - Information on the keys used in the mutation accessible through KeyInformation.IndexRetriever.

tx - Enclosing transaction

Throws:

BackendException

queryCount

public Long queryCount(IndexQuery query,
                       KeyInformation.IndexRetriever information,
                       BaseTransaction tx)
                throws BackendException

Specified by:

queryCount in interface IndexProvider

Throws:

BackendException

query

public Stream<String> query(IndexQuery query,
                            KeyInformation.IndexRetriever information,
                            BaseTransaction tx)
                     throws BackendException

Description copied from interface: IndexProvider

Executes the given query against the index.

Specified by:

query in interface IndexProvider

Parameters:

query - Query to execute

information - Information on the keys used in the query accessible through KeyInformation.IndexRetriever.

tx - Enclosing transaction

Returns:

The ids of all matching documents

Throws:

BackendException

See Also:

IndexQuery

query

public Stream<RawQuery.Result<String>> query(RawQuery query,
                                             KeyInformation.IndexRetriever information,
                                             BaseTransaction tx)
                                      throws BackendException

Description copied from interface: IndexProvider

Executes the given raw query against the index

Specified by:

query in interface IndexProvider

Parameters:

query - Query to execute

information - Information on the keys used in the query accessible through KeyInformation.IndexRetriever.

tx - Enclosing transaction

Returns:

Results objects for all matching documents (i.e. document id and score)

Throws:

BackendException

See Also:

RawQuery

totals

public Long totals(RawQuery query,
                   KeyInformation.IndexRetriever information,
                   BaseTransaction tx)
            throws BackendException

Description copied from interface: IndexProvider

Executes the given raw query against the index and returns the total hits. e.g. limit=0

Specified by:

totals in interface IndexProvider

Parameters:

query - Query to execute

information - Information on the keys used in the query accessible through KeyInformation.IndexRetriever.

tx - Enclosing transaction

Returns:

Long total hits for query

Throws:

BackendException

See Also:

RawQuery

beginTransaction

public BaseTransactionConfigurable beginTransaction(BaseTransactionConfig config)
                                             throws BackendException

Description copied from interface: IndexProvider

Returns a transaction handle for a new index transaction.

Specified by:

beginTransaction in interface IndexProvider

Returns:

New Transaction Handle

Throws:

BackendException

close

public void close()
           throws BackendException

Description copied from interface: IndexProvider

Closes the index

Specified by:

close in interface IndexProvider

Throws:

BackendException

clearStorage

public void clearStorage()
                  throws BackendException

Description copied from interface: IndexProvider

Clears the index and removes all entries in all stores.

Specified by:

clearStorage in interface IndexProvider

Throws:

BackendException

exists

public boolean exists()
               throws BackendException

Description copied from interface: IndexProvider

Checks whether the index exists.

Specified by:

exists in interface IndexProvider

Returns:

Flag indicating whether index exists

Throws:

BackendException

supports

public boolean supports(KeyInformation information,
                        JanusGraphPredicate janusgraphPredicate)

Description copied from interface: IndexInformation

Whether the index supports executing queries with the given predicate against a key with the given information

Specified by:

supports in interface IndexInformation

Returns:

supports

public boolean supports(KeyInformation information)

Description copied from interface: IndexInformation

Whether the index supports indexing a key with the given information

Specified by:

supports in interface IndexInformation

Returns:

mapKey2Field

public String mapKey2Field(String key,
                           KeyInformation information)

Description copied from interface: IndexInformation

Adjusts the name of the key so that it is a valid field name that can be used in the index. JanusGraph stores this information and will use the returned name in all interactions with the index.

Note, that mapped field names (either configured on a per key basis or through a global configuration) are not adjusted and handed to the index verbatim.

Specified by:

mapKey2Field in interface IndexInformation

Returns:

getFeatures

public IndexFeatures getFeatures()

Description copied from interface: IndexInformation

The features of this index

Specified by:

getFeatures in interface IndexInformation

Returns: