Diesel Full Text Search: 为Diesel ORM添加PostgreSQL全文搜索功能

介绍

diesel_full_text_search是一个Rust库，它为Diesel ORM添加了PostgreSQL全文搜索功能。这个扩展库简化了在Diesel中使用PostgreSQL强大的全文搜索功能的过程，提供了更符合Rust习惯的API。

PostgreSQL的全文搜索功能包括：

• 文本搜索向量(tsvector)和查询(tsquery)支持
• 排名和相关性排序
• 词干提取和停用词处理
• 模糊搜索和短语搜索

安装

在Cargo.toml中添加依赖：

[dependencies]
diesel = { version = "2.0", features = ["postgres"] }
diesel_full_text_search = "0.4"

基本使用方法

1. 创建全文搜索索引

首先需要在数据库表上创建全文搜索索引：

use diesel::prelude::*;
use diesel_full_text_search::TsVector;

table! {
    posts (id) {
        id -> Integer,
        title -> Text,
        body -> Text,
        // 添加tsvector列用于全文搜索
        text_search -> TsVector,
    }
}

在PostgreSQL中创建索引的SQL：

CREATE INDEX posts_text_search_idx ON posts USING gin(text_search);

2. 更新搜索向量

use diesel_full_text_search::websearch_to_tsquery;

// 更新搜索向量
diesel::update(posts::table)
    .set(posts::text_search.eq(websearch_to_tsquery("english", posts::title + " " + posts::body)))
    .execute(conn)?;

3. 基本搜索

use diesel_full_text_search::{plainto_tsquery, TsQuery, TsVector};

let search_query = plainto_tsquery("english", "Rust database");
let results = posts::table
    .filter(posts::text_search.matches(search_query))
    .load::<Post>(conn)?;

高级功能

1. 短语搜索

use diesel_full_text_search::phraseto_tsquery;

let phrase_query = phraseto_tsquery("english", "Rust ORM");
let results = posts::table
    .filter(posts::text_search.matches(phrase_query))
    .load::<Post>(conn)?;

2. 相关性排序

use diesel_full_text_search::ts_rank_cd;

let results = posts::table
    .filter(posts::text_search.matches(search_query))
    .order(ts_rank_cd(posts::text_search, search_query).desc())
    .load::<Post>(conn)?;

3. 高亮搜索结果

use diesel_full_text_search::ts_headline;

let results = posts::table
    .select((
        posts::id,
        posts::title,
        ts_headline("english", posts::body, search_query),
    ))
    .filter(posts::text_search.matches(search_query))
    .load::<(i32, String, String)>(conn)?;

完整示例

以下是内容中提供的完整示例：

use diesel::prelude::*;
use diesel_full_text_search::{websearch_to_tsquery, ts_rank_cd};

#[derive(Queryable)]
struct Post {
    id: i32,
    title: String,
    body: String,
}

pub fn search_posts(conn: &mut PgConnection, query: &str) -> QueryResult<Vec<Post>> {
    use crate::schema::posts::dsl::*;
    
    let search_query = websearch_to_tsquery("english", query);
    
    posts
        .filter(text_search.matches(search_query))
        .order(ts_rank_cd(text_search, search_query).desc())
        .limit(10)
        .load::<Post>(conn)
}

// 使用示例
let conn = &mut establish_connection();
let results = search_posts(conn, "Rust Diesel ORM")?;

扩展完整示例

下面是一个更完整的示例，包含模型定义、数据库连接和完整搜索流程：

use diesel::{prelude::*, pg::PgConnection};
use diesel_full_text_search::{websearch_to_tsquery, ts_rank_cd, TsVector};
use dotenv::dotenv;
use std::env;

// 定义表结构
table! {
    posts (id) {
        id -> Integer,
        title -> Text,
        body -> Text,
        text_search -> TsVector,
    }
}

// 定义Post模型
#[derive(Queryable, Debug)]
pub struct Post {
    pub id: i32,
    pub title: String,
    pub body: String,
}

// 建立数据库连接
pub fn establish_connection() -> PgConnection {
    dotenv().ok();
    let database_url = env::var("DATABASE_URL")
        .expect("DATABASE_URL must be set");
    PgConnection::establish(&database_url)
        .expect(&format!("Error connecting to {}", database_url))
}

// 更新搜索向量
pub fn update_search_vectors(conn: &mut PgConnection) -> QueryResult<usize> {
    use crate::schema::posts::dsl::*;
    
    diesel::update(posts)
        .set(text_search.eq(websearch_to_tsquery("english", title + " " + body)))
        .execute(conn)
}

// 搜索帖子
pub fn search_posts(conn: &mut PgConnection, query: &str) -> QueryResult<Vec<Post>> {
    use crate::schema::posts::dsl::*;
    
    let search_query = websearch_to_tsquery("english", query);
    
    posts
        .filter(text_search.matches(search_query))
        .order(ts_rank_cd(text_search, search_query).desc())
        .limit(10)
        .load::<Post>(conn)
}

fn main() {
    let conn = &mut establish_connection();
    
    // 更新搜索向量
    update_search_vectors(conn).expect("Failed to update search vectors");
    
    // 执行搜索
    let results = search_posts(conn, "Rust Diesel ORM")
        .expect("Failed to search posts");
    
    println!("Found {} posts:", results.len());
    for post in results {
        println!("ID: {}, Title: {}", post.id, post.title);
    }
}

注意事项

1. 确保PostgreSQL服务器配置了适当的文本搜索字典
2. 对于大型数据集，考虑定期更新搜索向量而不是每次修改后立即更新
3. 可以创建GIN或GiST索引来加速搜索
4. 不同语言的搜索需要配置相应的字典

diesel_full_text_search为Diesel提供了强大的全文搜索能力，使得在Rust应用中实现复杂的搜索功能变得简单直观。