sphinx on rails and ultrasphinx

全文搜尋 Sphinx on Rails
fanuan's ultrasphinx at master
Searching a Ruby on Rails application with Sphinx and Ultrasphinx
Sphinx+MySQL全文檢索架構與安裝
使用libmmseg實現Ruby的中文分詞功能 <= 看起來很強, 可是我還沒用 XD
Sphinx 的特點在於它直接存取 MySQL (或PostgreSQL)，完全獨立於 Rails app。它不像 acts_as_ferret 和 acts_as_solr 使用 rails callback 來做新資料的索引動作，而是設定 crontab 定期跑 indexer (如每半小時)，大大提高了 search daemon 穩定度(反之亦然)，也不太有索引資料損壞的問題(在講ferret?)。目前看到的評價也都是穩穩穩高效能，用過就不想再用 Ferret 了。Ultrasphinx 的作者也有 benchmark 數據可供佐證。

下載, 安裝sphinx
<br />$ tar zxf sphinx-0.9.8.tar.gz<br />$ cd sphinx-0.9.8<br />$./configure && make && sudo make install<br />
要安裝ultrasphinx, 要先安裝 chronic gem<br />sudo gem install chronic<br />
安裝ultrasphinx<br />script/plugin install git://github.com/fauna/ultrasphinx.git<br />
ultrasphinx 也有支援will_paginate<br />#Use gem<br />Rails::Initializer.run do |config|<br /> config.gem 'mislav-will_paginate', :version => '~> 2.2.3', :lib => 'will_paginate', <br /> :source => 'http://gems.github.com'<br />end<br /><br />#or plugin<br />script/plugin install git://github.com/mislav/will_paginate.git<br />
裝好之後就來設定<br />mkdir config/ultrasphinx<br />cp vendor/plugin/ultrasphinx/examples/default.base config/ultrasphinx/<br />
default.base file 支援中文搜尋，這個答案在官網討論區有
<br /><% path = "/opt/local/var/db/sphinx/" %><br /><br /># Indexing options<br />indexer<br />{ <br /> mem_limit = 256M <br /><br /> # Ultrasphinx-specific key<br /> delta = <%= 1.day + 30.minutes %> <br />}<br /><br /># Daemon options<br />searchd<br />{ <br /> # What interface the search daemon should listen on and where to store its logs<br /> address = 0.0.0.0<br /> port = 3313<br /> seamless_rotate = 1<br /> log = log/searchd.log<br /> query_log = log/query.log<br /> read_timeout = 5<br /> max_children = 300<br /> pid_file = log/searchd.pid<br /> max_matches = 100000<br />}<br /><br /># Client options<br />client<br />{<br /> # Name of the Aspell dictionary (two letters max)<br /> dictionary_name = ap<br /> <br /> # How your application connects to the search daemon (not necessarily the same as above)<br /> server_host = localhost<br /> server_port = 3313<br />}<br /><br /># Individual SQL source options<br />source<br />{ <br /> sql_ranged_throttle = 0 <br /> sql_range_step = 5000 <br /> sql_query_post =<br />}<br /><br /># Index building options<br />index<br />{ <br /> path = <%= RAILS_ROOT %>/db/sphinx/<br /> docinfo = extern # Just leave this alone<br /> #morphology = stem_en<br /> stopwords = # <%= path %>/ap-stopwords.txt<br /> min_word_len = 1<br /><br /> # HTML-specific options<br /> html_strip = 0<br /> html_index_attrs =<br /> <br /> # Enable these if you need wildcard searching. They will slow down indexing significantly.<br /> min_infix_len = 1 <br /> # enable_star = 1 <br /> <br /> charset_type = utf-8 # or sbcs (Single Byte Character Set)<br /> charset_table = U+FF10..U+FF19->0..9, 0..9, U+FF41..U+FF5A->a..z, U+FF21..U+FF3A->a..z,A..Z->a..z, a..z, U+0149, U+017F, U+0138, U+00DF, U+00FF, U+00C0..U+00D6->U+00E0..U+00F6, U+00E0..U+00F6, U+00D8..U+00DE->U+00F8..U+00FE, U+00F8..U+00FE, U+0100->U+0101, U+0101, U+0102->U+0103, U+0103, U+0104->U+0105, U+0105, U+0106->U+0107, U+0107, U+0108->U+0109, U+0109, U+010A->U+010B, U+010B, U+010C->U+010D, U+010D, U+010E->U+010F, U+010F, U+0110->U+0111, U+0111, U+0112->U+0113, U+0113, U+0114->U+0115, U+0115, U+0116->U+0117, U+0117, U+0118->U+0119, U+0119, U+011A->U+011B, U+011B, U+011C->U+011D, U+011D, U+011E->U+011F, U+011F, U+0130->U+0131, U+0131, U+0132->U+0133, U+0133, U+0134->U+0135, U+0135, U+0136->U+0137, U+0137, U+0139->U+013A, U+013A, U+013B->U+013C, U+013C, U+013D->U+013E, U+013E, U+013F->U+0140, U+0140, U+0141->U+0142, U+0142, U+0143->U+0144, U+0144, U+0145->U+0146, U+0146, U+0147->U+0148, U+0148, U+014A->U+014B, U+014B, U+014C->U+014D, U+014D, U+014E->U+014F, U+014F, U+0150->U+0151, U+0151, U+0152->U+0153, U+0153, U+0154->U+0155, U+0155, U+0156->U+0157, U+0157, U+0158->U+0159, U+0159, U+015A->U+015B, U+015B, U+015C->U+015D, U+015D, U+015E->U+015F, U+015F, U+0160->U+0161, U+0161, U+0162->U+0163, U+0163, U+0164->U+0165, U+0165, U+0166->U+0167, U+0167, U+0168->U+0169, U+0169, U+016A->U+016B, U+016B, U+016C->U+016D, U+016D, U+016E->U+016F, U+016F, U+0170->U+0171, U+0171, U+0172->U+0173, U+0173, U+0174->U+0175, U+0175, U+0176->U+0177, U+0177, U+0178->U+00FF, U+00FF, U+0179->U+017A, U+017A, U+017B->U+017C, U+017C, U+017D->U+017E, U+017E, U+0410..U+042F->U+0430..U+044F, U+0430..U+044F, U+05D0..U+05EA, U+0531..U+0556->U+0561..U+0586, U+0561..U+0587, U+0621..U+063A, U+01B9, U+01BF, U+0640..U+064A, U+0660..U+0669, U+066E, U+066F, U+0671..U+06D3, U+06F0..U+06FF, U+0904..U+0939, U+0958..U+095F, U+0960..U+0963, U+0966..U+096F, U+097B..U+097F, U+0985..U+09B9, U+09CE, U+09DC..U+09E3, U+09E6..U+09EF, U+0A05..U+0A39, U+0A59..U+0A5E, U+0A66..U+0A6F, U+0A85..U+0AB9, U+0AE0..U+0AE3, U+0AE6..U+0AEF, U+0B05..U+0B39, U+0B5C..U+0B61, U+0B66..U+0B6F, U+0B71, U+0B85..U+0BB9, U+0BE6..U+0BF2, U+0C05..U+0C39, U+0C66..U+0C6F, U+0C85..U+0CB9, U+0CDE..U+0CE3, U+0CE6..U+0CEF, U+0D05..U+0D39, U+0D60, U+0D61, U+0D66..U+0D6F, U+0D85..U+0DC6, U+1900..U+1938, U+1946..U+194F, U+A800..U+A805, U+A807..U+A822, U+0386->U+03B1, U+03AC->U+03B1, U+0388->U+03B5, U+03AD->U+03B5, U+0389->U+03B7, U+03AE->U+03B7, U+038A->U+03B9, U+0390->U+03B9, U+03AA->U+03B9, U+03AF->U+03B9, U+03CA->U+03B9, U+038C->U+03BF, U+03CC->U+03BF, U+038E->U+03C5, U+03AB->U+03C5, U+03B0->U+03C5, U+03CB->U+03C5, U+03CD->U+03C5, U+038F->U+03C9, U+03CE->U+03C9, U+03C2->U+03C3, U+0391..U+03A1->U+03B1..U+03C1, U+03A3..U+03A9->U+03C3..U+03C9, U+03B1..U+03C1, U+03C3..U+03C9, U+0E01..U+0E2E, U+0E30..U+0E3A, U+0E40..U+0E45, U+0E47, U+0E50..U+0E59, U+A000..U+A48F, U+4E00..U+9FBF, U+3400..U+4DBF, U+20000..U+2A6DF, U+F900..U+FAFF, U+2F800..U+2FA1F, U+2E80..U+2EFF, U+2F00..U+2FDF, U+3100..U+312F, U+31A0..U+31BF, U+3040..U+309F, U+30A0..U+30FF, U+31F0..U+31FF, U+AC00..U+D7AF, U+1100..U+11FF, U+3130..U+318F, U+A000..U+A48F, U+A490..U+A4CF,<br /> ngram_len = 1<br /> ngram_chars = U+4E00..U+9FBF, U+3400..U+4DBF, U+20000..U+2A6DF, U+F900..U+FAFF, U+2F800..U+2FA1F, U+2E80..U+2EFF, U+2F00..U+2FDF, U+3100..U+312F, U+31A0..U+31BF, U+3040..U+309F, U+30A0..U+30FF, U+31F0..U+31FF, U+AC00..U+D7AF, U+1100..U+11FF, U+3130..U+318F, U+A000..U+A48F, U+A490..U+A4CF<br /> #charset_table = 0..9, A..Z->a..z, -, _, ., &, a..z, U+410..U+42F->U+430..U+44F, U+430..U+44F,U+C5->U+E5, U+E5, U+C4->U+E4, U+E4, U+D6->U+F6, U+F6, U+16B, U+0c1->a, U+0c4->a, U+0c9->e, U+0cd->i, U+0d3->o, U+0d4->o, U+0da->u, U+0dd->y, U+0e1->a, U+0e4->a, U+0e9->e, U+0ed->i, U+0f3->o, U+0f4->o, U+0fa->u, U+0fd->y, U+104->U+105, U+105, U+106->U+107, U+10c->c, U+10d->c, U+10e->d, U+10f->d, U+116->U+117, U+117, U+118->U+119, U+11a->e, U+11b->e, U+12E->U+12F, U+12F, U+139->l, U+13a->l, U+13d->l, U+13e->l, U+141->U+142, U+142, U+143->U+144, U+144,U+147->n, U+148->n, U+154->r, U+155->r, U+158->r, U+159->r, U+15A->U+15B, U+15B, U+160->s, U+160->U+161, U+161->s, U+164->t, U+165->t, U+16A->U+16B, U+16B, U+16e->u, U+16f->u, U+172->U+173, U+173, U+179->U+17A, U+17A, U+17B->U+17C, U+17C, U+17d->z, U+17e->z,<br />}<br />

