Search Results for

    Show / Hide Table of Contents

    Class QueryBase

    Inheritance
    object
    QueryBase
    BoolQuery
    BoostingQuery
    ConstantScoreQuery
    DisMaxQuery
    ExistsQuery
    FieldNameQueryBase
    FunctionScoreQuery
    HasChildQuery
    HasParentQuery
    IdsQuery
    MatchAllQuery
    MatchNoneQuery
    MoreLikeThisQuery
    MultiMatchQuery
    NestedQuery
    ParentIdQuery
    PercolateQuery
    QueryStringQuery
    RawQuery
    ScriptQuery
    ScriptScoreQuery
    SimpleQueryStringQuery
    SpanContainingQuery
    SpanFieldMaskingQuery
    SpanFirstQuery
    SpanGapQuery
    SpanMultiTermQuery
    SpanNearQuery
    SpanNotQuery
    SpanOrQuery
    SpanWithinQuery
    Implements
    IQuery
    Inherited Members
    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 abstract class QueryBase : IQuery

    Properties

    | Edit this page View Source

    Boost

    Provides a boost to this query to influence its relevance score. For example, a query with a boost of 2 is twice as important as a query with a boost of 1, although the actual boost value that is applied undergoes normalization and internal optimization.

    Declaration
    public double? Boost { get; set; }
    Property Value
    Type Description
    double?
    Remarks

    Setting a boost for an ISpanOrQuery query will throw a parsing exception on the server.

    | Edit this page View Source

    Conditionless

    Declaration
    protected abstract bool Conditionless { get; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    IsStrict

    Whether the query should be treated as strict. A strict query will throw an exception when serialized if it is Conditionless.

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

    IsVerbatim

    Whether the query should be treated as verbatim. A verbatim query will be serialized as part of the request, irrespective of whether it is Conditionless or not.

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

    IsWritable

    Whether the query should be treated as writable. Used when determining how to combine queries.

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

    Name

    The name of the query. Allows you to retrieve for each document what part of the query it matched on.

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

    Operators

    | Edit this page View Source

    operator &(QueryBase, QueryBase)

    Declaration
    public static QueryBase operator &(QueryBase leftQuery, QueryBase rightQuery)
    Parameters
    Type Name Description
    QueryBase leftQuery
    QueryBase rightQuery
    Returns
    Type Description
    QueryBase
    | Edit this page View Source

    operator |(QueryBase, QueryBase)

    Declaration
    public static QueryBase operator |(QueryBase leftQuery, QueryBase rightQuery)
    Parameters
    Type Name Description
    QueryBase leftQuery
    QueryBase rightQuery
    Returns
    Type Description
    QueryBase
    | Edit this page View Source

    operator false(QueryBase)

    Declaration
    public static bool operator false(QueryBase a)
    Parameters
    Type Name Description
    QueryBase a
    Returns
    Type Description
    bool
    | Edit this page View Source

    implicit operator QueryContainer(QueryBase)

    Declaration
    public static implicit operator QueryContainer(QueryBase query)
    Parameters
    Type Name Description
    QueryBase query
    Returns
    Type Description
    QueryContainer
    | Edit this page View Source

    operator !(QueryBase)

    Declaration
    public static QueryBase operator !(QueryBase query)
    Parameters
    Type Name Description
    QueryBase query
    Returns
    Type Description
    QueryBase
    | Edit this page View Source

    operator true(QueryBase)

    Declaration
    public static bool operator true(QueryBase a)
    Parameters
    Type Name Description
    QueryBase a
    Returns
    Type Description
    bool
    | Edit this page View Source

    operator +(QueryBase)

    Declaration
    public static QueryBase operator +(QueryBase query)
    Parameters
    Type Name Description
    QueryBase query
    Returns
    Type Description
    QueryBase

    Implements

    IQuery

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Boost
      • Conditionless
      • IsStrict
      • IsVerbatim
      • IsWritable
      • Name
    • Operators
      • operator &(QueryBase, QueryBase)
      • operator |(QueryBase, QueryBase)
      • operator false(QueryBase)
      • implicit operator QueryContainer(QueryBase)
      • operator !(QueryBase)
      • operator true(QueryBase)
      • operator +(QueryBase)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX