An Introduction to search-index

Transcript

1. An introduction to search-index A persistent full text search engine for the browser and Node.js
2. Mats Julian Olsen Mathematics Search @ Comperio twitter.com/mewwts github.com/mewwts
3. Underlying technology of Norch, a search server (like Elasticsearch or Solr) that you can install with npm. About search-index
4. Features • Search • Facets • Filters • Matcher • Stopwords • Snapshots • Replication • Weighting • Del/Update
6. “Node.js project that aims to provide a common, portable interface to a multitude of LevelDB forks.” — leveldb.org LevelUP
7. search-index can use any LevelUP-compliant database as a backend. Backend Agnostic
9. Makes code that ‘require’s run in the browser by bundling dependencies. Browserify
10. Serverside: LevelDB, MongoDB ++ Clientside: IndexedDB, LocalStorage ++ search-index is Backend Agnostic
11. Lower bandwidth costs, lower hardware costs, scales naturally search-index runs client side
12. Performance & user experience People are offline search-index runs offline
13. npm install search-index git clone github.com/fergiemcdowall/search-index Install
14. var si = require('search-index')(opts);
15. var si = require('search-index')({ db: fancyDatabase });
16. si.add(data, function (err) { // data is now indexed });
17. si.add(data, {}, function (err) { // data is now indexed });
18. { title: 'Indian banks provide record low interest rates', body: '...', topics: [ 'banking' ], country: ['India'], id: 0 }
19. si.search(query, function (err, res) { // res.hits holds results });
20. // Search for India and bank in all fields {'query': {'*': ['India', 'bank']}} // Search for India and bank in title field {'query': {'title': ['India', 'bank']}} // search for India in title and bank in body {'query': {'title': ['India'], 'body': ['bank']}}
21. // Search for bank in all fields // Show facets on country field { 'query': { '*': ['bank'] }, 'facets': { 'country': {} } } // {India: 6, USA: 2, Norway: 1} //
22. // Search for bank in all fields // Filter on country='India' { 'query': { '*': ['bank'] }, 'filters': { 'country': [['India', 'India']] } }
23. // Filter on country=‘India' or // country=‘Norway’ { 'query': { '*': ['bank'] }, 'filters': { 'country': [ ['India', 'India'], ['Norway', 'Norway'] ] } }
24. search-index in Node.js https://github.com/fergiemcdowall/search-index- simple-node-js-example
25. search-index with IndexedDB http://mewwts.github.io/search-index-browser-with- facets/
26. search-index Replication http://mewwts.github.io/search-index-replicate-over- http-example/
27. search-index running in a WebWorker http://mewwts.github.io/search-index-webworker- example/
28. search-index in the Future Modular builds(add, search), streaming API, index structure.
29. Get involved Make apps, submit PRs, issues or bring it to new platforms. github.com/fergiemcdowall/search-index
30. Thanks a bunch Questions?