org.janusgraph.diskstorage.es

Class ElasticSearchIndex

java.lang.Object

org.janusgraph.diskstorage.es.ElasticSearchIndex

All Implemented Interfaces:

IndexInformation, IndexProvider

public class ElasticSearchIndex
extends Object
implements IndexProvider

Author:

Matthias Broecheler (me@matthiasb.com)

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<Boolean>	ALLOW_MAPPING_UPDATE
static ConfigOption<String>	BULK_REFRESH
static ConfigOption<Long>	CLIENT_KEEP_ALIVE
static ConfigOption<Integer>	CONNECT_TIMEOUT
static ConfigOption<Long>	CREATE_SLEEP
static double	DEFAULT_GEO_DIST_ERROR_PCT Default distance_error_pct used when creating geo_shape mappings.
static int	DEFAULT_GEO_MAX_LEVELS Default tree_levels used when creating geo_shape mappings.
static ConfigNamespace	ELASTICSEARCH_NS
static ConfigOption<Boolean>	ENABLE_INDEX_STORE_NAMES_CACHE
static ConfigNamespace	ES_CREATE_EXTRAS_NS
static ConfigNamespace	ES_CREATE_NS
static ConfigNamespace	ES_HTTP_AUTH_BASIC_NS
static ConfigNamespace	ES_HTTP_AUTH_CUSTOM_NS
static ConfigNamespace	ES_HTTP_AUTH_NS
static ConfigOption<String>	ES_HTTP_AUTH_PASSWORD
static ConfigOption<String>	ES_HTTP_AUTH_REALM
static ConfigOption<String>	ES_HTTP_AUTH_TYPE
static ConfigOption<String>	ES_HTTP_AUTH_USERNAME
static ConfigOption<String[]>	ES_HTTP_AUTHENTICATOR_ARGS
static ConfigOption<String>	ES_HTTP_AUTHENTICATOR_CLASS
static ConfigNamespace	ES_HTTP_NS
static ConfigNamespace	ES_INGEST_PIPELINES
static ConfigOption<Integer>	ES_SCROLL_KEEP_ALIVE
static ConfigOption<String>	HEALTH_REQUEST_TIMEOUT
static int	HOST_PORT_DEFAULT
static ConfigOption<String>	INTERFACE
static ConfigOption<Integer>	NUMBER_OF_REPLICAS
static ConfigOption<Integer>	NUMBER_OF_SHARDS
static ConfigOption<String[]>	RETRY_ERROR_CODES
static ConfigOption<Long>	RETRY_INITIAL_WAIT
static ConfigOption<Integer>	RETRY_LIMIT
static ConfigOption<Long>	RETRY_MAX_WAIT
static ConfigOption<Integer>	RETRY_ON_CONFLICT
static ConfigOption<Boolean>	SETUP_MAX_OPEN_SCROLL_CONTEXTS
static ConfigOption<Integer>	SOCKET_TIMEOUT
static ConfigOption<Boolean>	SSL_ALLOW_SELF_SIGNED_CERTIFICATES
static ConfigOption<Boolean>	SSL_DISABLE_HOSTNAME_VERIFICATION
static ConfigOption<Boolean>	SSL_ENABLED
static ConfigOption<String>	SSL_KEY_PASSWORD
static ConfigOption<String>	SSL_KEYSTORE_LOCATION
static ConfigNamespace	SSL_KEYSTORE_NS
static ConfigOption<String>	SSL_KEYSTORE_PASSWORD
static ConfigNamespace	SSL_NS
static ConfigOption<String>	SSL_TRUSTSTORE_LOCATION
static ConfigNamespace	SSL_TRUSTSTORE_NS
static ConfigOption<String>	SSL_TRUSTSTORE_PASSWORD
static ConfigOption<Boolean>	USE_ALL_FIELD
static ConfigOption<Boolean>	USE_EXTERNAL_MAPPINGS
static ConfigOption<Boolean>	USE_MAPPING_FOR_ES7

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

REPLACEMENT_CHAR

Constructor Summary

Constructors

Constructor and Description
ElasticSearchIndex(Configuration config)

Method Summary

