Package org.elasticsearch.index.query

Class QueryStringQueryBuilder

    • Constructor Detail

      • QueryStringQueryBuilder

        public QueryStringQueryBuilder​(java.lang.String queryString)

      • QueryStringQueryBuilder

        public QueryStringQueryBuilder​(StreamInput in)
                        throws java.io.IOException
        Read from a stream.
        Throws:
        java.io.IOException

    • Method Detail

      • queryString

        public java.lang.String queryString()

      • defaultField

        public QueryStringQueryBuilder defaultField​(java.lang.String defaultField)
        The default field to run against when no prefix field is specified. Only relevant when not explicitly adding fields the query string will run against.

      • defaultField

        public java.lang.String defaultField()

      • useAllFields

        @Deprecated
public java.lang.Boolean useAllFields()
        Deprecated.

      • field

        public QueryStringQueryBuilder field​(java.lang.String field,
                                     float boost)
        Adds a field to run the query string against with a specific boost.

      • fields

        public QueryStringQueryBuilder fields​(java.util.Map<java.lang.String,​java.lang.Float> fields)
        Add several fields to run the query against with a specific boost.

      • fields

        public java.util.Map<java.lang.String,​java.lang.Float> fields()
        Returns the fields including their respective boosts to run the query against.

      • useDisMax

        @Deprecated
public QueryStringQueryBuilder useDisMax​(boolean useDisMax)
        Deprecated.
        Use tieBreaker instead.

      • useDisMax

        @Deprecated
public boolean useDisMax()
        Deprecated.
        Use tieBreaker instead.

      • tieBreaker

        public QueryStringQueryBuilder tieBreaker​(float tieBreaker)
        When more than one field is used with the query string, and combined queries are using dis max, control the tie breaker for it.

      • tieBreaker

        public java.lang.Float tieBreaker()

      • defaultOperator

        public QueryStringQueryBuilder defaultOperator​(Operator defaultOperator)
        Sets the boolean operator of the query parser used to parse the query string.

        In default mode (Operator.OR) terms without any modifiers are considered optional: for example capital of Hungary is equal to capital OR of OR Hungary.

        In Operator.AND mode terms are considered to be in conjunction: the above mentioned query is parsed as capital AND of AND Hungary

      • defaultOperator

        public Operator defaultOperator()

      • analyzer

        public QueryStringQueryBuilder analyzer​(java.lang.String analyzer)
        The optional analyzer used to analyze the query string. Note, if a field has search analyzer defined for it, then it will be used automatically. Defaults to the smart search analyzer.

      • analyzer

        public java.lang.String analyzer()
        The optional analyzer used to analyze the query string. Note, if a field has search analyzer defined for it, then it will be used automatically. Defaults to the smart search analyzer.

      • quoteAnalyzer

        public java.lang.String quoteAnalyzer()
        The optional analyzer used to analyze the query string for phrase searches. Note, if a field has search (quote) analyzer defined for it, then it will be used automatically. Defaults to the smart search analyzer.

      • quoteAnalyzer

        public QueryStringQueryBuilder quoteAnalyzer​(java.lang.String quoteAnalyzer)
        The optional analyzer used to analyze the query string for phrase searches. Note, if a field has search (quote) analyzer defined for it, then it will be used automatically. Defaults to the smart search analyzer.

      • autoGeneratePhraseQueries

        @Deprecated
public QueryStringQueryBuilder autoGeneratePhraseQueries​(boolean autoGeneratePhraseQueries)
        Deprecated.
        This setting is ignored

      • autoGeneratePhraseQueries

        @Deprecated
