org.apache.gora.solr.store

Class SolrStore<K,T extends PersistentBase>

java.lang.Object

org.apache.gora.store.impl.DataStoreBase<K,T>

org.apache.gora.solr.store.SolrStore<K,T>

All Implemented Interfaces:

Closeable, AutoCloseable, DataStore<K,T>, org.apache.hadoop.conf.Configurable, org.apache.hadoop.io.Writable

public class SolrStore<K,T extends PersistentBase>
extends DataStoreBase<K,T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_BATCH_SIZE
protected static int	DEFAULT_COMMIT_WITHIN
protected static String	DEFAULT_MAPPING_FILE
protected static int	DEFAULT_RESULTS_SIZE
static int	DEFAULT_UNION_SCHEMA Default schema index with value "0" used when AVRO Union data types are stored
static ConcurrentHashMap<String,org.apache.avro.specific.SpecificDatumReader<?>>	readerMap
protected static String	SOLR_BATCH_SIZE_PROPERTY
protected static String	SOLR_COMMIT_WITHIN_PROPERTY
protected static String	SOLR_CONFIG_PROPERTY
protected static String	SOLR_RESULTS_SIZE_PROPERTY
protected static String	SOLR_SCHEMA_PROPERTY
protected static String	SOLR_URL_PROPERTY
static ConcurrentHashMap<String,org.apache.avro.specific.SpecificDatumWriter<?>>	writerMap

Fields inherited from class org.apache.gora.store.impl.DataStoreBase

autoCreateSchema, beanFactory, conf, datumReader, datumWriter, fieldMap, keyClass, persistentClass, properties, schema

Constructor Summary

Constructors

Constructor and Description
SolrStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the DataStore.
void	createSchema() Creates the optional schema or table (or similar) in the datastore to hold the objects.
boolean	delete(K key) Deletes the object with the given key
long	deleteByQuery(Query<K,T> query) Deletes all the objects matching the query.
void	deleteSchema() Deletes the underlying schema or table (or similar) in the datastore that holds the objects.
static String	escapeQueryKey(String key)
Result<K,T>	execute(Query<K,T> query) Executes the given query and returns the results.
void	flush() Forces the write caches to be flushed.
T	get(K key, String[] fields) Returns the object corresponding to the given key.
SolrMapping	getMapping()
List<PartitionQuery<K,T>>	getPartitions(Query<K,T> query) Partitions the given query and returns a list of PartitionQuerys, which will execute on local data.
String	getSchemaName() Returns the schema name given to this DataStore
void	initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties) Initializes this DataStore.
T	newInstance(org.apache.solr.common.SolrDocument doc, String[] fields)
Query<K,T>	newQuery() Constructs and returns a new Query.
void	put(K key, T persistent) Inserts the persistent object with the given key.
boolean	schemaExists() Returns whether the schema that holds the data exists in the datastore.
void	truncateSchema() Deletes all the data associated with the schema, but keeps the schema (table or similar) intact.

Methods inherited from class org.apache.gora.store.impl.DataStoreBase

equals, get, getBeanFactory, getConf, getFields, getFieldsToQuery, getKeyClass, getOrCreateConf, getPersistentClass, getSchemaName, newKey, newPersistent, readFields, setBeanFactory, setConf, setKeyClass, setPersistentClass, write

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAPPING_FILE

protected static final String DEFAULT_MAPPING_FILE

See Also:

Constant Field Values

SOLR_URL_PROPERTY

protected static final String SOLR_URL_PROPERTY

See Also:

Constant Field Values

SOLR_CONFIG_PROPERTY

protected static final String SOLR_CONFIG_PROPERTY

See Also:

Constant Field Values

SOLR_SCHEMA_PROPERTY

protected static final String SOLR_SCHEMA_PROPERTY

See Also:

Constant Field Values

SOLR_BATCH_SIZE_PROPERTY

protected static final String SOLR_BATCH_SIZE_PROPERTY

See Also:

Constant Field Values

SOLR_COMMIT_WITHIN_PROPERTY

protected static final String SOLR_COMMIT_WITHIN_PROPERTY

See Also:

Constant Field Values

SOLR_RESULTS_SIZE_PROPERTY

protected static final String SOLR_RESULTS_SIZE_PROPERTY

See Also:

Constant Field Values

DEFAULT_BATCH_SIZE

protected static final int DEFAULT_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_COMMIT_WITHIN

protected static final int DEFAULT_COMMIT_WITHIN

