Database.Esqueleto.TextSearch.Types

Documentation

data TsQuery (a :: QueryType) where

Constructors

Lexeme :: Position -> [Weight] -> Text -> TsQuery Lexemes

Word :: Position -> [Weight] -> Text -> TsQuery Words

(:&) :: TsQuery a -> TsQuery a -> TsQuery a infixr 3

(:|) :: TsQuery a -> TsQuery a -> TsQuery a infixr 2

Not :: TsQuery a -> TsQuery a

Instances

a ~ Words => IsString (TsQuery a)

Defined in Database.Esqueleto.TextSearch.Types

Methods

fromString :: String -> TsQuery a

Show (TsQuery a)

Defined in Database.Esqueleto.TextSearch.Types

Methods

showsPrec :: Int -> TsQuery a -> ShowS

show :: TsQuery a -> String

showList :: [TsQuery a] -> ShowS

Eq (TsQuery a)

Defined in Database.Esqueleto.TextSearch.Types

Methods

(==) :: TsQuery a -> TsQuery a -> Bool

(/=) :: TsQuery a -> TsQuery a -> Bool

PersistField (TsQuery Lexemes)

Defined in Database.Esqueleto.TextSearch.Types

Methods

toPersistValue :: TsQuery Lexemes -> PersistValue

fromPersistValue :: PersistValue -> Either Text (TsQuery Lexemes)

PersistField (TsQuery Words)

Defined in Database.Esqueleto.TextSearch.Types

Methods

toPersistValue :: TsQuery Words -> PersistValue

fromPersistValue :: PersistValue -> Either Text (TsQuery Words)

PersistFieldSql (TsQuery Lexemes)

Defined in Database.Esqueleto.TextSearch.Types

Methods

sqlType :: Proxy (TsQuery Lexemes) -> SqlType

PersistFieldSql (TsQuery Words)

Defined in Database.Esqueleto.TextSearch.Types

Methods

sqlType :: Proxy (TsQuery Words) -> SqlType

type Words = 'Words

type Lexemes = 'Lexemes

data TsVector

Instances

IsString TsVector

Defined in Database.Esqueleto.TextSearch.Types

Methods

fromString :: String -> TsVector

Show TsVector

Defined in Database.Esqueleto.TextSearch.Types

Methods

showsPrec :: Int -> TsVector -> ShowS

show :: TsVector -> String

showList :: [TsVector] -> ShowS

Eq TsVector

Defined in Database.Esqueleto.TextSearch.Types

Methods

(==) :: TsVector -> TsVector -> Bool

(/=) :: TsVector -> TsVector -> Bool

PersistField TsVector

Defined in Database.Esqueleto.TextSearch.Types

Methods

toPersistValue :: TsVector -> PersistValue

fromPersistValue :: PersistValue -> Either Text TsVector

PersistFieldSql TsVector

Defined in Database.Esqueleto.TextSearch.Types

Methods

sqlType :: Proxy TsVector -> SqlType

defaultTsVector :: TsVector

data RegConfig

regconfig is the object identifier type which represents the text search configuration in Postgres: http://www.postgresql.org/docs/9.3/static/datatype-oid.html

this could for example be a language or simple.

Instances

IsString RegConfig

Defined in Database.Esqueleto.TextSearch.Types

Methods

fromString :: String -> RegConfig

Show RegConfig

Defined in Database.Esqueleto.TextSearch.Types

Methods

showsPrec :: Int -> RegConfig -> ShowS

show :: RegConfig -> String

showList :: [RegConfig] -> ShowS

Eq RegConfig

Defined in Database.Esqueleto.TextSearch.Types

Methods

(==) :: RegConfig -> RegConfig -> Bool

(/=) :: RegConfig -> RegConfig -> Bool

PersistField RegConfig

Defined in Database.Esqueleto.TextSearch.Types

Methods

toPersistValue :: RegConfig -> PersistValue

fromPersistValue :: PersistValue -> Either Text RegConfig

PersistFieldSql RegConfig

Defined in Database.Esqueleto.TextSearch.Types

Methods

sqlType :: Proxy RegConfig -> SqlType

data NormalizationOption

ranking functions take an integer normalization option that specifies whether and how a document's length should impact its rank. The integer option controls several behaviors, so it is a bit mask: you can specify one or more behaviors using | (for example, 2|4). https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-RANKING

Constructors

NormNone

0 (the default) ignores the document length