Modifier and Type	Method and Description
BaseTransactionConfigurable	beginTransaction(BaseTransactionConfig config)
void	clearStorage()
void	clearStore(String storeName)
void	close()
static String	determineIndexName(Configuration config)
boolean	exists()
IndexFeatures	getFeatures()
Map<String,Object>	getFilter(Condition<?> condition, KeyInformation.StoreRetriever information)
Map<String,Object>	getNewDocument(List<IndexEntry> additions, KeyInformation.StoreRetriever information)
String	mapKey2Field(String key, KeyInformation information)
void	mutate(Map<String,Map<String,IndexMutation>> mutations, KeyInformation.IndexRetriever information, BaseTransaction tx)
Stream<String>	query(IndexQuery query, KeyInformation.IndexRetriever informations, BaseTransaction tx)
Stream<RawQuery.Result<String>>	query(RawQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)
Number	queryAggregation(IndexQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx, Aggregation aggregation)
void	register(String store, String key, KeyInformation information, BaseTransaction tx)
void	restore(Map<String,Map<String,List<IndexEntry>>> documents, KeyInformation.IndexRetriever information, BaseTransaction tx)
boolean	supports(KeyInformation information)
boolean	supports(KeyInformation information, JanusGraphPredicate janusgraphPredicate)
Long	totals(RawQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)

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

ELASTICSEARCH_NS

public static final ConfigNamespace ELASTICSEARCH_NS

INTERFACE

public static final ConfigOption<String> INTERFACE

HEALTH_REQUEST_TIMEOUT

public static final ConfigOption<String> HEALTH_REQUEST_TIMEOUT

BULK_REFRESH

public static final ConfigOption<String> BULK_REFRESH

ES_CREATE_NS

public static final ConfigNamespace ES_CREATE_NS

CREATE_SLEEP

public static final ConfigOption<Long> CREATE_SLEEP

ES_CREATE_EXTRAS_NS

public static final ConfigNamespace ES_CREATE_EXTRAS_NS

USE_EXTERNAL_MAPPINGS

public static final ConfigOption<Boolean> USE_EXTERNAL_MAPPINGS

NUMBER_OF_REPLICAS

public static final ConfigOption<Integer> NUMBER_OF_REPLICAS

NUMBER_OF_SHARDS

public static final ConfigOption<Integer> NUMBER_OF_SHARDS

ALLOW_MAPPING_UPDATE

public static final ConfigOption<Boolean> ALLOW_MAPPING_UPDATE

USE_ALL_FIELD

public static final ConfigOption<Boolean> USE_ALL_FIELD

ES_SCROLL_KEEP_ALIVE

public static final ConfigOption<Integer> ES_SCROLL_KEEP_ALIVE

ES_INGEST_PIPELINES

public static final ConfigNamespace ES_INGEST_PIPELINES

SSL_NS

public static final ConfigNamespace SSL_NS

SSL_ENABLED

public static final ConfigOption<Boolean> SSL_ENABLED

SSL_DISABLE_HOSTNAME_VERIFICATION

public static final ConfigOption<Boolean> SSL_DISABLE_HOSTNAME_VERIFICATION

SSL_ALLOW_SELF_SIGNED_CERTIFICATES

public static final ConfigOption<Boolean> SSL_ALLOW_SELF_SIGNED_CERTIFICATES

SSL_TRUSTSTORE_NS

public static final ConfigNamespace SSL_TRUSTSTORE_NS

SSL_TRUSTSTORE_LOCATION

public static final ConfigOption<String> SSL_TRUSTSTORE_LOCATION

SSL_TRUSTSTORE_PASSWORD

public static final ConfigOption<String> SSL_TRUSTSTORE_PASSWORD

SSL_KEYSTORE_NS

public static final ConfigNamespace SSL_KEYSTORE_NS

SSL_KEYSTORE_LOCATION

public static final ConfigOption<String> SSL_KEYSTORE_LOCATION

SSL_KEYSTORE_PASSWORD

public static final ConfigOption<String> SSL_KEYSTORE_PASSWORD

SSL_KEY_PASSWORD

public static final ConfigOption<String> SSL_KEY_PASSWORD

ES_HTTP_NS

public static final ConfigNamespace ES_HTTP_NS

ES_HTTP_AUTH_NS

public static final ConfigNamespace ES_HTTP_AUTH_NS

ES_HTTP_AUTH_TYPE

public static final ConfigOption<String> ES_HTTP_AUTH_TYPE

ES_HTTP_AUTH_BASIC_NS

public static final ConfigNamespace ES_HTTP_AUTH_BASIC_NS

ES_HTTP_AUTH_USERNAME

public static final ConfigOption<String> ES_HTTP_AUTH_USERNAME

ES_HTTP_AUTH_PASSWORD

public static final ConfigOption<String> ES_HTTP_AUTH_PASSWORD

ES_HTTP_AUTH_REALM

public static final ConfigOption<String> ES_HTTP_AUTH_REALM

ES_HTTP_AUTH_CUSTOM_NS

public static final ConfigNamespace ES_HTTP_AUTH_CUSTOM_NS

ES_HTTP_AUTHENTICATOR_CLASS

