SolrStore (Apache Gora :: Solr 0.6.1 API)

java.lang.Object
- org.apache.gora.store.impl.DataStoreBase<K,T>
- - org.apache.gora.solr.store.SolrStore<K,T>

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.gora.store.DataStore<K,T>, org.apache.hadoop.conf.Configurable, org.apache.hadoop.io.Writable
```
public class SolrStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>
extends org.apache.gora.store.impl.DataStoreBase<K,T>
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`DEFAULT_BATCH_SIZE` The default batch size (ArrayList) of SolrDocuments to be used in the event of an absent value for `solr.batchSize`.
`protected static int`	`DEFAULT_COMMIT_WITHIN` The default commit size of SolrDocuments to be used in the event of an absent value for `solr.commitSize`.
`protected static String`	`DEFAULT_MAPPING_FILE` The default file name value to be used for obtaining the Solr object field mapping's
`protected static int`	`DEFAULT_RESULTS_SIZE` The default results size of SolrDocuments to be used in the event of an absent value for `solr.resultsSize`.
`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` A batch size unit (ArrayList) of SolrDocument's to be used for writing to Solr.
`protected static String`	`SOLR_COMMIT_WITHIN_PROPERTY` A batch commit unit for SolrDocument's used when making (commit) calls to Solr.
`protected static String`	`SOLR_CONFIG_PROPERTY` The `solrconfig.xml` file to be used - defined in `gora.properties`
`protected static String`	`SOLR_RESULTS_SIZE_PROPERTY` The maximum number of result to return when we make a call to `execute(Query)`.
`protected static String`	`SOLR_SCHEMA_PROPERTY` The `schema.xml` file to be used - defined in `gora.properties`
`protected static String`	`SOLR_SERVER_PASSWORD` Solr client password.
`protected static String`	`SOLR_SERVER_USER_AUTH` Whether to use secured Solr client or not.
`protected static String`	`SOLR_SERVER_USERNAME` Solr client username.
`protected static String`	`SOLR_SOLRJSERVER_IMPL` The solrj implementation to use.
`protected static String`	`SOLR_URL_PROPERTY` The URL of the Solr server - defined in `gora.properties`
`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()

Constructors
Constructor and Description
`SolrStore()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`createSchema()`
`boolean`	`delete(K key)`
`long`	`deleteByQuery(org.apache.gora.query.Query<K,T> query)`
`void`	`deleteSchema()`
`static String`	`escapeQueryKey(String key)`
`org.apache.gora.query.Result<K,T>`	`execute(org.apache.gora.query.Query<K,T> query)`
`void`	`flush()`
`T`	`get(K key, String[] fields)`
`SolrMapping`	`getMapping()`
`List<org.apache.gora.query.PartitionQuery<K,T>>`	`getPartitions(org.apache.gora.query.Query<K,T> query)`
`String`	`getSchemaName()`
`void`	`initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties)`
`T`	`newInstance(org.apache.solr.common.SolrDocument doc, String[] fields)`
`org.apache.gora.query.Query<K,T>`	`newQuery()`
`void`	`put(K key, T persistent)`
`boolean`	`schemaExists()`
`void`	`truncateSchema()`

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
```
    The default file name value to be used for obtaining the Solr object field mapping's
    
    See Also:
    Constant Field Values
  - SOLR_URL_PROPERTY
```
protected static final String SOLR_URL_PROPERTY
```
    The URL of the Solr server - defined in gora.properties
    
    See Also:
    Constant Field Values
  - SOLR_CONFIG_PROPERTY
```
protected static final String SOLR_CONFIG_PROPERTY
```
    The solrconfig.xml file to be used - defined in gora.properties
    
    See Also:
    Constant Field Values
  - SOLR_SCHEMA_PROPERTY
```
protected static final String SOLR_SCHEMA_PROPERTY
```
    The schema.xml file to be used - defined in gora.properties
    
    See Also:
    Constant Field Values
  - SOLR_BATCH_SIZE_PROPERTY
```
protected static final String SOLR_BATCH_SIZE_PROPERTY
```
    A batch size unit (ArrayList) of SolrDocument's to be used for writing to Solr. Should be defined in gora.properties. A default value of 100 is used if this value is absent. This value must be of type Integer.
    
    See Also:
    Constant Field Values
  - SOLR_SOLRJSERVER_IMPL
```
protected static final String SOLR_SOLRJSERVER_IMPL
```
    The solrj implementation to use. This has a default value of http for HttpSolrServer. Available options include http, cloud, concurrent and loadbalance. Defined in gora.properties This value must be of type String.
    
    See Also:
    Constant Field Values
  - SOLR_SERVER_USER_AUTH
```
protected static final String SOLR_SERVER_USER_AUTH
```
    Whether to use secured Solr client or not. Available options include true, and false. Defined in gora.properties This value must be of type boolean.
    
    See Also:
    Constant Field Values
  - SOLR_SERVER_USERNAME