Norm1LogLength

1 divides the rank by 1 + the logarithm of the document length

NormLength

2 divides the rank by the document length

NormMeanHarmDist

4 divides the rank by the mean harmonic distance between extents (this is implemented only by ts_rank_cd)

NormUniqueWords

8 divides the rank by the number of unique words in document

Norm1LogUniqueWords

16 divides the rank by 1 + the logarithm of the number of unique words in document

Norm1Self

32 divides the rank by itself + 1

Instances

Bounded NormalizationOption

Defined in Database.Esqueleto.TextSearch.Types

Methods

minBound :: NormalizationOption

maxBound :: NormalizationOption

Enum NormalizationOption

Defined in Database.Esqueleto.TextSearch.Types

Methods

succ :: NormalizationOption -> NormalizationOption

pred :: NormalizationOption -> NormalizationOption

toEnum :: Int -> NormalizationOption

fromEnum :: NormalizationOption -> Int

enumFrom :: NormalizationOption -> [NormalizationOption]

enumFromThen :: NormalizationOption -> NormalizationOption -> [NormalizationOption]

enumFromTo :: NormalizationOption -> NormalizationOption -> [NormalizationOption]

enumFromThenTo :: NormalizationOption -> NormalizationOption -> NormalizationOption -> [NormalizationOption]

Show NormalizationOption

Defined in Database.Esqueleto.TextSearch.Types

Methods

showsPrec :: Int -> NormalizationOption -> ShowS

show :: NormalizationOption -> String

showList :: [NormalizationOption] -> ShowS

Eq NormalizationOption

Defined in Database.Esqueleto.TextSearch.Types

Methods

(==) :: NormalizationOption -> NormalizationOption -> Bool

(/=) :: NormalizationOption -> NormalizationOption -> Bool

PersistField [NormalizationOption]

Defined in Database.Esqueleto.TextSearch.Types

Methods

toPersistValue :: [NormalizationOption] -> PersistValue

fromPersistValue :: PersistValue -> Either Text [NormalizationOption]

PersistFieldSql [NormalizationOption]

Defined in Database.Esqueleto.TextSearch.Types

Methods

sqlType :: Proxy [NormalizationOption] -> SqlType

data Weight

Constructors

Highest

High

Medium

Low

Instances

Show Weight

Defined in Database.Esqueleto.TextSearch.Types

Methods

showsPrec :: Int -> Weight -> ShowS

show :: Weight -> String

showList :: [Weight] -> ShowS

Eq Weight

Defined in Database.Esqueleto.TextSearch.Types

Methods

(==) :: Weight -> Weight -> Bool

(/=) :: Weight -> Weight -> Bool

PersistField Weight

Defined in Database.Esqueleto.TextSearch.Types

Methods

toPersistValue :: Weight -> PersistValue

fromPersistValue :: PersistValue -> Either Text Weight

PersistFieldSql Weight

Defined in Database.Esqueleto.TextSearch.Types

Methods

sqlType :: Proxy Weight -> SqlType

defaultWeights :: Weights

data Weights

Constructors

Weights

Fields

• dWeight :: !Double
• cWeight :: !Double
• bWeight :: !Double
• aWeight :: !Double

Instances

Show Weights

Defined in Database.Esqueleto.TextSearch.Types

Methods

showsPrec :: Int -> Weights -> ShowS

show :: Weights -> String

showList :: [Weights] -> ShowS

Eq Weights

Defined in Database.Esqueleto.TextSearch.Types

Methods

(==) :: Weights -> Weights -> Bool

(/=) :: Weights -> Weights -> Bool

PersistField Weights

Defined in Database.Esqueleto.TextSearch.Types

Methods

toPersistValue :: Weights -> PersistValue

fromPersistValue :: PersistValue -> Either Text Weights

PersistFieldSql Weights

Defined in Database.Esqueleto.TextSearch.Types

Methods

sqlType :: Proxy Weights -> SqlType

data Position

Constructors

Prefix

Infix

Instances

Show Position

Defined in Database.Esqueleto.TextSearch.Types

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Eq Position

Defined in Database.Esqueleto.TextSearch.Types

Methods

(==) :: Position -> Position -> Bool

(/=) :: Position -> Position -> Bool

word :: Text -> TsQuery Words

queryToText :: TsQuery a -> Text

textToQuery :: Text -> Either ParseError (TsQuery Lexemes)