A Solr synonym and stopword filter for reading synonyms out of JDBC
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


A simple Solr JDBC connection holder that can be injected by JNDI.

travis ci build status

JDBC support for Solr

This project allows for loading data via JDBC and making it available to Solr components, e.g. token filters and data import handlers. The data sources can be defined via JNDI.

Based on that there are Solr synonym filters for reading synonyms and stop words out of JDBC.

JNDI data sources

Defining data sources via JNDI requires Solr to be deployed into a server with JNDI support. The standard Solr installation does not support JNDI and needs to be patched to support it.

Required libs in the lib folder of Solr:

Required libs in the lib folder of the servlet container:

  • Your SQL driver, e.g. postgresql.

Example using a Tomcat data source

Data sources are defined in your Tomcat context.xml (e.g. /conf/Catalina/localhost/solr.xml), see Look here for more information on configuring a JDBC pool in Tomcat:

<Resource name="jdbc/someName" auth="Container" type="javax.sql.DataSource" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
          url="jdbc:postgresql://localhost:5432/database" defaultAutoCommit="true"
          username="username" password="password"
          maxActive="2" maxIdle="2" minIdle="1" maxWait="10000" validationQuery="select 1" testWhileIdle="true" /> 

In your Solr schema.xml you can reference that data source via its name:

<filter class="com.s24.search.solr.analysis.jdbc.JdbcSynonymFilterFactory"
        dataSource="jdbc/someName" sql="select * from synonyms"
        ignoreMissingDatabase="true" ignoreCase="true" expand="false"/>

Configuring the synonym filter

The JdbcSynonymFilterFactory behaves exactly like the Solr SynonymFilterFactory, except that it does load the synonyms from a JDBC database and not from a file resource. Configure the filter in your Solr analyzer chain like this:

<filter class="com.s24.search.solr.analysis.jdbc.JdbcSynonymFilterFactory"   
        sql="SELECT concat(left, '=>', array_to_string(right, ',')) as line FROM synonyms;" 
        dataSource="jdbc/someName" ignoreCase="false" expand="true" />

The filter takes two arguments over the SynonymFilterFactory:

  • dataSource: The name of your JDBC DataSource as configured. In the example above, this would be jdbc/synonyms.

  • sql: A SQL statement returning valid Solr synonym lines in the first SQL result column.

    • Valid synonym formats include x=>a, x=>a,b,c, x,y=>a,b,c or x,a,b,c.
    • You might have your left and right hand side of your synonym definitions stored in separate columns in your database. Use a concat function to create a valid synonym line.
      • In PostgreSQL, you might use SELECT concat(lhs, '=>', rhs) as line FROM synonyms;
      • In PostgreSQL with arrays, you might use SELECT concat(lhs, '=>', array_to_string(rhs, ',')) as line FROM synonyms;
      • In Mysql your might use SELECT concat(lhs, '=>', rhs) as line FROM synonyms;

A complete field type might look like this example:

<fieldType name="synonym_test" class="solr.TextField">
        <tokenizer class="solr.PatternTokenizerFactory" pattern="[\s]+" />
        <filter class="com.s24.search.solr.analysis.jdbc.JdbcSynonymFilterFactory"   
           sql="SELECT concat(left, '=>', array_to_string(right, ',')) as line FROM synonyms;" 
           jndiName="jdbc/someName" ignoreCase="false" expand="true" />

Configuring the stop word filter

Since version 1.1 there's a JdbcStopFilterFactory available, that reads stopwords from a JDBC database. It behaves exactly like the Solr StopFilterFactory and is meant to be a drop-in replacement:

<filter class="com.s24.search.solr.analysis.jdbc.JdbcStopFilterFactory"   
        sql="SELECT stopword FROM stopwords" 

The filter has the same configuration parameters as the JdbcSynonymFilterFactory.

Using data import handlers

Since 2.2 there's a DataImportJdbcDataSource available, that enables data import handlers to use a data source like defined above. In your data handler configuration use:

    <dataSource type="com.s24.search.solr.analysis.jdbc.DataImportJdbcDataSource" 
                dataSource="jdbc/someName" />

Building the project

This should install the current version into your local repository

$ mvn clean install

Releasing the project to maven central

Define new versions

$ export NEXT_VERSION=<version>

Then execute the release chain

$ mvn org.codehaus.mojo:versions-maven-plugin:2.0:set -DgenerateBackupPoms=false -DnewVersion=$NEXT_VERSION
$ git commit -a -m "pushes to release version $NEXT_VERSION"
$ mvn -P release

Wait for the relase to be accepted. Then increment to next development version:

$ git tag -a v$NEXT_VERSION -m "`curl -s http://whatthecommit.com/index.txt`"
$ mvn org.codehaus.mojo:versions-maven-plugin:2.0:set -DgenerateBackupPoms=false -DnewVersion=$NEXT_DEVELOPMENT_VERSION
$ git commit -a -m "pushes to development version $NEXT_DEVELOPMENT_VERSION"
$ git push origin tag v$NEXT_VERSION && git push origin

Some link regarding Maven central deployment:


This project is licensed under the Apache License, Version 2.