SearchBlox Developer Hub

Welcome to the SearchBlox developer hub. Here you will find comprehensive guides and documentation to help you start working with SearchBlox as quickly as possible, as well as support if you get stuck. Let's jump right in!


Database Collection

SearchBlox allows you to easily index records from the database table, and results are customizable with Faceted Search.

Creating a Database Collection

You can create a Database collection with the following steps:

  • After logging in to the Admin Console, click on the Add Collection button. The Add Collection screen will now be displayed.
  • Enter a unique name for your collection (for example, db collection).
  • Click on the DB Collection icon.
  • Click Add to create the collection.

Supported Databases

SearchBlox databases for database collection indexing include:

  • MySQL
  • SQL Server
  • Oracle
  • PostgreSQL
  • Apache Drill Databases
  • Other Applications supported through Database Collection

Active Directory


Google Sheets






Office 365


Azure Table

Exact Online










Excel Services


QuickBooks Online


Dynamics CRM



QuickBooks POS


Dynamics GP





Dynamics NAV

Google Adwords


Sage50 UK



Google Analytics

Microsoft Exchange




Google Apps




Database Collection Settings

This is where you can configure your database for indexing by using the applicable query, and the database- and application-related settings you have selected. To access the settings for the collection, click on the collection name in the collections list.

Database Collection Queries

To fetch data from the table or application, input the required query in the SQL field under the Queries tab.

To find the applicable query format and prerequisites for your collection, click here: SQL Query for DB Collection.

Collection Settings

Under the Settings sub-tab you will find settings for the database, and tunable parameters for the search functionality. SearchBlox comes pre-configured with parameters when a new collection is created, but you can also select your preferred setting values for database collections. SearchBlox's support team is available to explain the various configuration settings and what they mean.


Database Type

Database to be indexed. SearchBlox supports MySQL, SQL Server, Oracle, PostgreSQL, Apache Drill and other drivers.
The list of other drivers supported by SearchBlox is provided here: Supported DB Connectors

Database URL String

The database URL string has to be specified for Apache Drill and Supported DB Connectors.

Host IP/name

IP address or name of the database host. (Default value is localhost).

Host Port No.

Port number of the database.

Database Name

Name of the database in which the tables are created.

Database Username

Username of the database.

Database Password

Password of the database.

Fetch Size

Specifies the maximum number of records that can be fetched from the database. Default value is 100.


Defines the time span covered for the polling period. Default value is 10.

(Only available in version 8.2 and earlier.)

Polling time is the time interval in which the JDBC river runs repeatedly to refresh the indexed records. Schedule value should be in cron format (
Default value is 1 minute (0 0-59 0-23 ? ).
To index every day at midnight, the cron value for Poll is 0 0 0 .
To index every hour daily, the cron value for Poll is 0 0

River Table

Used to manage updates in the database. With the help of the river table, the SQL DB takes over the job of managing objects for Elasticsearch. False by default.


Used for numeric conversion. Valid rounding modes are ceiling, down, floor, halfdown, halfeven, halfup, unnecessary, up.


Used for numeric conversion. Default value is 1.


Used for update management. Default value is false.

Keyword-in-Context Display

The keyword-in-context returns search results with the description displayed from content areas where the search term occurs.


Boost search terms for the collection by setting a value greater than 1 (maximum value 9999).


When stemming is enabled, inflected words are reduced to root form. For example, "running", "runs", and "ran" are the inflected form of "run".

Spelling Suggestions

When enabled, a spelling index is created at the end of the indexing process.

After saving the query and settings, test the connection. The connection has to be successful for
indexing to take place.

Indexing and Other Operations

The following operations can be performed in Database collections.


Starts the indexer for the selected collection.


Clears the current index for the selected collection.

  • Under the Index sub-tab in the collection you can view the current status of an indexer for that particular collection.
  • Indexing and clear operations can only be performed from the index sub-tab.
  • Indexing is updated based on interval time and cannot be scheduled.
  • From SearchBlox 8.4 and higher, database collection indexing must be stopped manually.
  • For automatic indexing after a particular interval, specify the interval (in minutes) in the database collection settings, and do not stop the indexing process. The documents updated in the database are updated automatically after the interval.
  • Do not schedule indexing in database collections.

Viewing Search Results

View the search results by searching for the records here: http://localhost:8080/searchblox/plugin/index.html.
After clicking the search results, the data will appear in grid format as shown below:

To add customized facets, go to the index.html page. The facet can be any value in the table, which can be used to filter the results.

Results can also be viewed in JSON format as shown below, by clicking the database search results in a regular search: http://localhost:8080/searchblox/search.jsp.

[{"uid":"1","lname":"Jones","university":"VCU","keywords":"joe","no":"1","content":"[1, Smith, Jones, 1, Georgetown, Biotech, D05, VCU]","title":"Smith","deptid":"D05","address":"1, Georgetown","dept":"Biotech","fname":"Smith"}]

For a grid-type view of search results, use SearchBlox's AngularJS plugin. More details about this option can be found here: Database Search.

Database Collection

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.