Struct SearchQuery 

pub struct SearchQuery {
    pub query: String,
    pub columns: Vec<String>,
    pub mode: SearchMode,
    pub language: SearchLanguage,
    pub ranking: RankingOptions,
    pub highlight: HighlightOptions,
    pub fuzzy: FuzzyOptions,
    pub min_word_length: Option<u32>,
    pub filters: Vec<(String, String)>,
}

A full-text search query.

Fields

query: String

Search terms.

columns: Vec<String>

Columns to search in.

mode: SearchMode

Search mode.

language: SearchLanguage

Language/configuration.

ranking: RankingOptions

Ranking options.

highlight: HighlightOptions

Highlighting options.

fuzzy: FuzzyOptions

Fuzzy search options.

min_word_length: Option<u32>

Minimum word length.

filters: Vec<(String, String)>

Filter by category/field (for faceted search).

Implementations

impl SearchQuery

pub fn new(query: impl Into<String>) -> SearchQueryBuilder

Create a new search query.

pub fn to_postgres_sql(&self, table: &str) -> QueryResult<SearchSql>

Generate PostgreSQL full-text search SQL.

pub fn to_mysql_sql(&self, table: &str) -> QueryResult<SearchSql>

Generate MySQL full-text search SQL.

pub fn to_sqlite_sql( &self, table: &str, fts_table: &str, ) -> QueryResult<SearchSql>

Generate SQLite FTS5 search SQL.

pub fn to_mssql_sql(&self, table: &str) -> QueryResult<SearchSql>

Generate MSSQL full-text search SQL.

pub fn to_sql( &self, table: &str, db_type: DatabaseType, ) -> QueryResult<SearchSql>

Generate search SQL for the specified database type.

Trait Implementations

impl Clone for SearchQuery

fn clone(&self) -> SearchQuery

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchQuery

fn eq(&self, other: &SearchQuery) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchQuery