| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Database.Bloodhound.Internal.Newtypes
Synopsis
- newtype From = From Int
- newtype Size = Size Int
- newtype HitFields = HitFields (Map Text [Value])
- type Score = Maybe Double
- newtype ShardId = ShardId {}
- newtype DocId = DocId Text
- newtype FieldName = FieldName Text
- newtype RelationName = RelationName Text
- newtype QueryString = QueryString Text
- newtype CacheName = CacheName Text
- newtype CacheKey = CacheKey Text
- newtype Existence = Existence Bool
- newtype NullValue = NullValue Bool
- newtype CutoffFrequency = CutoffFrequency Double
- newtype Analyzer = Analyzer Text
- newtype MaxExpansions = MaxExpansions Int
- newtype Lenient = Lenient Bool
- newtype Tiebreaker = Tiebreaker Double
- newtype MinimumMatch = MinimumMatch Int
- newtype DisableCoord = DisableCoord Bool
- newtype IgnoreTermFrequency = IgnoreTermFrequency Bool
- newtype MinimumTermFrequency = MinimumTermFrequency Int
- newtype MaxQueryTerms = MaxQueryTerms Int
- newtype PrefixLength = PrefixLength Int
- newtype PercentMatch = PercentMatch Double
- newtype StopWord = StopWord Text
- newtype QueryPath = QueryPath Text
- newtype AllowLeadingWildcard = AllowLeadingWildcard Bool
- newtype LowercaseExpanded = LowercaseExpanded Bool
- newtype EnablePositionIncrements = EnablePositionIncrements Bool
- newtype AnalyzeWildcard = AnalyzeWildcard Bool
- newtype GeneratePhraseQueries = GeneratePhraseQueries Bool
- newtype Locale = Locale Text
- newtype MaxWordLength = MaxWordLength Int
- newtype MinWordLength = MinWordLength Int
- newtype PhraseSlop = PhraseSlop Int
- newtype MinDocFrequency = MinDocFrequency Int
- newtype MaxDocFrequency = MaxDocFrequency Int
- newtype AggregateParentScore = AggregateParentScore Bool
- newtype IgnoreUnmapped = IgnoreUnmapped Bool
- newtype MinChildren = MinChildren Int
- newtype MaxChildren = MaxChildren Int
- newtype POSIXMS = POSIXMS {}
- newtype Boost = Boost Double
- newtype BoostTerms = BoostTerms Double
- newtype ReplicaCount = ReplicaCount Int
- newtype ShardCount = ShardCount Int
- newtype IndexName = IndexName Text
- newtype IndexAliasName = IndexAliasName {}
- newtype MaybeNA a = MaybeNA {}
- newtype SnapshotName = SnapshotName {
- snapshotName :: Text
- newtype MS = MS NominalDiffTime
- unMS :: MS -> NominalDiffTime
- newtype TokenFilter = TokenFilter Text
- newtype CharFilter = CharFilter Text
Documentation
DocId is a generic wrapper value for expressing unique Document IDs.
Can be set by the user or created by ES itself. Often used in client
functions for poking at specific documents.
FieldName is used all over the place wherever a specific field within
a document needs to be specified, usually in Querys or Filters.
newtype RelationName Source #
RelationName describes a relation role between parend and child Documents
in a Join relarionship: https://www.elastic.co/guide/en/elasticsearch/reference/current/parent-join.html
Constructors
| RelationName Text |
Instances
newtype QueryString Source #
QueryString is used to wrap query text bodies, be they human written or not.
Constructors
| QueryString Text |
Instances
CacheKey is used in RegexpFilter to key regex caching.
newtype CutoffFrequency Source #
Constructors
| CutoffFrequency Double |
Instances
newtype MaxExpansions Source #
Constructors
| MaxExpansions Int |
Instances
Lenient, if set to true, will cause format based failures to be
ignored. I don't know what the bloody default is, Elasticsearch
documentation didn't say what it was. Let me know if you figure it out.
newtype Tiebreaker Source #
Constructors
| Tiebreaker Double |
Instances
newtype MinimumMatch Source #
MinimumMatch controls how many should clauses in the bool query should
match. Can be an absolute value (2) or a percentage (30%) or a
combination of both.
Constructors
| MinimumMatch Int |
Instances
newtype DisableCoord Source #
Constructors
| DisableCoord Bool |
Instances
newtype IgnoreTermFrequency Source #
Constructors
| IgnoreTermFrequency Bool |
Instances
newtype MinimumTermFrequency Source #
Constructors
| MinimumTermFrequency Int |
Instances
newtype MaxQueryTerms Source #
Constructors
| MaxQueryTerms Int |
Instances
newtype PrefixLength Source #
PrefixLength is the prefix length used in queries, defaults to 0.
Constructors
| PrefixLength Int |
Instances
newtype PercentMatch Source #
Constructors
| PercentMatch Double |
Instances
newtype AllowLeadingWildcard Source #
Allowing a wildcard at the beginning of a word (eg "*ing") is particularly
heavy, because all terms in the index need to be examined, just in case
they match. Leading wildcards can be disabled by setting
AllowLeadingWildcard to false.
Constructors
| AllowLeadingWildcard Bool |
Instances
newtype LowercaseExpanded Source #
Constructors
| LowercaseExpanded Bool |
Instances
newtype EnablePositionIncrements Source #
Constructors
| EnablePositionIncrements Bool |
Instances
newtype AnalyzeWildcard Source #
By default, wildcard terms in a query are not analyzed.
Setting AnalyzeWildcard to true enables best-effort analysis.
Constructors
| AnalyzeWildcard Bool |
Instances
newtype GeneratePhraseQueries Source #
GeneratePhraseQueries defaults to false.
Constructors
| GeneratePhraseQueries Bool |
Instances
Locale is used for string conversions - defaults to ROOT.
newtype MaxWordLength Source #
Constructors
| MaxWordLength Int |
Instances
newtype MinWordLength Source #
Constructors
| MinWordLength Int |
Instances
newtype PhraseSlop Source #
PhraseSlop sets the default slop for phrases, 0 means exact
phrase matches. Default is 0.
Constructors
| PhraseSlop Int |
Instances
newtype MinDocFrequency Source #
Constructors
| MinDocFrequency Int |
Instances
newtype MaxDocFrequency Source #
Constructors
| MaxDocFrequency Int |
Instances
newtype AggregateParentScore Source #
Indicates whether the relevance score of a matching parent document is aggregated into its child documents.
Constructors
| AggregateParentScore Bool |
Instances
newtype IgnoreUnmapped Source #
Indicates whether to ignore an unmapped parent_type and not return any documents instead of an error.
Constructors
| IgnoreUnmapped Bool |
Instances
newtype MinChildren Source #
Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.
Constructors
| MinChildren Int |
Instances
newtype MaxChildren Source #
Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.
Constructors
| MaxChildren Int |
Instances
Newtype wrapper to parse ES's concerning tendency to in some APIs return a floating point number of milliseconds since epoch ಠ_ಠ
newtype BoostTerms Source #
Constructors
| BoostTerms Double |
Instances
newtype ReplicaCount Source #
ReplicaCount is part of IndexSettings
Constructors
| ReplicaCount Int |
Instances
newtype ShardCount Source #
ShardCount is part of IndexSettings
Constructors
| ShardCount Int |
Instances
IndexName is used to describe which index to querycreatedelete
newtype IndexAliasName Source #
Constructors
| IndexAliasName | |
Fields | |
Instances
| Eq IndexAliasName Source # | |
Defined in Database.Bloodhound.Internal.Newtypes Methods (==) :: IndexAliasName -> IndexAliasName -> Bool # (/=) :: IndexAliasName -> IndexAliasName -> Bool # | |
| Show IndexAliasName Source # | |
Defined in Database.Bloodhound.Internal.Newtypes Methods showsPrec :: Int -> IndexAliasName -> ShowS # show :: IndexAliasName -> String # showList :: [IndexAliasName] -> ShowS # | |
| ToJSON IndexAliasName Source # | |
Defined in Database.Bloodhound.Internal.Newtypes Methods toJSON :: IndexAliasName -> Value # toEncoding :: IndexAliasName -> Encoding # toJSONList :: [IndexAliasName] -> Value # toEncodingList :: [IndexAliasName] -> Encoding # | |
newtype SnapshotName Source #
Constructors
| SnapshotName | |
Fields
| |
Instances
| Eq SnapshotName Source # | |
Defined in Database.Bloodhound.Internal.Newtypes | |
| Show SnapshotName Source # | |
Defined in Database.Bloodhound.Internal.Newtypes Methods showsPrec :: Int -> SnapshotName -> ShowS # show :: SnapshotName -> String # showList :: [SnapshotName] -> ShowS # | |
| ToJSON SnapshotName Source # | |
Defined in Database.Bloodhound.Internal.Newtypes Methods toJSON :: SnapshotName -> Value # toEncoding :: SnapshotName -> Encoding # toJSONList :: [SnapshotName] -> Value # toEncodingList :: [SnapshotName] -> Encoding # | |
| FromJSON SnapshotName Source # | |
Defined in Database.Bloodhound.Internal.Newtypes | |
Milliseconds
Constructors
| MS NominalDiffTime |
unMS :: MS -> NominalDiffTime Source #
newtype TokenFilter Source #
Constructors
| TokenFilter Text |
Instances
newtype CharFilter Source #
Constructors
| CharFilter Text |