| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Text.Search.Sphinx.Types
Synopsis
- 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 Query = Query {
- queryString :: Text
- queryIndexes :: Text
- queryComment :: Text
- data VerCommand
- data SearchdCommand
- data Filter
- data QueryStatus
- data Status
- data SingleResult
- data QueryResult = QueryResult {
- matches :: [Match]
- total :: Int
- totalFound :: Int
- words :: [(Text, Int, Int)]
- attributeNames :: [ByteString]
- data Rank
- data MatchMode
- data Sort
- data AttrT
- data GroupByFunction
- fromEnumFilter :: Num a => Filter -> a
- toStatus :: Int -> Status
- searchdCommand :: SearchdCommand -> Int
- verCommand :: Num a => VerCommand -> a
- toQueryStatus :: Int -> QueryStatus
- exclude :: Filter -> Filter
- toAttrT :: (Eq a, Num a) => a -> AttrT
- attrT :: Num a => AttrT -> a
- attrMultiMask :: Integer
- data ByteString
Documentation
a result returned from searchd
Constructors
| Match | |
Fields
| |
Constructors
| AttrMulti [Attr] | |
| AttrUInt Int | |
| AttrBigInt Int64 | |
| AttrString Text | |
| AttrFloat Float |
Data structure representing one query. It can be sent with runQueries
or runQueries' to the server in batch mode.
Constructors
| Query | |
Fields
| |
data VerCommand Source #
Current client-side command implementation versions
Constructors
| VcSearch | |
| VcExcerpt | |
| VcUpdate | |
| VcKeywords |
Instances
| Show VerCommand Source # | |
Defined in Text.Search.Sphinx.Types Methods showsPrec :: Int -> VerCommand -> ShowS # show :: VerCommand -> String # showList :: [VerCommand] -> ShowS # | |
data SearchdCommand Source #
Search commands
Constructors
| ScSearch | |
| ScExcerpt | |
| ScUpdate | |
| ScKeywords |
Instances
| Enum SearchdCommand Source # | |
Defined in Text.Search.Sphinx.Types Methods succ :: SearchdCommand -> SearchdCommand # pred :: SearchdCommand -> SearchdCommand # toEnum :: Int -> SearchdCommand # fromEnum :: SearchdCommand -> Int # enumFrom :: SearchdCommand -> [SearchdCommand] # enumFromThen :: SearchdCommand -> SearchdCommand -> [SearchdCommand] # enumFromTo :: SearchdCommand -> SearchdCommand -> [SearchdCommand] # enumFromThenTo :: SearchdCommand -> SearchdCommand -> SearchdCommand -> [SearchdCommand] # | |
| Show SearchdCommand Source # | |
Defined in Text.Search.Sphinx.Types Methods showsPrec :: Int -> SearchdCommand -> ShowS # show :: SearchdCommand -> String # showList :: [SearchdCommand] -> ShowS # | |
Filter types
Constructors
| ExclusionFilter Filter | |
| FilterValues String [Int64] | |
| FilterRange String Int64 Int64 | |
| FilterFloatRange String Float Float |
data QueryStatus Source #
status from an individual query
Constructors
| QueryOK | |
| QueryWARNING | |
| QueryERROR Int |
Instances
| Show QueryStatus Source # | |
Defined in Text.Search.Sphinx.Types Methods showsPrec :: Int -> QueryStatus -> ShowS # show :: QueryStatus -> String # showList :: [QueryStatus] -> ShowS # | |
Searchd status codes
data SingleResult Source #
a single query result, runQueries returns a list of these
Constructors
| QueryOk QueryResult | |
| QueryWarning Text QueryResult | |
| QueryError Int Text |
Instances
| Show SingleResult Source # | |
Defined in Text.Search.Sphinx.Types Methods showsPrec :: Int -> SingleResult -> ShowS # show :: SingleResult -> String # showList :: [SingleResult] -> ShowS # | |
data QueryResult Source #
The result of a query
Constructors
| QueryResult | |
Fields
| |
Instances
| Show QueryResult Source # | |
Defined in Text.Search.Sphinx.Types Methods showsPrec :: Int -> QueryResult -> ShowS # show :: QueryResult -> String # showList :: [QueryResult] -> ShowS # | |
Match modes
Instances
| Enum MatchMode Source # | |
Defined in Text.Search.Sphinx.Types Methods succ :: MatchMode -> MatchMode # pred :: MatchMode -> MatchMode # fromEnum :: MatchMode -> Int # enumFrom :: MatchMode -> [MatchMode] # enumFromThen :: MatchMode -> MatchMode -> [MatchMode] # enumFromTo :: MatchMode -> MatchMode -> [MatchMode] # enumFromThenTo :: MatchMode -> MatchMode -> MatchMode -> [MatchMode] # | |
| Show MatchMode Source # | |
Sort modes
Constructors
| Relevance | |
| AttrDesc | |
| AttrAsc | |
| TimeSegments | |
| SortExtended | |
| Expr |
Attribute types
Constructors
| AttrTUInt | |
| AttrTTimestamp | |
| AttrTStr2Ordinal | |
| AttrTBool | |
| AttrTFloat | |
| AttrTBigInt | |
| AttrTString | |
| AttrTWordCount | |
| AttrTMulti AttrT |
data GroupByFunction Source #
Grouping functions
Instances
| Enum GroupByFunction Source # | |
Defined in Text.Search.Sphinx.Types Methods succ :: GroupByFunction -> GroupByFunction # pred :: GroupByFunction -> GroupByFunction # toEnum :: Int -> GroupByFunction # fromEnum :: GroupByFunction -> Int # enumFrom :: GroupByFunction -> [GroupByFunction] # enumFromThen :: GroupByFunction -> GroupByFunction -> [GroupByFunction] # enumFromTo :: GroupByFunction -> GroupByFunction -> [GroupByFunction] # enumFromThenTo :: GroupByFunction -> GroupByFunction -> GroupByFunction -> [GroupByFunction] # | |
| Show GroupByFunction Source # | |
Defined in Text.Search.Sphinx.Types Methods showsPrec :: Int -> GroupByFunction -> ShowS # show :: GroupByFunction -> String # showList :: [GroupByFunction] -> ShowS # | |
fromEnumFilter :: Num a => Filter -> a Source #
searchdCommand :: SearchdCommand -> Int Source #
verCommand :: Num a => VerCommand -> a Source #
Important! 2.0 compatible
toQueryStatus :: Int -> QueryStatus Source #
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.