solr-client - a node.js solr client
Installation
Install the library with:
npm install --save solr-client
Documentation
Node.js version 12+ is supported. Solr versions 3-8 are supported.
- See the official documentation for more details.
- If you are upgrading from an earlier version, please see the migration guide.
- You can also check out the changelog.
Usage
// Load dependency
const solr = require('solr-client');
// Create a client
const client = solr.createClient();
// Add a new document
client.add({ id : 12, title_t : 'Hello' },function(err,obj){
if (err) {
console.log(err);
} else {
console.log('Solr response:', obj);
}
});
Roadmap
v0.3.x - v0.x.x
- Implement all features available in Solr 4 (SolrCloud API in particular)
- Provide all low-level commands
- Complete documentation
v1.0.x
- First stable version
- the API is frozen until v2.0.x, only new features and bug fixes can be introduced
Test
Tests are executed against a Solr instance in a Docker container. In order to execute them on latest supported Solr version, run:
npm run solr:current:start
npm test
If you want to execute them on oldest Solr version supported, run solr:legacy:start
instead.
Test coverage
Before to be able to run the command below, you will need to install jscoverage available here https://github.com/visionmedia/node-jscoverage.
npm run-script test-cov
This command will generate a file named coverage.html
, use your browser to visualize it.
Static analysis and complexity report
npm run-script report
Licence
(The MIT License)
Copyright 2011-2012 HipSnip Limited
Copyright 2013-2014 Rémy Loubradou