public static final ConfigOption<String> ES_HTTP_AUTHENTICATOR_CLASS

ES_HTTP_AUTHENTICATOR_ARGS

public static final ConfigOption<String[]> ES_HTTP_AUTHENTICATOR_ARGS

SETUP_MAX_OPEN_SCROLL_CONTEXTS

public static final ConfigOption<Boolean> SETUP_MAX_OPEN_SCROLL_CONTEXTS

USE_MAPPING_FOR_ES7

public static final ConfigOption<Boolean> USE_MAPPING_FOR_ES7

CLIENT_KEEP_ALIVE

public static final ConfigOption<Long> CLIENT_KEEP_ALIVE

RETRY_ON_CONFLICT

public static final ConfigOption<Integer> RETRY_ON_CONFLICT

ENABLE_INDEX_STORE_NAMES_CACHE

public static final ConfigOption<Boolean> ENABLE_INDEX_STORE_NAMES_CACHE

CONNECT_TIMEOUT

public static final ConfigOption<Integer> CONNECT_TIMEOUT

SOCKET_TIMEOUT

public static final ConfigOption<Integer> SOCKET_TIMEOUT

RETRY_LIMIT

public static final ConfigOption<Integer> RETRY_LIMIT

RETRY_INITIAL_WAIT

public static final ConfigOption<Long> RETRY_INITIAL_WAIT

RETRY_MAX_WAIT

public static final ConfigOption<Long> RETRY_MAX_WAIT

RETRY_ERROR_CODES

public static final ConfigOption<String[]> RETRY_ERROR_CODES

HOST_PORT_DEFAULT

public static final int HOST_PORT_DEFAULT

See Also:

Constant Field Values

DEFAULT_GEO_MAX_LEVELS

public static final int DEFAULT_GEO_MAX_LEVELS

Default tree_levels used when creating geo_shape mappings.

See Also:

Constant Field Values

DEFAULT_GEO_DIST_ERROR_PCT

public static final double DEFAULT_GEO_DIST_ERROR_PCT

Default distance_error_pct used when creating geo_shape mappings.

See Also:

Constant Field Values

Constructor Detail

ElasticSearchIndex

public ElasticSearchIndex(Configuration config)
                   throws BackendException

Throws:

BackendException

Method Detail

determineIndexName

public static String determineIndexName(Configuration config)

register

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

Specified by:

register in interface IndexProvider

Throws:

BackendException

getNewDocument

public Map<String,Object> getNewDocument(List<IndexEntry> additions,
                                         KeyInformation.StoreRetriever information)
                                  throws BackendException

Throws:

BackendException

mutate

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

Specified by:

mutate in interface IndexProvider

Throws:

BackendException

restore

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

Specified by:

restore in interface IndexProvider

Throws:

BackendException

getFilter

public Map<String,Object> getFilter(Condition<?> condition,
                                    KeyInformation.StoreRetriever information)

query

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

Specified by:

query in interface IndexProvider

Throws:

BackendException

query

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

Specified by:

query in interface IndexProvider

Throws:

BackendException

queryAggregation

public Number queryAggregation(IndexQuery query,
                               KeyInformation.IndexRetriever information,
                               BaseTransaction tx,
                               Aggregation aggregation)
                        throws BackendException

Specified by:

queryAggregation in interface IndexProvider

Throws:

BackendException

totals

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

Specified by:

totals in interface IndexProvider

Throws:

BackendException

supports

public boolean supports(KeyInformation information,
                        JanusGraphPredicate janusgraphPredicate)

Specified by:

supports in interface IndexInformation

supports

public boolean supports(KeyInformation information)

Specified by:

supports in interface IndexInformation

mapKey2Field

public String mapKey2Field(String key,
                           KeyInformation information)

Specified by:

mapKey2Field in interface IndexInformation

getFeatures

public IndexFeatures getFeatures()

Specified by:

getFeatures in interface IndexInformation

beginTransaction

public BaseTransactionConfigurable beginTransaction(BaseTransactionConfig config)
                                             throws BackendException

Specified by:

beginTransaction in interface IndexProvider

Throws:

BackendException

close

public void close()
           throws BackendException

Specified by:

close in interface IndexProvider

Throws:

BackendException

clearStorage

public void clearStorage()
                  throws BackendException

Specified by:

clearStorage in interface IndexProvider

Throws:

BackendException

clearStore

public void clearStore(String storeName)
                throws BackendException

Specified by:

clearStore in interface IndexProvider

Throws:

BackendException

exists

public boolean exists()
               throws BackendException

Specified by:

exists in interface IndexProvider

Throws:

BackendException