Search Results for

    Show / Hide Table of Contents

    Class SimpleQueryStringQuery

    A query that uses the SimpleQueryParser to parse its context. Unlike the regular IQueryStringQuery, the ISimpleQueryStringQuery query will never throw an exception, and discards invalid parts of the query.

    Inheritance
    object
    QueryBase
    SimpleQueryStringQuery
    Implements
    ISimpleQueryStringQuery
    IQuery
    Inherited Members
    QueryBase.Boost
    QueryBase.IsStrict
    QueryBase.IsVerbatim
    QueryBase.IsWritable
    QueryBase.Name
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class SimpleQueryStringQuery : QueryBase, ISimpleQueryStringQuery, IQuery

    Properties

    | Edit this page View Source

    AnalyzeWildcard

    By default, wildcards terms in a query are not analyzed. By setting this value to true, a best effort will be made to analyze those as well.

    Declaration
    public bool? AnalyzeWildcard { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Analyzer

    The analyzer name used to analyze the query

    Declaration
    public string Analyzer { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    AutoGenerateSynonymsPhraseQuery

    Declaration
    public bool? AutoGenerateSynonymsPhraseQuery { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Conditionless

    Declaration
    protected override bool Conditionless { get; }
    Property Value
    Type Description
    bool
    Overrides
    QueryBase.Conditionless
    | Edit this page View Source

    DefaultOperator

    The default operator used if no explicit operator is specified The default operator is Or

    Declaration
    public Operator? DefaultOperator { get; set; }
    Property Value
    Type Description
    Operator?
    | Edit this page View Source

    Fields

    The fields to perform the parsed query against. Defaults to the index.query.default_field index settings, which in turn defaults to . extracts all fields in the mapping that are eligible to term queries and filters the metadata fields.

    Declaration
    public Fields Fields { get; set; }
    Property Value
    Type Description
    Fields
    | Edit this page View Source

    Flags

    Flags specifying which features to enable. Defaults to All.

    Declaration
    public SimpleQueryStringFlags? Flags { get; set; }
    Property Value
    Type Description
    SimpleQueryStringFlags?
    | Edit this page View Source

    FuzzyMaxExpansions

    Controls the number of terms fuzzy queries will expand to. Defaults to 50

    Declaration
    public int? FuzzyMaxExpansions { get; set; }
    Property Value
    Type Description
    int?
    | Edit this page View Source

    FuzzyPrefixLength

    Set the prefix length for fuzzy queries. Default is 0

    Declaration
    public int? FuzzyPrefixLength { get; set; }
    Property Value
    Type Description
    int?
    | Edit this page View Source

    FuzzyTranspositions

    Sets whether transpositions are supported in fuzzy queries. Default is true.

    The default metric used by fuzzy queries to determine a match is the Damerau-Levenshtein distance formula which supports transpositions. Setting transposition to false will switch to classic Levenshtein distance. If not set, Damerau-Levenshtein distance metric will be used.
    Declaration
    public bool? FuzzyTranspositions { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Lenient

    If set to true will cause format based failures (like providing text to a numeric field) to be ignored

    Declaration
    public bool? Lenient { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    MinimumShouldMatch

    A value controlling how many "should" clauses in the resulting boolean query should match. It can be an absolute value, a percentage or a combination of both

    Declaration
    public MinimumShouldMatch MinimumShouldMatch { get; set; }
    Property Value
    Type Description
    MinimumShouldMatch
    | Edit this page View Source

    Query

    The query to be parsed

    Declaration
    public string Query { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    QuoteFieldSuffix

    A suffix to append to fields for quoted parts of the query string. This allows to use a field that has a different analysis chain for exact matching.

    Declaration
    public string QuoteFieldSuffix { get; set; }
    Property Value
    Type Description
    string

    Implements

    ISimpleQueryStringQuery
    IQuery

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • AnalyzeWildcard
      • Analyzer
      • AutoGenerateSynonymsPhraseQuery
      • Conditionless
      • DefaultOperator
      • Fields
      • Flags
      • FuzzyMaxExpansions
      • FuzzyPrefixLength
      • FuzzyTranspositions
      • Lenient
      • MinimumShouldMatch
      • Query
      • QuoteFieldSuffix
    • Implements
    • Extension Methods
    Back to top Generated by DocFX