postgres.search.SearchVectorを使った高度な検索

Django の postgres.search.SearchVector を使った全文検索

Django の django.contrib.postgres モジュールには、PostgreSQL の全文検索機能を利用するための postgres.search.SearchVector クラスが提供されています。このクラスを使うことで、モデルフィールドに対して全文検索を行い、検索結果を効率的に取得することができます。

使い方

準備

1. INSTALLED_APPS に 'django.contrib.postgres' を追加する。
2. 検索対象となるモデルフィールドに対して SearchVector フィールドを追加する。

from django.contrib.postgres.search import SearchVector

class MyModel(models.Model):
    title = models.CharField(max_length=255)
    content = models.TextField()

    # 全文検索対象フィールド
    search_vector = SearchVector('title', 'content')

検索

SearchQuery オブジェクトを使って検索クエリを構築し、filter() メソッドで検索を実行します。

from django.contrib.postgres.search import SearchQuery

query = SearchQuery('python')
results = MyModel.objects.filter(search_vector=query)

詳細

• SearchVector フィールドは、複数のフィールドをまとめて検索対象にすることができます。
• SearchQuery オブジェクトは、AND 検索、OR 検索、フレーズ検索など、様々な検索条件を指定することができます。
• 検索結果の並び順は、SearchRank オブジェクトを使って調整することができます。

補足

• postgres.search.SearchVector は、PostgreSQL 9.2 以降でのみ使用できます。
• django.contrib.postgres モジュールは、Django 1.9 以降で利用可能です。

postgres.search.SearchVector サンプルコード

from django.contrib.postgres.search import SearchVector, SearchQuery

class MyModel(models.Model):
    title = models.CharField(max_length=255)

# 検索対象フィールド
search_vector = SearchVector('title')

# 検索
query = SearchQuery('python')
results = MyModel.objects.filter(search_vector=query)

複数フィールドの検索

from django.contrib.postgres.search import SearchVector, SearchQuery

class MyModel(models.Model):
    title = models.CharField(max_length=255)
    content = models.TextField()

# 検索対象フィールド
search_vector = SearchVector('title', 'content')

# 検索
query = SearchQuery('python')
results = MyModel.objects.filter(search_vector=query)

フレーズ検索

from django.contrib.postgres.search import SearchVector, SearchQuery

class MyModel(models.Model):
    title = models.CharField(max_length=255)

# 検索対象フィールド
search_vector = SearchVector('title')

# フレーズ検索
query = SearchQuery('python programming')
results = MyModel.objects.filter(search_vector=query)

部分一致検索

from django.contrib.postgres.search import SearchVector, SearchQuery

class MyModel(models.Model):
    title = models.CharField(max_length=255)

# 検索対象フィールド
search_vector = SearchVector('title')

# 部分一致検索
query = SearchQuery('python*')
results = MyModel.objects.filter(search_vector=query)

検索結果の並び順

from django.contrib.postgres.search import SearchVector, SearchQuery, SearchRank

class MyModel(models.Model):
    title = models.CharField(max_length=255)
    content = models.TextField()

# 検索対象フィールド
search_vector = SearchVector('title', 'content')

# 検索
query = SearchQuery('python')
results = MyModel.objects.filter(search_vector=query).order_by(SearchRank(search_vector))

検索結果のプレビュー

from django.contrib.postgres.search import SearchVector, SearchQuery, SearchHeadline

class MyModel(models.Model):
    title = models.CharField(max_length=255)
    content = models.TextField()

# 検索対象フィールド
search_vector = SearchVector('title', 'content')

# 検索
query = SearchQuery('python')
results = MyModel.objects.filter(search_vector=query)

# 検索結果プレビュー
for result in results:
    headline = SearchHeadline(search_vector, query)
    print(result.title, headline)

検索条件の組み合わせ

from django.contrib.postgres.search import SearchVector, SearchQuery, Q

class MyModel(models.Model):
    title = models.CharField(max_length=255)
    content = models.TextField()

# 検索対象フィールド
search_vector = SearchVector('title', 'content')

# 検索条件
query1 = SearchQuery('python')
query2 = SearchQuery('django')

# 検索
results = MyModel.objects.filter(Q(search_vector=query1) | Q(search_vector=query2))

検索パフォーマンスの向上

from django.contrib.postgres.search import SearchVectorField

class MyModel(models.Model):
    title = models.CharField(max_length=255)
    content = models.TextField()

# 検索対象フィールド
search_vector = SearchVectorField('title', 'content')

# 検索
query = SearchQuery('python')
results = MyModel.objects.filter(search_vector=query)

補足

postgres.search.SearchVector 以外の全文検索方法

django.contrib.postgres.search モジュールには、TrigramSimilarity クラスが提供されています。このクラスを使うことで、トリグラム検索を行うことができます。

トリグラム検索は、単語を3文字ずつ分割し、その分割された文字列をインデックス化する方法です。この方法を使うことで、部分一致検索やスペルミス検索を行うことができます。

Elasticsearch は、全文検索に特化したオープンソースの検索エンジンです。Django と Elasticsearch を連携させることで、より高度な全文検索機能を実現することができます。

Sphinx は、全文検索エンジンと全文検索サーバーの機能を兼ね備えたオープンソースのソフトウェアです。Django と Sphinx を連携させることで、全文検索機能を効率的に構築することができます。

MeiliSearch は、軽量で高速なオープンソースの全文検索エンジンです。Django と MeiliSearch を連携させることで、簡単に全文検索機能を導入することができます。

それぞれの方法のメリットとデメリット

• 简单的な全文検索機能を導入したい場合は、postgres.search.SearchVector がおすすめです。
• 部分一致検索やスペルミス検索を行う必要がある場合は、TrigramSimilarity を検討してください。
• より高度な全文検索機能が必要な場合は、Elasticsearch や Sphinx を検討してください。
• 簡単に導入できる全文検索機能が必要な場合は、MeiliSearch を検討してください。

補足

• 上記以外にも、全文検索を行う方法はたくさんあります。
• どの方法を使うべきかは、要件や環境によって異なります。