Haystack検索フレームワーク
25364 ワード
1.Haystackとは
Haystackはdjangoのオープンソース全文検索フレームワーク(全文検索は特定のフィールドとは異なるあいまいなクエリーであり、全文検索を使用する効率が高い)であり、このフレームワークはSolr,Elasticsearch,Whooshをサポートしている. **Xapian検索エンジンは挿抜可能なバックエンド(Djangoのデータベース層に似ている)なので、ほとんどのコードを書くと異なる検索エンジン間で簡単に切り替えることができます.
全文検索は、特定のフィールドと異なる曖昧なクエリーであり、全文検索を用いる効率が高く、中国語に対して分詞処理を行うことができる.
haystack:djangoの1つのパッケージは、modelの中の内容を簡単にインデックス、検索することができ、whoosh、solr、Xapian、Elasticsearcの4種類の全文検索エンジンの後端をサポートするように設計され、全文検索のフレームワークに属している.
whoosh:純Pythonが作成した全文検索エンジンは、sphinx、xapian、Elasticsearcなどには及ばないが、バイナリパッケージがなく、プログラムがわけのわからないクラッシュすることはなく、小型のサイトではを十分に使用している.
jieba:無料の中国語の分詞バッグで、使いにくいと思ったら有料製品を使ってもいいです.
2.インストール
3.構成
settings.py 中登録Haystack
###修正`settings.py`
あなたの`settings.py`では、サイトプロファイルが使用しているバックエンドと、他のバックエンド設定を示す設定を追加する必要があります.`HAYSTACK-CONNECTIONS`は必須の設定であり、少なくとも以下のいずれかであるべきである.
Solrの例
Elasticsearchの例
Whoosh例
Xapianの例
4.データの処理
索引の作成
あるapp、例えばblogに対して全文検索をしたい場合は、app 01のディレクトリの下に
インデックスを作成する理由インデックスは本のディレクトリのようなもので、読者により迅速なナビゲーションと検索を提供することができます.ここでも同様に,データ量が非常に大きい場合,これらのデータから検索条件を満たすすべてのものを見つけることはほとんど不可能であり,サーバに大きな負担をもたらす.指定したデータにインデックス(ディレクトリ)を追加する必要があります.ここではNoteのインデックスを作成します.インデックスの実装の詳細は気にする必要はありません.どのフィールドにインデックスを作成するか、どのように指定するかについては、以下で説明します.
各インデックスにはdocument=Trueのフィールドが1つしかありません.これはhaystackと検索エンジンがこのフィールドの内容をインデックスとして取得することを意味します.他のフィールドは付属の属性にすぎず、呼び出しが容易で、検索データとして使用されません.
また、`text`フィールドに`use_を提供します.template=True`.これにより、エラーが発生しやすいカスケードではなく、データテンプレートを使用してドキュメント検索エンジンインデックスを構築できます.テンプレートディレクトリの下に新しいテンプレート`search/indexes/app 01/article_を作成する必要があります.text.txt`、次の内容を中に入れます.
このデータテンプレートの役割は`Note.title`,`Note.user.get_です.full_name`,`Note.body`の3つのフィールドはインデックスを確立し、検索時にこの3つのフィールドに対して全文検索マッチングを行う.
5.ビューの設定
###SearchViewをあなたの`URLconf`に追加
あなたの`URLconf`に次の行を追加します.
これはHaystackのデフォルトURLconfを引き出し、‘SearchView’インスタンスを単独で指すURLconfからなる.いくつかのキーパラメータを渡したり、完全に再設定したりすることで、このクラスの動作を変更することができます.
テンプレートの検索
あなたの検索テンプレート(デフォルトは`search/search.html`)は非常に簡単です.次は検索を実行するのに十分です(あなたの`template/block`は異なるはずです)
注意が必要なのは`page.object_List`は実際には`SearchResult`オブジェクトのリストです.これらのオブジェクトは、インデックスのすべてのデータを返します.`{{result.object}`でアクセスできます.したがって`{result.object.title}`は実際にデータベース内のArticleオブジェクトを使用して`title`フィールドにアクセスします.
インデックスの再構築
データベースのデータをインデックスに入れるときに、すべてのことを構成しました.Haystackに付属しているコマンドライン管理ツールは、それを容易にします.
簡単な運転`./manage.py rebuild_index`.インデックスを処理して格納したモデルがどれだけあるかの統計が得られます.
6.jieba分詞を使う
7.テンプレートに検索バーを作成する
ハイライト表示
Haystackはdjangoのオープンソース全文検索フレームワーク(全文検索は特定のフィールドとは異なるあいまいなクエリーであり、全文検索を使用する効率が高い)であり、このフレームワークはSolr,Elasticsearch,Whooshをサポートしている. **Xapian検索エンジンは挿抜可能なバックエンド(Djangoのデータベース層に似ている)なので、ほとんどのコードを書くと異なる検索エンジン間で簡単に切り替えることができます.
全文検索は、特定のフィールドと異なる曖昧なクエリーであり、全文検索を用いる効率が高く、中国語に対して分詞処理を行うことができる.
haystack:djangoの1つのパッケージは、modelの中の内容を簡単にインデックス、検索することができ、whoosh、solr、Xapian、Elasticsearcの4種類の全文検索エンジンの後端をサポートするように設計され、全文検索のフレームワークに属している.
whoosh:純Pythonが作成した全文検索エンジンは、sphinx、xapian、Elasticsearcなどには及ばないが、バイナリパッケージがなく、プログラムがわけのわからないクラッシュすることはなく、小型のサイトではを十分に使用している.
jieba:無料の中国語の分詞バッグで、使いにくいと思ったら有料製品を使ってもいいです.
2.インストール
pip3 install django-haystack
pip3 install whoosh
pip3 install jieba
3.構成
settings.py 中登録Haystack
ほとんどのDjangoのアプリケーションと同様に、設定ファイル(通常はsettings.py
)にHaystackをINSTALLED_APPS
に追加する必要があります.例:INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
#
'haystack',
# app
'app01',
]
###修正`settings.py`
あなたの`settings.py`では、サイトプロファイルが使用しているバックエンドと、他のバックエンド設定を示す設定を追加する必要があります.`HAYSTACK-CONNECTIONS`は必須の設定であり、少なくとも以下のいずれかであるべきである.
Solrの例
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.solr_backend.SolrEngine',
'URL': 'http://127.0.0.1:8983/solr'
# ...or for multicore...
# 'URL': 'http://127.0.0.1:8983/solr/mysite',
},
}
Elasticsearchの例
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine',
'URL': 'http://127.0.0.1:9200/',
'INDEX_NAME': 'haystack',
},
}
Whoosh例
# PATH Whoosh
import os
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
'PATH': os.path.join(os.path.dirname(__file__), 'whoosh_index'),
},
}
#
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'
Xapianの例
# Xapian (http://github.com/notanumber/xapian-haystack/tree/master)
# PATH Xapian 。
import os
HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'xapian_backend.XapianEngine',
'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index'),
},
}
4.データの処理
索引の作成
あるapp、例えばblogに対して全文検索をしたい場合は、app 01のディレクトリの下に
search_indexes.py
ファイルを作成する必要があります.ファイル名は変更できません.from haystack import indexes
from app01.models import Article
class ArticleIndex(indexes.SearchIndex, indexes.Indexable):
# Model_name+Index, Article, ArticleIndex
text = indexes.CharField(document=True, use_template=True)# text
#
desc = indexes.CharField(model_attr='desc')
content = indexes.CharField(model_attr='content')
def get_model(self):# get_model , !
return Article
def index_queryset(self, using=None):
return self.get_model().objects.all()
インデックスを作成する理由インデックスは本のディレクトリのようなもので、読者により迅速なナビゲーションと検索を提供することができます.ここでも同様に,データ量が非常に大きい場合,これらのデータから検索条件を満たすすべてのものを見つけることはほとんど不可能であり,サーバに大きな負担をもたらす.指定したデータにインデックス(ディレクトリ)を追加する必要があります.ここではNoteのインデックスを作成します.インデックスの実装の詳細は気にする必要はありません.どのフィールドにインデックスを作成するか、どのように指定するかについては、以下で説明します.
各インデックスにはdocument=Trueのフィールドが1つしかありません.これはhaystackと検索エンジンがこのフィールドの内容をインデックスとして取得することを意味します.他のフィールドは付属の属性にすぎず、呼び出しが容易で、検索データとして使用されません.
: document=True, text, ArticleIndex , , , 。
また、`text`フィールドに`use_を提供します.template=True`.これにより、エラーが発生しやすいカスケードではなく、データテンプレートを使用してドキュメント検索エンジンインデックスを構築できます.テンプレートディレクトリの下に新しいテンプレート`search/indexes/app 01/article_を作成する必要があります.text.txt`、次の内容を中に入れます.
# “templates/search/indexes/ /” “ _text.txt”
{{ object.title }}
{{ object.desc }}
{{ object.content }}
このデータテンプレートの役割は`Note.title`,`Note.user.get_です.full_name`,`Note.body`の3つのフィールドはインデックスを確立し、検索時にこの3つのフィールドに対して全文検索マッチングを行う.
5.ビューの設定
###SearchViewをあなたの`URLconf`に追加
あなたの`URLconf`に次の行を追加します.
from django.conf.urls import url, include
from django.contrib import admin
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^search/', include('haystack.urls')),
]
これはHaystackのデフォルトURLconfを引き出し、‘SearchView’インスタンスを単独で指すURLconfからなる.いくつかのキーパラメータを渡したり、完全に再設定したりすることで、このクラスの動作を変更することができます.
テンプレートの検索
あなたの検索テンプレート(デフォルトは`search/search.html`)は非常に簡単です.次は検索を実行するのに十分です(あなたの`template/block`は異なるはずです)
DOCTYPE html>
<html>
<head>
<title>title>
<style>
span.highlighted {
color: red;
}
style>
head>
<body>
{% load highlight %}
{% if query %}
<h3> :h3>
{% for result in page.object_list %}
{# <a href="/{{ result.object.id }}/">{{ result.object.title }}a><br/>#}
<a href="/{{ result.object.id }}/">{% highlight result.object.title with query max_length 2%}a><br/>
<p>{{ result.object.content|safe }}p>
<p>{% highlight result.content with query %}p>
{% empty %}
<p> p>
{% endfor %}
{% if page.has_previous or page.has_next %}
<div>
{% if page.has_previous %}
<a href="?q={{ query }}&page={{ page.previous_page_number }}">{% endif %}«
{% if page.has_previous %}a>{% endif %}
|
{% if page.has_next %}<a href="?q={{ query }}&page={{ page.next_page_number }}">{% endif %} »
{% if page.has_next %}a>{% endif %}
div>
{% endif %}
{% endif %}
body>
html>
注意が必要なのは`page.object_List`は実際には`SearchResult`オブジェクトのリストです.これらのオブジェクトは、インデックスのすべてのデータを返します.`{{result.object}`でアクセスできます.したがって`{result.object.title}`は実際にデータベース内のArticleオブジェクトを使用して`title`フィールドにアクセスします.
インデックスの再構築
データベースのデータをインデックスに入れるときに、すべてのことを構成しました.Haystackに付属しているコマンドライン管理ツールは、それを容易にします.
簡単な運転`./manage.py rebuild_index`.インデックスを処理して格納したモデルがどれだけあるかの統計が得られます.
6.jieba分詞を使う
# ChineseAnalyzer.py
# haystack , “D:\python3\Lib\site-packages\haystack\backends”
import jieba
from whoosh.analysis import Tokenizer, Token
class ChineseTokenizer(Tokenizer):
def __call__(self, value, positions=False, chars=False,
keeporiginal=False, removestops=True,
start_pos=0, start_char=0, mode='', **kwargs):
t = Token(positions, chars, removestops=removestops, mode=mode,
**kwargs)
seglist = jieba.cut(value, cut_all=True)
for w in seglist:
t.original = t.text = w
t.boost = 1.0
if positions:
t.pos = start_pos + value.find(w)
if chars:
t.startchar = start_char + value.find(w)
t.endchar = start_char + value.find(w) + len(w)
yield t
def ChineseAnalyzer():
return ChineseTokenizer()
# whoosh_backend.py , whoosh_cn_backend.py
# : , ,
from .ChineseAnalyzer import ChineseAnalyzer
analyzer=StemmingAnalyzer()
analyzer=ChineseAnalyzer()
7.テンプレートに検索バーを作成する
from haystack.views import SearchView
from .models import *
class MySeachView(SearchView):
def extra_context(self): # extra_context context
context = super(MySeachView,self).extra_context()
side_list = Topic.objects.filter(kind='major').order_by('add_date')[:8]
context['side_list'] = side_list
return context
#
url(r'^search/', search_views.MySeachView(), name='haystack_search'),
ハイライト表示
{% highlight result.summary with query %}
# {{ result.summary }}
{% highlight result.summary with query max_length 40 %}
#html