Full text search with Bookshelf.js

I have a table with a MySQL full text index and wanted to search it with Bookshelf.js. bookshelf.png There is actually an open issue to add full text index support to Knex, the query building underlying Bookshelf, but it hasn’t been implemented yet.

Bookshelf has no inbuilt method for performing such a query but it actually ended up being rather simple.

Assuming you have a valid Bookshelf model configured already, for example:

var Customer = Bookshelf.model.extend({
    tableName: 'customers'
});

(lifted verbatim from the Bookshelf docs)

Let’s say the customer has a bio field on which you’d like to perform a full text search. You can do so with the following syntax:

var searchTerm = <code to build your search term>
var customer = new Customer()
    .query("whereRaw", "MATCH (bio) AGAINST(" + searchTerm + ")")
    .fetch(); 

And that’s it! Full text search on the bio field.

One caveat, since you’re piping the searchTerm into this query directly via string concatenation and basically sidestepping the, make sure to escape the string to prevent against SQL injection.

You should follow me on Twitter: @victorquinn

 
19
Kudos
 
19
Kudos

Read this next

JavaScript: arguments explained

In JavaScript, each function has access to a special variable named arguments which represents any arguments which were used when calling that function. You don’t have to define or declare arguments, it’s just already there... Continue →