Interface ISimpleQueryStringQuery

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.

Inherited Members

IQuery.Boost

IQuery.Conditionless

IQuery.IsStrict

IQuery.IsVerbatim

IQuery.IsWritable

IQuery.Name

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public interface ISimpleQueryStringQuery : IQuery

Properties

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

[DataMember(Name = "analyze_wildcard")]
bool? AnalyzeWildcard { get; set; }

Property Value

Type	Description
bool?

Analyzer

The analyzer name used to analyze the query

Declaration

[DataMember(Name = "analyzer")]
string Analyzer { get; set; }

Property Value

Type	Description
string

AutoGenerateSynonymsPhraseQuery

Declaration

[DataMember(Name = "auto_generate_synonyms_phrase_query")]
bool? AutoGenerateSynonymsPhraseQuery { get; set; }

Property Value

Type	Description
bool?

DefaultOperator

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

Declaration

[DataMember(Name = "default_operator")]
Operator? DefaultOperator { get; set; }

Property Value

Type	Description
Operator?

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

[DataMember(Name = "fields")]
Fields Fields { get; set; }

Property Value

Type	Description
Fields

Flags

Flags specifying which features to enable. Defaults to All.

Declaration

[DataMember(Name = "flags")]
SimpleQueryStringFlags? Flags { get; set; }

Property Value

Type	Description
SimpleQueryStringFlags?

FuzzyMaxExpansions

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

Declaration

[DataMember(Name = "fuzzy_max_expansions")]
int? FuzzyMaxExpansions { get; set; }

Property Value

Type	Description
int?

FuzzyPrefixLength

Set the prefix length for fuzzy queries. Default is 0

Declaration

[DataMember(Name = "fuzzy_prefix_length")]
int? FuzzyPrefixLength { get; set; }

Property Value

Type	Description
int?

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

[DataMember(Name = "fuzzy_transpositions")]
bool? FuzzyTranspositions { get; set; }

Property Value

Type	Description
bool?

Lenient

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

Declaration

[DataMember(Name = "lenient")]
bool? Lenient { get; set; }

Property Value

Type	Description
bool?

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

[DataMember(Name = "minimum_should_match")]
MinimumShouldMatch MinimumShouldMatch { get; set; }

Property Value

Type	Description
MinimumShouldMatch

Query

The query to be parsed

Declaration

[DataMember(Name = "query")]
string Query { get; set; }

Property Value

Type	Description
string

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

[DataMember(Name = "quote_field_suffix")]
string QuoteFieldSuffix { get; set; }

Property Value

Type	Description
string

Extension Methods

SuffixExtensions.Suffix(object, string)