Class SearchQueryBuilder

Joins two sets of queries with an AND clause.

const query = new SearchQueryBuilder()
  .match("Lakes")
  .in("title")
  .and()
  .match("Rivers")
  .in("title")
Copy

Boosts the previous term to increase its rank in the results.

const query = new SearchQueryBuilder()
  .match("Lakes")
  .in("title")
  .or()
  .match("Rivers")
  .in("title")
  .boost(3)
Copy

Returns a new instance of SearchQueryBuilder based on the current instance.

Ends a search group.

const query = new SearchQueryBuilder()
  .startGroup()
    .match("Lakes")
    .in("title")
  .endGroup()
  .or()
  .startGroup()
    .match("Rivers")
    .in("title")
  .endGroup()
Copy

Begins a new range query.

const NEWYEARS = new Date("2020-01-01")
const TODAY = new Date()

const query = new SearchQueryBuilder()
  .from(NEWYEARS)
  .to(TODAY)
  .in("created")
Copy

Defines fields to search in. You can pass "*" or call this method without arguments to search a default set of fields

const query = new SearchQueryBuilder()
  .match("My Layer")
  .in("title")
Copy

Defines strings to search for.

const query = new SearchQueryBuilder()
  .match("My Layer")
Copy

Joins two sets of queries with a NOT clause. Another option for filtering results is the prohibit operator '-'.

// omit results with "Rivers" in their title
const query = new SearchQueryBuilder()
  .not()
  .match("Rivers")
  .in("title")

// equivalent
const query = new SearchQueryBuilder()
  .match("Rivers")
  .in("-title")
Copy

Joins two sets of queries with an OR clause.

const query = new SearchQueryBuilder()
  .match("Lakes")
  .in("title")
  .or()
  .match("Rivers")
  .in("title")
Copy

Starts a new search group.

const query = new SearchQueryBuilder()
  .startGroup()
    .match("Lakes")
    .in("title")
  .endGroup()
  .or()
  .startGroup()
    .match("Rivers")
    .in("title")
  .endGroup()
Copy

Ends a range query.

const query = new SearchQueryBuilder()
  .from(yesterdaysDate)
  .to(todaysDate)
  .in("created")
Copy

Returns the current query string. Called internally when the request is made.