Database.Esqueleto.TextSearch.Language

Documentation

(@@.)

Arguments

:: SqlExpr (Value TsVector)

the document to search in

-> SqlExpr (Value (TsQuery Lexemes))

the query made by prefixAndQuery

-> SqlExpr (Value Bool)

Apply some query to a tsvector document for example:

searchCompany :: SqlExpr (Entity CompanySearchIndex) -> SearchTerm -> SqlQuery ()
searchCompany company term = do
  let query = prefixAndQuery term
      norm = val []
  where_ $ (company ^. CompanySearchIndexDocument) @@. query

prefixAndQuery :: SearchTerm -> SqlExpr (Value (TsQuery Lexemes))

format the query into lexemes the result can be used in @@. for example:

searchCompany :: SqlExpr (Entity CompanySearchIndex) -> SearchTerm -> SqlQuery ()
searchCompany company term = do
  let query = prefixAndQuery term
      norm = val []
  where_ $ (company ^. CompanySearchIndexDocument) @@. query

this uses && to combine queries

prefixOrQuery :: SearchTerm -> SqlExpr (Value (TsQuery Lexemes))

prefixAndQueryLang :: RegConfig -> SearchTerm -> SqlExpr (Value (TsQuery Lexemes))

specify a language to be used with the query.

prefixOrQueryLang :: RegConfig -> SearchTerm -> SqlExpr (Value (TsQuery Lexemes))

same as prefixAndQueryLang but uses || to combine quereis

toSearchTerm :: Text -> Maybe SearchTerm

Constructs a valid search query, removes a bunch of illegal characters and splits the terms for better results. Also checks if there is anything in the search term.

using a search term is optional, but it's probably what you want. all underlying primitives are exposed.

toSearchTermWeighted :: [Weight] -> Text -> Maybe SearchTerm

create a search term with some weight, this allows for restricting on specific weighs. see: https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES use the semigroup instance on search term to combine searchterms.

data SearchTerm

A valid search term. created with toSearchTerm.

Instances

Semigroup SearchTerm

Defined in Database.Esqueleto.TextSearch.Language

Methods

(<>) :: SearchTerm -> SearchTerm -> SearchTerm

sconcat :: NonEmpty SearchTerm -> SearchTerm

stimes :: Integral b => b -> SearchTerm -> SearchTerm

Show SearchTerm

Defined in Database.Esqueleto.TextSearch.Language

Methods

showsPrec :: Int -> SearchTerm -> ShowS

show :: SearchTerm -> String

showList :: [SearchTerm] -> ShowS

to_tsvector :: IsString a => SqlExpr (Value RegConfig) -> SqlExpr (Value a) -> SqlExpr (Value TsVector)

to_tsquery :: SqlExpr (Value RegConfig) -> SqlExpr (Value (TsQuery Words)) -> SqlExpr (Value (TsQuery Lexemes))

plainto_tsquery :: SqlExpr (Value RegConfig) -> SqlExpr (Value Text) -> SqlExpr (Value (TsQuery Lexemes))

ts_rank

Arguments

:: SqlExpr (Value Weights)

relative weighting of a b c and d, see defaultWeights

-> SqlExpr (Value TsVector)

the document to search in

-> SqlExpr (Value (TsQuery Lexemes))

the query made by prefixAndQuery

-> SqlExpr (Value [NormalizationOption])

normalization option to indicate how to deal with document length

-> SqlExpr (Value Double)

Organize search result by weights. This allows you to put better matching results higher. for example:

searchCompany :: SqlExpr (Entity CompanySearchIndex) -> SearchTerm -> SqlQuery ()
searchCompany company term = do
  let query = prefixAndQuery term
      norm = val []
  where_ $ (company ^. CompanySearchIndexDocument) @@. query
  orderBy [desc (ts_rank (val defaultWeights)
                 (company ^. CompanySearchIndexDocument)
                 query norm)]

ts_rank_cd :: SqlExpr (Value Weights) -> SqlExpr (Value TsVector) -> SqlExpr (Value (TsQuery Lexemes)) -> SqlExpr (Value [NormalizationOption]) -> SqlExpr (Value Double)

setweight :: SqlExpr (Value TsVector) -> SqlExpr (Value Weight) -> SqlExpr (Value TsVector)

ts binary

tsquery_or :: SqlExpr (Value (TsQuery Lexemes)) -> SqlExpr (Value (TsQuery Lexemes)) -> SqlExpr (Value (TsQuery Lexemes))

(||) for tsquery. This function would be called (&&.) but Esqueleto's (&&.) confines that fn to sql boolean expressions. x::tsquery && y::tsquery == to_tsquery('x & y')

tsquery_and :: SqlExpr (Value (TsQuery Lexemes)) -> SqlExpr (Value (TsQuery Lexemes)) -> SqlExpr (Value (TsQuery Lexemes))

(&&) for tsquery. This function would be called (&&.) but Esqueleto's (&&.) confines that fn to sql boolean expressions. x::tsquery && y::tsquery == to_tsquery('x & y')