接下來設定就是設定想要索引的部份
<br />#in your model<br /> is_indexed :fields => ['name', 'raw_address']<br /><br />#controller<br /> @search = Ultrasphinx::Search.new(:query => params[:search],<br /> :page => 1,<br /> :per_page => 20,<br /> :class_names => params[:model])<br /> @search.run<br /> @stores = @search.results<br /><br />#helper<br /> def search_model<br /> params[:model] || params[:controller].classify<br /> end<br /><br />#view<br /><% form_tag stores_path, :method => :get do %><br /> <%= text_field_tag :search%><br /> <%= submit_tag 'submit' %><br /> <%= hidden_field_tag "model", search_model %><br /><% end %><br /><br /><% for store in @stores %><br />#...<br /><br />#paginator 不是用result 出來的<br /><%= will_paginate @search %><br />
接著產生實際要用的設定檔。注意到如果你之後有改 model 的 is_indexed，這個設定檔每次都要重新產生(因為裡面的東西是 SQL 指令)。

rake ultrasphinx:configure

跑索引跟 daemon 很簡單

rake ultrasphinx:index
rake ultrasphinx:daemon:start

---

RAILS_ROOT/config/ultrasphinx 下的base file 才是讓你編的, 也可以用development, production, test 就像 rails environment 的作法一樣
之後在跑<br />rake ultrasphinx::configure<br />
來產生像對應的 default.conf file 這才是Sphinx 真正在用的