Hunt.Query.Processor

The query processor to perform Querys.

processQuery executes the query and generates the unranked result. The result can be ranked with the default rank function.

Documentation

processQueryScoredDocs :: ProcessEnv -> Query -> IO (Either CmdError ScoredDocs)

processQueryUnScoredDocs :: ProcessEnv -> Query -> IO (Either CmdError UnScoredDocs)

processQueryScoredWords :: ProcessEnv -> Query -> IO (Either CmdError ScoredWords)

initProcessor :: ProcessConfig -> QueryIndex -> ProcessEnv

Initialize the state of the processor.

data ProcessConfig

Query processor configuration.

Constructors

ProcessConfig

Fields

fuzzyConfig :: !FuzzyConfig

The configuration for fuzzy queries.

optimizeQuery :: !Bool

Optimize the query before processing (default: False).

wordLimit :: !Int

The maximum number of words used from a prefix. 0 = no limit (default: 100).

docLimit :: !Int

The maximum number of documents taken into account. 0 = no limit (default: 500).

Instances

Binary ProcessConfig

Default ProcessConfig

data ProcessEnv

The internal state of the query processor.