org.janusgraph.diskstorage.solr

Class SolrIndex

java.lang.Object

org.janusgraph.diskstorage.solr.SolrIndex

All Implemented Interfaces:

IndexInformation, IndexProvider

public class SolrIndex
extends Object
implements IndexProvider

Author:

Jared Holmberg (jholmberg@bericotechnologies.com), Pavel Yaskevich (pavel@thinkaurelius.com)

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<Boolean>	DYNAMIC_FIELDS
static ConfigOption<Boolean>	HTTP_ALLOW_COMPRESSION
static ConfigOption<Integer>	HTTP_CONNECTION_TIMEOUT
static ConfigOption<Integer>	HTTP_GLOBAL_MAX_CONNECTIONS
static ConfigOption<Integer>	HTTP_MAX_CONNECTIONS_PER_HOST
static ConfigOption<String[]>	HTTP_URLS HTTP Configuration
static ConfigOption<Boolean>	KERBEROS_ENABLED Security Configuration
static ConfigOption<String[]>	KEY_FIELD_NAMES
static ConfigOption<Integer>	MAX_SHARDS_PER_NODE
static ConfigOption<Integer>	NUM_SHARDS
static ConfigOption<Integer>	REPLICATION_FACTOR
static ConfigOption<String>	SOLR_DEFAULT_CONFIG
static ConfigOption<String>	SOLR_MODE
static ConfigNamespace	SOLR_NS
static ConfigOption<String>	TTL_FIELD
static ConfigOption<Boolean>	WAIT_SEARCHER
static ConfigOption<String[]>	ZOOKEEPER_URL SolrCloud Configuration

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

REPLACEMENT_CHAR

Constructor Summary

Constructors

Constructor and Description
SolrIndex(Configuration config)

Method Summary

Modifier and Type	Method and Description
BaseTransactionConfigurable	beginTransaction(BaseTransactionConfig config) Solr handles all transactions on the server-side.
String	buildQueryFilter(Condition<JanusGraphElement> condition, KeyInformation.StoreRetriever information)
void	clearStorage()
void	close()
boolean	exists()
IndexFeatures	getFeatures()
String	mapKey2Field(String key, KeyInformation keyInfo)
void	mutate(Map<String,Map<String,IndexMutation>> mutations, KeyInformation.IndexRetriever information, BaseTransaction tx)
Stream<String>	query(IndexQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)
Stream<RawQuery.Result<String>>	query(RawQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)
Long	queryCount(IndexQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)
void	register(String store, String key, KeyInformation information, BaseTransaction tx) Unlike the ElasticSearch Index, which is schema free, Solr requires a schema to support searching.
void	restore(Map<String,Map<String,List<IndexEntry>>> documents, KeyInformation.IndexRetriever information, BaseTransaction tx)
boolean	supports(KeyInformation information)
boolean	supports(KeyInformation information, JanusGraphPredicate predicate)
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

SOLR_NS

public static final ConfigNamespace SOLR_NS

SOLR_MODE

public static final ConfigOption<String> SOLR_MODE

DYNAMIC_FIELDS

public static final ConfigOption<Boolean> DYNAMIC_FIELDS

KEY_FIELD_NAMES

public static final ConfigOption<String[]> KEY_FIELD_NAMES

TTL_FIELD

public static final ConfigOption<String> TTL_FIELD

ZOOKEEPER_URL

public static final ConfigOption<String[]> ZOOKEEPER_URL

SolrCloud Configuration

NUM_SHARDS

public static final ConfigOption<Integer> NUM_SHARDS

MAX_SHARDS_PER_NODE

public static final ConfigOption<Integer> MAX_SHARDS_PER_NODE

REPLICATION_FACTOR

public static final ConfigOption<Integer> REPLICATION_FACTOR

SOLR_DEFAULT_CONFIG

public static final ConfigOption<String> SOLR_DEFAULT_CONFIG

HTTP_URLS

public static final ConfigOption<String[]> HTTP_URLS

HTTP Configuration

HTTP_CONNECTION_TIMEOUT

public static final ConfigOption<Integer> HTTP_CONNECTION_TIMEOUT

HTTP_ALLOW_COMPRESSION

public static final ConfigOption<Boolean> HTTP_ALLOW_COMPRESSION

HTTP_MAX_CONNECTIONS_PER_HOST

public static final ConfigOption<Integer> HTTP_MAX_CONNECTIONS_PER_HOST

HTTP_GLOBAL_MAX_CONNECTIONS

public static final ConfigOption<Integer> HTTP_GLOBAL_MAX_CONNECTIONS

WAIT_SEARCHER

public static final ConfigOption<Boolean> WAIT_SEARCHER

KERBEROS_ENABLED

public static final ConfigOption<Boolean> KERBEROS_ENABLED

Security Configuration

Constructor Detail

SolrIndex

public SolrIndex(Configuration config)
          throws BackendException

Throws:

BackendException

Method Detail

register

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

Unlike the ElasticSearch Index, which is schema free, Solr requires a schema to support searching. This means that you will need to modify the solr schema with the appropriate field definitions in order to work properly. If you have a running instance of Solr and you modify its schema with new fields, don't forget to re-index!

Specified by:

register in interface IndexProvider

Parameters:

store - Index store

key - New key to register

information - data type to register for the key

tx - enclosing transaction

Throws:

BackendException - in case an exception is thrown when creating a collection.

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

query

public Stream<String> query(IndexQuery query,
                            KeyInformation.IndexRetriever information,
                            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

queryCount

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

Specified by:

queryCount 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

buildQueryFilter

public String buildQueryFilter(Condition<JanusGraphElement> condition,
                               KeyInformation.StoreRetriever information)

beginTransaction

public BaseTransactionConfigurable beginTransaction(BaseTransactionConfig config)

Solr handles all transactions on the server-side. That means all commit, optimize, or rollback applies since the last commit/optimize/rollback. Solr documentation recommends best way to update Solr is in one process to avoid race conditions.

Specified by:

beginTransaction in interface IndexProvider

Returns:

New Transaction Handle

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

supports

public boolean supports(KeyInformation information,
                        JanusGraphPredicate predicate)

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 keyInfo)

Specified by:

mapKey2Field in interface IndexInformation

getFeatures

public IndexFeatures getFeatures()

Specified by:

getFeatures in interface IndexInformation

exists

public boolean exists()
               throws BackendException

Specified by:

exists in interface IndexProvider

Throws:

BackendException