Safe Haskell	Safe
Language	Haskell98

Text.Search.Sphinx.Configuration

Synopsis

Documentation

data Configuration #

The configuration for a query

A note about encodings: The encoding specified here is used to encode every Text value that is sent to the server, and it used to decode all of the server's answers, including error messages.

If the specified encoding doesn't support characters sent to the server, they will silently be substituted with the byte value of '\SUB' :: Char before transmission.

If the server sends a byte value back that the encoding doesn't understand, the affected bytes will be converted into special values as specified by that encoding. For example, when decoding invalid UTF-8, all invalid bytes are going to be substituted with '\65533' :: Char.

Constructors

Configuration

Fields

host :: String
The hostname of the Sphinx daemon
port :: Int
The portnumber of the Sphinx daemon
encoding :: String
Encoding used to encode queries to the server, and decode server responses
weights :: [Int]
Per-field weights
offset :: Int
How many records to seek from result-set start (default is 0)
limit :: Int
How many records to return from result-set starting at offset (default is 20)
mode :: MatchMode
Query matching mode
ranker :: Rank
Ranking mode
sort :: Sort
Match sorting mode
sortBy :: String
Attribute to sort by
minId :: Int
Minimum ID to match, 0 means no limit
maxId :: Int
Maximum ID to match, 0 means no limit
filters :: [Filter]
attribute filters
groupBy :: String
Group-by sorting clause (to sort groups in result set with)
groupSort :: String
Group-by count-distinct attribute
groupByFunc :: GroupByFunction
Group-by function (to pre-process group-by attribute value with)
groupDistinct :: String
Group-by attribute name
maxMatches :: Int
Maximum number of matches to retrieve
cutoff :: Int
Cutoff to stop searching at
retryCount :: Int
Distributed retries count
retryDelay :: Int
Distributed retries delay
indexWeights :: [(String, Int)]
Per-index weights
maxQueryTime :: Int
Maximum query time in milliseconds, 0 means no limit
fieldWeights :: [(String, Int)]
Per-field-name weights
selectClause :: String
attributes to select, defaults to "*"

Instances

Show Configuration #
Methods showsPrec :: Int -> Configuration -> ShowS # show :: Configuration -> String # showList :: [Configuration] -> ShowS #

defaultConfig :: Configuration #

A basic, default configuration.