Method Detail

• boolQuery

  public static io.vertx.core.json.JsonObject boolQuery()

  Create a query that allows for boolean combinations of other queries

  Returns:

  the query

• boolQuery

  public static io.vertx.core.json.JsonObject boolQuery(int minimumShouldMatch)

  Create a query that allows for boolean combinations of other queries

  Parameters:

  minimumShouldMatch - the minimum number of should clauses to match

  Returns:

  the query

  Since:

  1.1.0

• boolAddFilter

  public static void boolAddFilter(io.vertx.core.json.JsonObject bool,
                                   io.vertx.core.json.JsonObject filter)

  Add a filter to a bool query. Do not add it if the clause already exists in the query.

  Parameters:

  bool - the bool query

  filter - the filter to add

• boolAddMust

  public static void boolAddMust(io.vertx.core.json.JsonObject bool,
                                 io.vertx.core.json.JsonObject must)

  Add a "must" clause to a bool query. Do not add it if the clause already exists in the query.

  Parameters:

  bool - the bool query

  must - the clause to add

• boolAddMustNot

  public static void boolAddMustNot(io.vertx.core.json.JsonObject bool,
                                    io.vertx.core.json.JsonObject mustNot)

  Add a "must_not" clause to a bool query. Do not add it if the clause already exists in the query.

  Parameters:

  bool - the bool query

  mustNot - the clause to add

• boolAddShould

  public static void boolAddShould(io.vertx.core.json.JsonObject bool,
                                   io.vertx.core.json.JsonObject should)

  Add a "should" clause to a bool query. Do not add it if the clause already exists in the query.

  Parameters:

  bool - the bool query

  should - the clause to add

• termQuery

  public static io.vertx.core.json.JsonObject termQuery(java.lang.String name,
                                                        java.lang.Object value)

  Create a term query to exactly compare a field to a value

  Parameters:

  name - the field's name

  value - the value to compare to

  Returns:

  the term query

• ltQuery

  public static io.vertx.core.json.JsonObject ltQuery(java.lang.String name,
                                                      java.lang.Object value)

  Create a term query to compare a field to a value using less than as operator.

  Parameters:

  name - the field's name

  value - the value to compare to

  Returns:

  the term query

  Since:

  1.1.0

• lteQuery

  public static io.vertx.core.json.JsonObject lteQuery(java.lang.String name,
                                                       java.lang.Object value)

  Create a term query to compare a field to a value using less than or equal to as operator.

  Parameters:

  name - the field's name

  value - the value to compare to

  Returns:

  the term query

  Since:

  1.1.0

• gtQuery

  public static io.vertx.core.json.JsonObject gtQuery(java.lang.String name,
                                                      java.lang.Object value)

  Create a term query to compare a field to a value using greater than as operator.

  Parameters:

  name - the field's name

  value - the value to compare to

  Returns:

  the term query

  Since:

  1.1.0

• gteQuery

  public static io.vertx.core.json.JsonObject gteQuery(java.lang.String name,
                                                       java.lang.Object value)

  Create a term query to compare a field to a value using greater than or equal to as operator.

  Parameters:

  name - the field's name

  value - the value to compare to

  Returns:

  the term query

  Since:

  1.1.0

• matchAllQuery

  public static io.vertx.core.json.JsonObject matchAllQuery()

  Create a query that matches all documents

  Returns:

  the query

• multiMatchQuery

  public static io.vertx.core.json.JsonObject multiMatchQuery(java.lang.Object text,
                                                              java.lang.String... fieldNames)

  Create a query that compares a value to multiple fields

  Parameters:

  text - the value

  fieldNames - the names of the fields to compare to

  Returns:

  the query

• existsQuery

  public static io.vertx.core.json.JsonObject existsQuery(java.lang.String name)

  Create a query that looks if a field with the given name exists

  Parameters:

  name - the field's name

  Returns:

  the query

  Since:

  1.1.0

• prefixQuery

  public static io.vertx.core.json.JsonObject prefixQuery(java.lang.String name,
                                                          java.lang.Object prefix)

  Create a query that looks for a field starting with a given prefix

  Parameters:

  name - the field's name

  prefix - the prefix

  Returns:

  the query

• geoShapeQuery

  public static io.vertx.core.json.JsonObject geoShapeQuery(java.lang.String name,
                                                            io.vertx.core.json.JsonObject shape,
                                                            java.lang.String relation)

  Create a query that looks for documents matching a geo shape

  Parameters:

  name - the field name containing the document's geo shape

  shape - the geo shape to compare to

  relation - the relation used for comparison (i.e. "intersects", "disjoint", "within", "contains")

  Returns:

  the query

• shape

  public static io.vertx.core.json.JsonObject shape(java.lang.String type,
                                                    io.vertx.core.json.JsonArray coordinates)

  Create a geo shape

  Parameters:

  type - the shape's type (e.g. "envelope")

  coordinates - the shape's coordinates

  Returns:

  the shape