public boolean autoGeneratePhraseQueries()
        Deprecated.
        This setting is ignored

      • maxDeterminizedStates

        public QueryStringQueryBuilder maxDeterminizedStates​(int maxDeterminizedStates)
        Protects against too-difficult regular expression queries.

      • maxDeterminizedStates

        public int maxDeterminizedStates()

      • allowLeadingWildcard

        public QueryStringQueryBuilder allowLeadingWildcard​(java.lang.Boolean allowLeadingWildcard)
        Should leading wildcards be allowed or not. Defaults to true.

      • allowLeadingWildcard

        public java.lang.Boolean allowLeadingWildcard()

      • enablePositionIncrements

        public QueryStringQueryBuilder enablePositionIncrements​(boolean enablePositionIncrements)
        Set to true to enable position increments in result query. Defaults to true.

        When set, result phrase and multi-phrase queries will be aware of position increments. Useful when e.g. a StopFilter increases the position increment of the token that follows an omitted token.

      • enablePositionIncrements

        public boolean enablePositionIncrements()

      • fuzzyPrefixLength

        public QueryStringQueryBuilder fuzzyPrefixLength​(int fuzzyPrefixLength)
        Set the minimum prefix length for fuzzy queries. Default is 1.

      • fuzzyPrefixLength

        public int fuzzyPrefixLength()

      • fuzzyMaxExpansions

        public int fuzzyMaxExpansions()

      • fuzzyRewrite

        public java.lang.String fuzzyRewrite()

      • phraseSlop

        public QueryStringQueryBuilder phraseSlop​(int phraseSlop)
        Sets the default slop for phrases. If zero, then exact phrase matches are required. Default value is zero.

      • phraseSlop

        public int phraseSlop()

      • analyzeWildcard

        public QueryStringQueryBuilder analyzeWildcard​(java.lang.Boolean analyzeWildcard)
        Set to true to enable analysis on wildcard and prefix queries.

      • analyzeWildcard

        public java.lang.Boolean analyzeWildcard()

      • rewrite

        public java.lang.String rewrite()

      • minimumShouldMatch

        public java.lang.String minimumShouldMatch()

      • quoteFieldSuffix

        public QueryStringQueryBuilder quoteFieldSuffix​(java.lang.String quoteFieldSuffix)
        An optional field name suffix to automatically try and add to the field searched when using quoted text.

      • quoteFieldSuffix

        public java.lang.String quoteFieldSuffix()

      • lenient

        public QueryStringQueryBuilder lenient​(java.lang.Boolean lenient)
        Sets the query string parser to be lenient when parsing field values, defaults to the index setting and if not set, defaults to false.

      • lenient

        public java.lang.Boolean lenient()

      • timeZone

        public QueryStringQueryBuilder timeZone​(java.lang.String timeZone)
        In case of date field, we can adjust the from/to fields using a timezone

      • timeZone

        public org.joda.time.DateTimeZone timeZone()

      • escape

        public QueryStringQueryBuilder escape​(boolean escape)
        Set to true to enable escaping of the query string

      • escape

        public boolean escape()

      • splitOnWhitespace

        @Deprecated
public QueryStringQueryBuilder splitOnWhitespace​(boolean value)
        Deprecated.
        This setting is ignored, this query parser splits on operator only.

      • splitOnWhitespace

        @Deprecated
public boolean splitOnWhitespace()
        Deprecated.
        This setting is ignored, this query parser splits on operator only.

      • autoGenerateSynonymsPhraseQuery

        public QueryStringQueryBuilder autoGenerateSynonymsPhraseQuery​(boolean value)

      • autoGenerateSynonymsPhraseQuery

        public boolean autoGenerateSynonymsPhraseQuery()
        Whether phrase queries should be automatically generated for multi terms synonyms. Defaults to true.

      • fuzzyTranspositions

        public boolean fuzzyTranspositions()

      • fuzzyTranspositions

        public QueryStringQueryBuilder fuzzyTranspositions​(boolean fuzzyTranspositions)
        Sets whether transpositions are supported in fuzzy queries.

        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.

      • getWriteableName

        public java.lang.String getWriteableName()
        Description copied from interface: NamedWriteable
        Returns the name of the writeable object