redis-search is a very light-weight search engine for node.js using redis. This module is an implementation of <a href="http://en.wikipedia.org/wiki/N-gram">n-gram method</a>. This is a light general purpose search library that could be integrated into a blog, a documentation server, etc.
redis-search is a very light-weight search engine for node.js using redis. This module is an implementation of n-gram method. This is a light general purpose search library that could be integrated into a blog, a documentation server, etc.
$ npm install redis-search
The first thing you'll want to do is create a
Search instance, which allows you to pass some options, used for namespacing within Redis, size of n-gram, and cache time.
var search = Search;
redis-ngram acts against arbitrary numeric or string based ids, so you could utilize this library with essentially anything you wish, even combining data stores. The following example just uses an array for our "database", containing some strings, which we add to reds by calling
Search#index() padding the body of text and an id of some kind, in this case the index.
var strs = ;strs;strs;strs;strs;strs;
To perform a query against reds simply invoke
Search#query() with a string, and pass a callback, which receives an array of ids when present, or an empty array otherwise.
By default performs an intersection of the search words, the previous example would yield the following output:
Search results for "test boo":[ '2', '3', '1', '0' ]
We can set the search type either "and" of "or" (Default) before query.
Search results for "test boo":[ '2' ]
var Search = ;var search = Search;searchindex'Foo bar baz' 'abc';searchindex'Foo bar' 'bcd';search;search;
(The MIT License)
Copyright (c) 2013 Cheng Zhang <email@example.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.