Mongoid Search 技术文档
2024-12-18 17:59:45作者:凌朦慧Richard
安装指南
1. 添加 Gem
在项目的 Gemfile
中添加以下内容:
gem 'mongoid_search'
2. 安装 Gem
运行以下命令来安装 Gem:
bundle install
项目的使用说明
1. 定义搜索模型
首先,在你的模型中引入 Mongoid::Search
模块,并定义需要搜索的字段。例如:
class Product
include Mongoid::Document
include Mongoid::Search
field :brand
field :name
field :unit
field :info, type: Hash
has_many :tags
belongs_to :category
search_in :brand, :name, tags: :name, category: :name, info: %i[summary description]
search_in :unit, index: :_unit_keywords
end
class Tag
include Mongoid::Document
field :name
belongs_to :product
end
class Category
include Mongoid::Document
field :name
has_many :products
end
2. 保存数据并生成关键词
当你保存一个 Product
对象时,_keywords
字段会自动生成:
p = Product.new brand: 'Apple', name: 'iPhone', unit: 'kilogram', info: { summary: 'Info-summary', description: 'Info-description' }
p.tags << Tag.new(name: 'Amazing')
p.tags << Tag.new(name: 'Awesome')
p.tags << Tag.new(name: 'Superb')
p.save
# => true
p._keywords
# => ["amazing", "apple", "awesome", "iphone", "superb", "Info-summary", "Info-description"]
p._unit_keywords
# => ["kilogram"]
3. 执行搜索
你可以通过 full_text_search
方法进行搜索,搜索结果会返回匹配的记录:
Product.full_text_search("apple iphone").size
# => 1
4. 动态字段搜索
你还可以通过定义方法来实现动态字段的搜索:
class ModelWithDynamicFields
...
search_in :search_data
def search_data
# 将所有字符串字段的值拼接起来
self.attributes.select{|k,v| v.is_a?(String) }.values.join(' ')
end
end
5. 多索引搜索
你可以为不同的搜索需求定义多个索引,并通过 index
参数指定使用哪个索引进行搜索:
Product.full_text_search("kilogram", index: :_unit_keywords).size
# => 1
项目API使用文档
1. full_text_search
方法
full_text_search
方法用于执行全文搜索,支持以下参数:
query
: 搜索的关键词。match
: 匹配模式,可以是:any
或:all
,默认为:any
。allow_empty_search
: 是否允许空搜索,默认为false
。relevant_search
: 是否返回相关性信息,默认为false
。index
: 指定使用的索引,默认为_keywords
。
示例:
Product.full_text_search('apple motorola', match: :any).size
# => 1
Product.full_text_search('apple motorola', match: :all).size
# => 0
2. search_in
方法
search_in
方法用于定义需要搜索的字段,支持直接字段和关联字段:
search_in :brand, :name, tags: :name, category: :name, info: %i[summary description]
3. rake mongoid_search:index
任务
该任务用于重新索引所有现有记录:
$ rake mongoid_search:index
项目安装方式
1. 通过 Gemfile 安装
在 Gemfile
中添加:
gem 'mongoid_search'
然后运行:
bundle install
2. 初始化配置
你可以通过创建一个初始化文件来配置 Mongoid::Search
的选项:
Mongoid::Search.setup do |config|
config.match = :any
config.allow_empty_search = false
config.relevant_search = false
config.stem_keywords = false
config.ignore_list = []
config.regex_search = true
config.regex = Proc.new { |query| /#{query}/ }
config.ligatures = { "œ"=>"oe", "æ"=>"ae" }
config.strip_symbols = /[._:;'\"`,?|+={}()!@#%^&*<>~\$\-\\\/\[\]]/
config.strip_accents = /[^\s\p{Alnum}]/
config.minimum_word_size = 2
end
通过以上步骤,你可以成功安装并使用 Mongoid Search
进行全文搜索。
热门项目推荐
相关项目推荐
鸿蒙开发工具大赶集
本仓将收集和展示鸿蒙开发工具,欢迎大家踊跃投稿。通过pr附上您的工具介绍和使用指南,并加上工具对应的链接,通过的工具将会成功上架到我们社区。017inference
通过更改一行代码,您可以在应用程序中用另一个大型语言模型(LLM)替换OpenAI GPT。Xinference赋予您使用任何所需LLM的自由。借助Xinference,您能够在云端、本地、甚至笔记本电脑上运行任何开源语言模型、语音识别模型和多模态模型的推理。Python00每日精选项目
🔥🔥 每日精选已经升级为:【行业动态】,快去首页看看吧,后续都在【首页 - 行业动态】内更新,多条更新哦~🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~033BootstrapAdmin
基于 RBAC 的 Net8 后台管理框架,权限管理,前后台分离,支持多站点单点登录,兼容所有主流浏览器,内置微信、支付宝、QQ等多种登录方式,内置多种样式,可切换至 Blazor 多 Tabs 模式,权限控制细化到网页内任意元素(按钮、表格、文本框等等)C#00phalapi
PhalApi开源接口框架,简称π框架,一个轻量级PHP开源接口框架,专注于接口服务开发。接口,从简单开始!Objective-C00Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie062毕方Talon工具
本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python040PDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython06mybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区018
热门内容推荐
最新内容推荐
项目优选
收起

Python - 100天从新手到大师
Python
677
122

React Native鸿蒙化仓库
C++
13
31

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
48

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
213
62

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
291
82

通过更改一行代码,您可以在应用程序中用另一个大型语言模型(LLM)替换OpenAI GPT。Xinference赋予您使用任何所需LLM的自由。借助Xinference,您能够在云端、本地、甚至笔记本电脑上运行任何开源语言模型、语音识别模型和多模态模型的推理。
Python
8
0

方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
8
11

前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。
官网地址:https://matechat.gitcode.com
428
38

🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
47
31

open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
90
64