-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Haskell bindings to the Sphinx full-text searching deamon.
--   
--   Haskell bindings to the Sphinx full-text searching deamon. This module
--   is heavily inspired by the php and python client.
@package sphinx
@version 0.0


-- | This is the Haskell version of the Sphinx searchd client.
module Text.Search.Sphinx

-- | The configuration for a query
data Configuration
Configuration :: String -> PortID -> Int -> Int -> Int -> Int -> Int -> String -> Int -> Int -> String -> Configuration

-- | The hostname of the Sphinx daemon
host :: Configuration -> String

-- | The portnumber of the Sphinx daemon
port :: Configuration -> PortID

-- | How many records to seek from result-set start (default is 0)
offset :: Configuration -> Int

-- | How many records to return from result-set starting at offset (default
--   is 20)
limit :: Configuration -> Int

-- | Query matching mode
mode :: Configuration -> Int

-- | Ranking mode
ranker :: Configuration -> Int

-- | Match sorting mode
sort :: Configuration -> Int

-- | Attribute to sort by
sortBy :: Configuration -> String

-- | Minimum ID to match, 0 means no limit
minId :: Configuration -> Int

-- | Maximum ID to match, 0 means no limit
maxId :: Configuration -> Int

-- | Group-by sorting clause (to sort groups in result set with)
groupSort :: Configuration -> String

-- | A basic, default configuration.
query :: Configuration -> String -> IO [SearchResult]
defaultConfig :: Configuration