Fix for #90 - introducing support for the SOLR-ExtractionHandler

README.md

@@ -11,11 +11,14 @@ npm install solr-client
 ```
 
 ##Features
-- Commands supported: search(select), index, delete, update, commit, rollback, optimize, ping
+
+- Commands supported: search(select), add, delete, update, commit, rollback, optimize, ping, real-time get, prepare commit, soft commit, arbitrary search handler (i.e: mlt, luke ...)
 - Lucene query / DisMax query
 - Grouping / Field Collapsing. (Apache Solr version must be >= 3.3)
 - Convenients methods for querying with Facet, MoreLikeThis
 - HTTP Basic Access Authentication
+- Over HTTPS as well
+- Use json-bigint to parse and stringify correctly *_l fields of Solr
 
 ##Documentation
 See the website at http://lbdremy.github.com/solr-node-client/.
@@ -34,7 +37,7 @@ client.add({ id : 12, title_t : 'Hello' },function(err,obj){
    if(err){
       console.log(err);
    }else{
-      console.log('Solr response:' + obj);
+      console.log('Solr response:', obj);
    }
 });
 ```
@@ -57,7 +60,6 @@ client.add({ id : 12, title_t : 'Hello' },function(err,obj){
 ```
 npm test
 ```
-### v0.3.x
 
 Tests are executed against a running SOLR instance, so you might want to:
 - install the schema.xml and solrconfig.xml expected by the tests. You find these in test/materials
@@ -85,6 +87,9 @@ npm run-script report
 This command will generate a file named `coverage.html`, use your browser to visualize it.
 
 ##Licence
+
 (The MIT License)
+
 Copyright 2011-2012 HipSnip Limited
+
 Copyright 2013-2014 Rémy Loubradou

examples/deleteAll.js

@@ -0,0 +1,18 @@
+/**
+ * Delete all documents
+ */
+
+// Use `var solr = require('solr-client')` in your code
+var solr = require('./../lib/solr');
+
+var client = solr.createClient();
+
+client.deleteAll(function(err,obj){
+   if(err){
+   	console.log(err);
+   }else{
+   	console.log(obj);
+   }
+   // Do not forget to commit now
+   // to see the changes
+});

examples/deleteByID.js

@@ -2,7 +2,7 @@
  * Delete document with the given `id`
  */
 
-// Use `var solr = require('solr-client')` in your code 
+// Use `var solr = require('solr-client')` in your code
 var solr = require('./../lib/solr');
 
 var client = solr.createClient();
@@ -12,8 +12,9 @@ client.deleteByID(id,function(err,obj){
    if(err){
    	console.log(err);
    }else{
-   	console.log(obj);	
+   	console.log(obj);
    }
+   // Do not forget to commit now
+   // to see the changes
 });
 
-client.commit();

examples/deleteByQuery.js

@@ -2,7 +2,7 @@
  * Delete documents matching the given `query`
  */
 
-// Use `var solr = require('solr-client')` in your code 
+// Use `var solr = require('solr-client')` in your code
 var solr = require('./../lib/solr');
 
 var client = solr.createClient();
@@ -12,8 +12,10 @@ client.deleteByQuery(query,function(err,obj){
    if(err){
    	console.log(err);
    }else{
-   	console.log(obj);	
+   	console.log(obj);
    }
+   // Do not forget to commit now
+   // to see the changes
 });
 
-client.commit();
+

examples/deleteByRange.js

@@ -1,8 +1,8 @@
 /**
- * Delete set of documents based on a range 
+ * Delete set of documents based on a range
  */
 
-// Use `var solr = require('solr-client')` in your code 
+// Use `var solr = require('solr-client')` in your code
 var solr = require('./../lib/solr');
 
 var client = solr.createClient();
@@ -14,8 +14,10 @@ client.deleteByRange('last_update',startOffset,stopOffset,function(err,obj){
    if(err){
    	console.log(err);
    }else{
-   	console.log(obj);	
+   	console.log(obj);
    }
+   // Do not forget to commit now
+   // to see the changes
 });
 
-client.commit();
+

examples/facet.js

@@ -1,4 +1,4 @@
-// Use `var solr = require('solr-client')` in your code 
+// Use `var solr = require('solr-client')` in your code
 var solr = require('./../lib/solr');
 
 var client = solr.createClient();
@@ -21,6 +21,6 @@ client.search(query,function(err,obj){
    if(err){
       console.log(err);
    }else{
-      console.log(obj); 
+      console.log(obj);
    }
 });

examples/get.js

@@ -0,0 +1,19 @@
+/**
+ * Send an arbitrary HTTP GET request to Solr
+ * Use case: use a Search handler exposed by Solr but not supported by this client
+ * for example MoreLikeThisHandler (https://wiki.apache.org/solr/MoreLikeThisHandler)
+ */
+
+// Use `var solr = require('solr-client')` in your code
+var solr = require('./../lib/solr');
+
+var client = solr.createClient();
+
+var query = 'q=id:UTF8TEST&mlt.fl=manu,cat&mlt.mindf=1&mlt.mintf=1';
+client.get('mlt', query, function(err, obj){
+	if(err){
+		console.log(err);
+	}else{
+		console.log(obj);
+	}
+});

examples/optimize.js

@@ -1,24 +1,24 @@
 /*!
- * Optimize: This is similar to a defrag command on a hard drive. 
+ * Optimize: This is similar to a defrag command on a hard drive.
  * It will reorganize the index into segments (increasing search speed) and remove any deleted (replaced) documents.
  * Solr is a read only data store so every time you index a document it will mark the old document as deleted and
- * then create a brand new document to replace the deleted one. Optimize will remove these deleted documents. 
- * You can see the search document vs. deleted document count by going to the Solr Statistics page and looking 
+ * then create a brand new document to replace the deleted one. Optimize will remove these deleted documents.
+ * You can see the search document vs. deleted document count by going to the Solr Statistics page and looking
  * at the numDocs vs. maxDocs numbers. The difference between the two numbers is the amount of deleted (non-search able)
  * documents in the index.
- * Also Optimize builds a whole NEW index from the old one and then switches to the new index when complete. 
+ * Also Optimize builds a whole NEW index from the old one and then switches to the new index when complete.
  * Therefore the command requires double the space to perform the action. So you will
- * need to make sure that the size of your index does not exceed %50 of your available hard drive space. 
+ * need to make sure that the size of your index does not exceed %50 of your available hard drive space.
  * (This is a rule of thumb, it usually needs less then %50 because of deleted documents)
- * 
+ *
  * from Stackoverflow : http://stackoverflow.com/questions/2137607/solr-commit-and-optimize-questions wrote by James Roland
  */
 
 /**
  * Optimize Solr index.
  */
 
-// Use `var solr = require('solr-client')` in your code 
+// Use `var solr = require('solr-client')` in your code
 var solr = require('./../lib/solr');
 
 var client = solr.createClient();
@@ -32,7 +32,7 @@ client.optimize(options,function(err,obj){
    if(err){
    	console.log(err);
    }else{
-   	console.log(obj);	
+   	console.log(obj);
    }
 });
 // waitFlush : default is true

examples/ping.js

@@ -2,7 +2,7 @@
  * Ping the Solr server
  */
 
-// Use `var solr = require('solr-client')` in your code 
+// Use `var solr = require('solr-client')` in your code
 var solr = require('./../lib/solr');
 
 var client = solr.createClient();
@@ -11,6 +11,6 @@ client.ping(function(err,obj){
    if(err){
    	console.log(err);
    }else{
-   	console.log(obj);	
+   	console.log(obj);
    }
 });

examples/prepareCommit.js

@@ -0,0 +1,16 @@
+/**
+ * Prepare commit
+ */
+
+// Use `var solr = require('solr-client')` in your code
+var solr = require('./../lib/solr');
+
+var client = solr.createClient();
+
+client.prepareCommit(function(err,res){
+   if(err){
+   	console.log(err);
+   }else{
+   	console.log(res);
+   }
+});

examples/realTimeGet.js

@@ -0,0 +1,33 @@
+/**
+ * Use real-time get feature
+ */
+
+// Use `var solr = require('solr-client')` in your code
+var solr = require('./../lib/solr');
+
+var client = solr.createClient();
+
+// Retrieve only one document
+var id = 3973873;
+client.realTimeGet(id, function(err, obj){
+    if(err){
+        console.log(err);
+    }else{
+        console.log(obj);
+    }
+});
+
+// Retrieve multiple documents
+var ids = [
+    4874847,
+    9449747,
+    949448
+];
+client.realTimeGet(ids, function(err, obj){
+    if(err){
+        console.log(err);
+    }else{
+        console.log(obj);
+    }
+});
+

examples/softCommit.js

@@ -1,14 +1,16 @@
 /**
- * Commit your changes in the index with or without options. 
+ * Soft commit
  */
 
-// Use `var solr = require('solr-client')` in your code 
+// Use `var solr = require('solr-client')` in your code
 var solr = require('./../lib/solr');
 
 var client = solr.createClient();
 
-// Soft commit
-client.commit({ softCommit : true },function(err,res){
-   if(err) console.log(err);
-   if(res) console.log(res);
+client.softCommit(function(err,res){
+   if(err){
+   	console.log(err);
+   }else{
+   	console.log(res);
+   }
 });

examples/spell.js

@@ -0,0 +1,17 @@
+/**
+ * Search documents matching the `query` with Spellcheck enabled.
+ */
+
+// Use `var solr = require('solr-client')` in your code
+var solr = require('./../lib/solr');
+
+var client = solr.createClient();
+var query = client.createQuery()
+				  .q('laptop');
+client.spell(query,function(err,obj){
+   if(err){
+   	console.log(err);
+   }else{
+   	console.log(obj);
+   }
+});