orm-mysql-fts

0.0.1 • Public • Published

ORM MySQL Full-Text Search Plugin

This plugin adds FTS support for the MySQL driver of ORM.

Dependencies

Of course you need orm to use it. Other than that, no more dependencies.

Install

npm install orm-mysql-fts

DBMS Support

  • MySQL

Usage

Model.match(property1, property2, ...).against(expression [ , alias ])

alias is an alias for the MATCH (..) AGAINST (..) expression and by default is "score". By default the query will be ordered descending by this alias. Only matched rows will be returned (HAVING score > 0).

Example

var orm = require("orm");
var fts = require("orm-mysql-fts");
 
orm.connect("mysql://username:password@host/database", function (err, db) {
    if (err) throw err;
 
    db.use(fts);
 
    var Person = db.define("person", {
        name      : String,
        surname   : String,
        age       : Number
    });
 
    Person.match("name").against("john").limit(10).run(function (err, people) {
        // .against() returns a ChainFind, you can use .limit() , .where() ..
        // (by default it orders by best match)
    });
});

Readme

Keywords

none

Package Sidebar

Install

npm i orm-mysql-fts

Weekly Downloads

3

Version

0.0.1

License

MIT

Last publish

Collaborators

  • dresende