Plugin which handles interaction with Apache Solr for Tymly framework

Usage no npm install needed!

<script type="module">
  import wmfsTymlySolrPlugin from 'https://cdn.skypack.dev/@wmfs/tymly-solr-plugin';



Tymly Package npm (scoped) CircleCI codecov CodeFactor Dependabot badge Commitizen friendly JavaScript Style Guide license

This plugin handles interaction with Apache Solr.

On tymly startup, this plugin searches the loaded blueprints for models that have properties which should be indexed by Apache Solr. It then creates a database view referencing those properties. This service also provides functions to instruct Apache Solr to index data from a database table/view.

See the test blueprint in /test/fixtures/school-blueprint for an example of how to do this.


$ npm install tymly-solr-plugin --save


Before running the tests, you'll need a test PostgreSQL database available and set a PG_CONNECTION_STRING environment variable to point to it, for example:


You can also set an optional SOLR_URL environment variable to configure what Apache Solr instance to use. If the environment variable is not set the plugin will default to http://localhost:8983/solr. You can however explicitly configure what instance to use like this:


Once the environment variables have been set, you can run the tests like this:

$ npm test