| Safe Haskell | Safe |
|---|---|
| Language | Haskell98 |
Text.Search.Sphinx.Types
- data Query = Query {
- queryString :: Text
- queryIndexes :: Text
- queryComment :: Text
- data SearchdCommand
- searchdCommand :: SearchdCommand -> Int
- data VerCommand
- verCommand :: Num a => VerCommand -> a
- data Status
- data QueryStatus
- toQueryStatus :: Int -> QueryStatus
- toStatus :: Int -> Status
- data MatchMode
- data Rank
- data Sort
- data Filter
- exclude :: Filter -> Filter
- fromEnumFilter :: Num a => Filter -> a
- data AttrT
- toAttrT :: (Eq a, Num a) => a -> AttrT
- attrMultiMask :: Integer
- attrT :: Num a => AttrT -> a
- data GroupByFunction
- data QueryResult = QueryResult {
- matches :: [Match]
- total :: Int
- totalFound :: Int
- words :: [(Text, Int, Int)]
- attributeNames :: [ByteString]
- data SingleResult
- = QueryOk QueryResult
- | QueryWarning Text QueryResult
- | QueryError Int Text
- data Result a
- data Match = Match {
- documentId :: Int64
- documentWeight :: Int
- attributeValues :: [Attr]
- data Attr
- = AttrMulti [Attr]
- | AttrUInt Int
- | AttrBigInt Int64
- | AttrString Text
- | AttrFloat Float
- data ByteString :: *
Documentation
Data structure representing one query. It can be sent with runQueries
or runQueries' to the server in batch mode.
Constructors
| Query | |
Fields
| |
data SearchdCommand Source
Search commands
Constructors
| ScSearch | |
| ScExcerpt | |
| ScUpdate | |
| ScKeywords |
Instances
data VerCommand Source
Current client-side command implementation versions
Constructors
| VcSearch | |
| VcExcerpt | |
| VcUpdate | |
| VcKeywords |
Instances
verCommand :: Num a => VerCommand -> a Source
Important! 2.0 compatible
Searchd status codes
data QueryStatus Source
status from an individual query
Constructors
| QueryOK | |
| QueryWARNING | |
| QueryERROR Int |
Instances
toQueryStatus :: Int -> QueryStatus Source
Match modes
Ranking modes (ext2 only)
Sort modes
Constructors
| Relevance | |
| AttrDesc | |
| AttrAsc | |
| TimeSegments | |
| SortExtended | |
| Expr |
Filter types
Constructors
| ExclusionFilter Filter | |
| FilterValues String [Int64] | |
| FilterRange String Int64 Int64 | |
| FilterFloatRange String Float Float |
fromEnumFilter :: Num a => Filter -> a Source
Attribute types
data QueryResult Source
The result of a query
Constructors
| QueryResult | |
Fields
| |
Instances
data SingleResult Source
a single query result, runQueries returns a list of these
Constructors
| QueryOk QueryResult | |
| QueryWarning Text QueryResult | |
| QueryError Int Text |
Instances
a result returned from searchd
Constructors
| Match | |
Fields
| |
Constructors
| AttrMulti [Attr] | |
| AttrUInt Int | |
| AttrBigInt Int64 | |
| AttrString Text | |
| AttrFloat Float |
data ByteString :: *
A space-efficient representation of a Word8 vector, supporting many
efficient operations.
A lazy ByteString contains 8-bit bytes, or by using the operations
from Data.ByteString.Lazy.Char8 it can be interpreted as containing
8-bit characters.