See Also:

Constant Field Values

DEFAULT_RESULTS_SIZE

protected static final int DEFAULT_RESULTS_SIZE

See Also:

Constant Field Values

DEFAULT_UNION_SCHEMA

public static int DEFAULT_UNION_SCHEMA

Default schema index with value "0" used when AVRO Union data types are stored

readerMap

public static final ConcurrentHashMap<String,org.apache.avro.specific.SpecificDatumReader<?>> readerMap

writerMap

public static final ConcurrentHashMap<String,org.apache.avro.specific.SpecificDatumWriter<?>> writerMap

Constructor Detail

SolrStore

public SolrStore()

Method Detail

initialize

public void initialize(Class<K> keyClass,
              Class<T> persistentClass,
              Properties properties)

Description copied from interface: DataStore

Initializes this DataStore.

Specified by:

initialize in interface DataStore<K,T extends PersistentBase>

Overrides:

initialize in class DataStoreBase<K,T extends PersistentBase>

Parameters:

keyClass - the class of the keys

persistentClass - the class of the persistent objects

properties - extra metadata

getMapping

public SolrMapping getMapping()

getSchemaName

public String getSchemaName()

Description copied from interface: DataStore

Returns the schema name given to this DataStore

Returns:

schema name

createSchema

public void createSchema()

Description copied from interface: DataStore

Creates the optional schema or table (or similar) in the datastore to hold the objects. If the schema is already created previously, or the underlying data model does not support or need this operation, the operation is ignored.

truncateSchema

public void truncateSchema()

Description copied from interface: DataStore

Deletes all the data associated with the schema, but keeps the schema (table or similar) intact.

Specified by:

truncateSchema in interface DataStore<K,T extends PersistentBase>

Overrides:

truncateSchema in class DataStoreBase<K,T extends PersistentBase>

deleteSchema

public void deleteSchema()

Description copied from interface: DataStore

Deletes the underlying schema or table (or similar) in the datastore that holds the objects. This also deletes all the data associated with the schema.

schemaExists

public boolean schemaExists()

Description copied from interface: DataStore

Returns whether the schema that holds the data exists in the datastore.

Returns:

whether schema exists

escapeQueryKey

public static String escapeQueryKey(String key)

get

public T get(K key,
    String[] fields)

Description copied from interface: DataStore

Returns the object corresponding to the given key.

Parameters:

key - the key of the object

fields - the fields required in the object. Pass null, to retrieve all fields

Returns:

the Object corresponding to the key or null if it cannot be found

newInstance

public T newInstance(org.apache.solr.common.SolrDocument doc,
            String[] fields)
                                     throws IOException

Throws:

IOException

put

public void put(K key,
       T persistent)

Description copied from interface: DataStore

Inserts the persistent object with the given key. If an object with the same key already exists it will silently be replaced. See also the note on visibility.

delete

public boolean delete(K key)

Description copied from interface: DataStore

Deletes the object with the given key

Parameters:

key - the key of the object

Returns:

whether the object was successfully deleted

deleteByQuery

public long deleteByQuery(Query<K,T> query)

Description copied from interface: DataStore

Deletes all the objects matching the query. See also the note on visibility.

Parameters:

query - matching records to this query will be deleted

Returns:

number of deleted records

execute

public Result<K,T> execute(Query<K,T> query)

Description copied from interface: DataStore

Executes the given query and returns the results.

Parameters:

query - the query to execute.

Returns:

the results as a Result object.

newQuery

public Query<K,T> newQuery()

Description copied from interface: DataStore

Constructs and returns a new Query.

Returns:

a new Query.

getPartitions

public List<PartitionQuery<K,T>> getPartitions(Query<K,T> query)
                                                               throws IOException

Description copied from interface: DataStore

Partitions the given query and returns a list of PartitionQuerys, which will execute on local data.

Parameters:

query - the base query to create the partitions for. If the query is null, then the data store returns the partitions for the default query (returning every object)

Returns:

a List of PartitionQuery's

Throws:

IOException

flush

public void flush()

Description copied from interface: DataStore

Forces the write caches to be flushed. DataStore implementations may optimize their writing by deferring the actual put / delete operations until this moment. See also the note on visibility.

close

public void close()

Description copied from interface: DataStore

Close the DataStore. This should release any resources held by the implementation, so that the instance is ready for GC. All other DataStore methods cannot be used after this method was called. Subsequent calls of this method are ignored.