Function matchAgainst

matchAgainst(
columns: string | string[],
options?: FullTextSearchOptions,
): { $match: { columns: string[]; mode: "boolean" | "natural" } }

Create a full-text search MATCH AGAINST condition (MySQL) SQL: MATCH(columns) AGAINST(searchTerm [IN NATURAL LANGUAGE MODE | IN BOOLEAN MODE])

Parameters

columns: string | string[]
Optionaloptions: FullTextSearchOptions

Returns { $match: { columns: string[]; mode: "boolean" | "natural" } }

Example

// Natural language mode search
import { matchAgainst } from 'orm';
Article.findAll({
  where: {
    [matchAgainst(['title', 'body'])]: 'database'
  }
})
// SQL: WHERE MATCH(title, body) AGAINST('database' IN NATURAL LANGUAGE MODE)

// Boolean mode search
Article.findAll({
  where: {
    [matchAgainst(['title', 'body'], { mode: 'boolean' })]: '+mysql -oracle'
  }
})
// SQL: WHERE MATCH(title, body) AGAINST('+mysql -oracle' IN BOOLEAN MODE)

Function matchAgainst

Parameters

Returns { $match: { columns: string[]; mode: "boolean" | "natural" } }

Example

Settings