```
protected static final String SOLR_SERVER_USERNAME
```
    Solr client username. Solr client user authentication should be enabled for this property. Defined in gora.properties This value must be of type String.
    
    See Also:
    Constant Field Values
  - SOLR_SERVER_PASSWORD
```
protected static final String SOLR_SERVER_PASSWORD
```
    Solr client password. Solr client user authentication should be enabled for this property. Defined in gora.properties This value must be of type String.
    
    See Also:
    Constant Field Values
  - SOLR_COMMIT_WITHIN_PROPERTY
```
protected static final String SOLR_COMMIT_WITHIN_PROPERTY
```
    A batch commit unit for SolrDocument's used when making (commit) calls to Solr. Should be defined in gora.properties. A default value of 1000 is used if this value is absent. This value must be of type Integer.
    
    See Also:
    Constant Field Values
  - SOLR_RESULTS_SIZE_PROPERTY
```
protected static final String SOLR_RESULTS_SIZE_PROPERTY
```
    The maximum number of result to return when we make a call to execute(Query). This should be defined in gora.properties. This value must be of type Integer.
    
    See Also:
    Constant Field Values
  - DEFAULT_BATCH_SIZE
```
protected static final int DEFAULT_BATCH_SIZE
```
    The default batch size (ArrayList) of SolrDocuments to be used in the event of an absent value for solr.batchSize. Set to 100 by default.
    
    See Also:
    Constant Field Values
  - DEFAULT_COMMIT_WITHIN
```
protected static final int DEFAULT_COMMIT_WITHIN
```
    The default commit size of SolrDocuments to be used in the event of an absent value for solr.commitSize. Set to 1000 by default.
    
    See Also:
    Constant Field Values
  - DEFAULT_RESULTS_SIZE
```
protected static final int DEFAULT_RESULTS_SIZE
```
    The default results size of SolrDocuments to be used in the event of an absent value for solr.resultsSize. Set to 100 by default.
    
    See Also:
    Constant Field Values
  - DEFAULT_UNION_SCHEMA
```
public static final int DEFAULT_UNION_SCHEMA
```
    Default schema index with value "0" used when AVRO Union data types are stored
    
    See Also:
    Constant Field Values
  - 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)
```
    Specified by:
    
    initialize in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>
    
    Overrides:
    
    initialize in class org.apache.gora.store.impl.DataStoreBase<K,T extends org.apache.gora.persistency.impl.PersistentBase>
  - getMapping
```
public SolrMapping getMapping()
```
  - getSchemaName
```
public String getSchemaName()
```
  - createSchema
```
public void createSchema()
```
  - truncateSchema
```
public void truncateSchema()
```
    Specified by:
    
    truncateSchema in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>
    
    Overrides:
    
    truncateSchema in class org.apache.gora.store.impl.DataStoreBase<K,T extends org.apache.gora.persistency.impl.PersistentBase>
  - deleteSchema
```
public void deleteSchema()
```
  - schemaExists
```
public boolean schemaExists()
```
  - escapeQueryKey
```
public static String escapeQueryKey(String key)
```
  - get
```
public T get(K key,
    String[] fields)
```
  - newInstance
```
public T newInstance(org.apache.solr.common.SolrDocument doc,
            String[] fields)
                                                                      throws IOException
```
    Throws:
    
    IOException
  - put
```
public void put(K key,
       T persistent)
```
  - delete
```
public boolean delete(K key)
```
  - deleteByQuery
```
public long deleteByQuery(org.apache.gora.query.Query<K,T> query)
```
  - execute
```
public org.apache.gora.query.Result<K,T> execute(org.apache.gora.query.Query<K,T> query)
```
  - newQuery
```
public org.apache.gora.query.Query<K,T> newQuery()
```
  - getPartitions
```
public List<org.apache.gora.query.PartitionQuery<K,T>> getPartitions(org.apache.gora.query.Query<K,T> query)
                                                                                                                      throws IOException
```
    Throws:
    
    IOException
  - flush
```
public void flush()
```
  - close
```
public void close()
```

Class SolrStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAPPING_FILE

SOLR_URL_PROPERTY

SOLR_CONFIG_PROPERTY

SOLR_SCHEMA_PROPERTY

SOLR_BATCH_SIZE_PROPERTY

SOLR_SOLRJSERVER_IMPL

SOLR_SERVER_USER_AUTH

SOLR_SERVER_USERNAME

SOLR_SERVER_PASSWORD

SOLR_COMMIT_WITHIN_PROPERTY

SOLR_RESULTS_SIZE_PROPERTY

DEFAULT_BATCH_SIZE

DEFAULT_COMMIT_WITHIN

DEFAULT_RESULTS_SIZE

DEFAULT_UNION_SCHEMA

readerMap

writerMap

Constructor Detail

SolrStore

Method Detail

initialize

getMapping

getSchemaName

createSchema

truncateSchema

deleteSchema

schemaExists

escapeQueryKey

get

newInstance

put

delete

deleteByQuery

execute

newQuery

getPartitions

flush

close