com.thinkaurelius.titan.diskstorage.solr

Class SolrIndex

java.lang.Object

com.thinkaurelius.titan.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<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_MODE
static ConfigNamespace	SOLR_NS
static ConfigOption<String>	TTL_FIELD
static ConfigOption<String>	ZOOKEEPER_URL SolrCloud Configuration

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<TitanElement> condition, KeyInformation.StoreRetriever informations)
void	clearStorage()
void	close()
IndexFeatures	getFeatures()
String	mapKey2Field(String key, KeyInformation keyInfo)
void	mutate(Map<String,Map<String,IndexMutation>> mutations, KeyInformation.IndexRetriever informations, BaseTransaction tx)
List<String>	query(IndexQuery query, KeyInformation.IndexRetriever informations, BaseTransaction tx)
Iterable<RawQuery.Result<String>>	query(RawQuery query, KeyInformation.IndexRetriever informations, 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 informations, BaseTransaction tx)
boolean	supports(KeyInformation information)
boolean	supports(KeyInformation information, TitanPredicate titanPredicate)

Methods inherited from class java.lang.Object

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

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

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

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 - Datatype to register for the key

tx - enclosing transaction

Throws:

BackendException

mutate

public void mutate(Map<String,Map<String,IndexMutation>> mutations,
                   KeyInformation.IndexRetriever informations,
                   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 informations,
                    BaseTransaction tx)
             throws BackendException

Specified by:

restore in interface IndexProvider

Throws:

BackendException

query

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

Specified by:

query in interface IndexProvider

Throws:

BackendException

query

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

Specified by:

query in interface IndexProvider

Throws:

BackendException

buildQueryFilter

public String buildQueryFilter(Condition<TitanElement> condition,
                               KeyInformation.StoreRetriever informations)

beginTransaction

public BaseTransactionConfigurable beginTransaction(BaseTransactionConfig config)
                                             throws BackendException

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

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

supports

public boolean supports(KeyInformation information,
                        TitanPredicate titanPredicate)

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