Solrj is a java client to access solr. It offers a java interface to add, update, and query the solr index. This page describes the use of the SolrJ releases included with Solr 1.4.x releases, with the 1.4.x war files.
For information on using SolrJ with Solr1.3 and Solr1.2, see the Solrj1.3 page.
There are several folders containing jars used by SolrJ: /dist, /dist/solrj-lib and /lib. A minimal set of jars (you may find need of others depending on your usage scenario) to use SolrJ is as follows:
From /dist:
apache-solr-solrj-*.jarFrom /dist/solrj-lib
commons-codec-1.3.jar commons-httpclient-3.1.jar commons-io-1.4.jar jcl-over-slf4j-1.5.5.jar slf4j-api-1.5.5.jarFrom /lib
slf4j-jdk14-1.5.5.jarSolrj is available in the official Maven repository. Add the following dependency to your pom.xml to use SolrJ
<dependency> <artifactId>solr-solrj</artifactId> <groupId>org.apache.solr</groupId> <version>1.4.0</version> <type>jar</type> <scope>compile</scope> </dependency>If you need to use the EmbeddedSolrServer, you need to add the solr-core dependency too.
<dependency> <artifactId>solr-core</artifactId> <groupId>org.apache.solr</groupId> <version>1.4.0</version> <type>jar</type> <scope>compile</scope> </dependency>If you see any exceptions saying NoClassDefFoundError, you will also need to include:
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-simple</artifactId> <version>1.5.6</version> </dependency>The CommonsHttpSolrServer uses the Apache Commons HTTP Client to connect to solr.
String url = "http://localhost:8983/solr"; /* CommonsHttpSolrServer is thread-safe and if you are using the following constructor, you *MUST* re-use the same instance for all requests. If instances are created on the fly, it can cause a connection leak. The recommended practice is to keep a static instance of CommonsHttpSolrServer per solr server url and share it for all requests. See https://issues.apache.org/jira/browse/SOLR-861 for more details */ SolrServer server = new CommonsHttpSolrServer( url );CommonsHttpSolrServer allows setting connection properties.
String url = "http://localhost:8983/solr" CommonsHttpSolrServer server = new CommonsHttpSolrServer( url ); server.setSoTimeout(1000); // socket read timeout server.setConnectionTimeout(100); server.setDefaultMaxConnectionsPerHost(100); server.setMaxTotalConnections(100); server.setFollowRedirects(false); // defaults to false // allowCompression defaults to false. // Server side must support gzip or deflate for this to have any effect. server.setAllowCompression(true); server.setMaxRetries(1); // defaults to 0. > 1 not recommended. server.setParser(new XMLResponseParser()); // binary parser is used by defaultThe EmbeddedSolrServer provides the same interface without requiring an HTTP connection.
// Note that the following property could be set through JVM level arguments too System.setProperty("solr.solr.home", "/home/shalinsmangar/work/oss/branch-1.3/example/solr"); CoreContainer.Initializer initializer = new CoreContainer.Initializer(); CoreContainer coreContainer = initializer.initialize(); EmbeddedSolrServer server = new EmbeddedSolrServer(coreContainer, "");If you want to use MultiCore features, then you should use this:
File home = new File( "/path/to/solr/home" ); File f = new File( home, "solr.xml" ); CoreContainer container = new CoreContainer(); container.load( "/path/to/solr/home", f ); EmbeddedSolrServer server = new EmbeddedSolrServer( container, "core name as defined in solr.xml" ); ...If you need to use solr in an embedded application, this is the recommended approach. It allows you to work with the same interface whether or not you have access to HTTP.
Note -- EmbeddedSolrServer works only with handlers registered in solrconfig.xml. A RequestHandler must be mapped to /update for a request to /update to function.
Solrj is designed as an extendable framework to pass SolrRequest to the SolrServer and return a SolrResponse.
For simplicity, the most common commands are modeled in the SolrServer:
The getSolrServer() method body can be as follows if you use a remote server,
public SolrServer getSolrServer(){ //the instance can be reused return new CommonsHttpSolrServer(); }if it is a local server use the following,
public SolrServer getSolrServer(){ //the instance can be reused return new EmbeddedSolrServer(); } If you wish to clean up the index before adding data do this server.deleteByQuery( "*:*" );// delete everything! Construct a document SolrInputDocument doc1 = new SolrInputDocument(); doc1.addField( "id", "id1", 1.0f ); doc1.addField( "name", "doc1", 1.0f ); doc1.addField( "price", 10 );Construct another document. Each document can be independently be added but it is more efficient to do a batch update. Every call to SolrServer is an Http Call (This is not true for EmbeddedSolrServer).
SolrInputDocument doc2 = new SolrInputDocument(); doc2.addField( "id", "id2", 1.0f ); doc2.addField( "name", "doc2", 1.0f ); doc2.addField( "price", 20 ); Create a collection of documents Collection<SolrInputDocument> docs = new ArrayList<SolrInputDocument>(); docs.add( doc1 ); docs.add( doc2 ); Add the documents to Solr server.add( docs ); Do a commit server.commit(); To immediately commit after adding documents, you could use: UpdateRequest req = new UpdateRequest(); req.setAction( UpdateRequest.ACTION.COMMIT, false, false ); req.add( docs ); UpdateResponse rsp = req.process( server );In most cases StreamingUpdateSolrServer will suit your needs. Alternatively, the workaround presented below can be applied.
This is the most optimal way of updating all your docs in one http request.
CommonsHttpSolrServer server = new CommonsHttpSolrServer(); Iterator<SolrInputDocument> iter = new Iterator<SolrInputDocument>(){ public boolean hasNext() { boolean result ; // set the result to true false to say if you have more documensts return result; } public SolrInputDocument next() { SolrInputDocument result = null; // construct a new document here and set it to result return result; } }; server.add(iter);you may also use the addBeans(Iterator<?> beansIter) method to write pojos
Create a Java bean with annotations. The @Field annotation can be applied to a field or a setter method. If the field name is different from the bean field name give the aliased name in the annotation itself as shown in the categories field.
import org.apache.solr.client.solrj.beans.Field; public class Item { @Field String id; @Field("cat") String[] categories; @Field List<String> features; }The @Field annotation can be applied on setter methods as well example:
@Field("cat") public void setCategory(String[] c){ this.categories = c; }There should be a corresponding getter method (without annotation) for reading attributes
Get an instance of server SolrServer server = getSolrServer(); Create the bean instances Item item = new Item(); item.id = "one"; item.categories = new String[] { "aaa", "bbb", "ccc" }; Add to Solr server.addBean(item); Adding multiple beans together List<Item> beans ; //add Item objects to the list server.addBeans(beans);Note -- Reuse the instance of SolrServer if you are using this feature (for performance )
SolrJ lets you upload content in XML and Binary format. The default is set to be XML. Use the following to upload using Binary format. This is the same format which SolrJ uses to fetch results, and can greatly improve performance as it reduces XML marshalling overhead.
server.setRequestWriter(new BinaryRequestWriter());Note -- be sure you have also enabled the "BinaryUpdateRequestHandler" in your solrconfig.xml for example like:
<requestHandler name="/update/javabin" class="solr.BinaryUpdateRequestHandler" />Construct a SolrQuery
SolrQuery query = new SolrQuery(); query.setQuery( "*:*" ); query.addSortField( "price", SolrQuery.ORDER.asc ); Query the server QueryResponse rsp = server.query( query ); Get the results SolrDocumentList docs = rsp.getResults();To read Documents as beans, the bean must be annotated as given in the example.
List<Item> beans = rsp.getBeans(Item.class);SolrJ provides a APIs to create queries instead of hand coding the query . Following is an example of a faceted query.
SolrServer server = getSolrServer(); SolrQuery solrQuery = new SolrQuery(). setQuery("ipod"). setFacet(true). setFacetMinCount(1). setFacetLimit(8). addFacetField("category"). addFacetField("inStock"); QueryResponse rsp = server.query(solrQuery);All the setter/add methods return its instance . Hence these calls can be chained
Highlighting parameters are set like other common parameters.
SolrQuery query = new SolrQuery(); query.setQuery("foo"); query.setHighlight(true).setHighlightSnippets(1); //set other params as needed query.setParam("hl.fl", "content"); QueryResponse queryResponse = getSolrServer().query(query);Then to get back the highlight results you need something like this:
Iterator<SolrDocument> iter = queryResponse.getResults().iterator(); while (iter.hasNext()) { SolrDocument resultDoc = iter.next(); String content = (String) resultDoc.getFieldValue("content"); String id = (String) resultDoc.getFieldValue("id"); //id is the uniqueKey field if (queryResponse.getHighlighting().get(id) != null) { List<String> highlightSnippets = queryResponse.getHighlighting().get(id).get("content"); } }Solrj (last edited 2010-10-02 20:43:14 by AllistairCrossley)
