Search Index

POST /{appname}/search/{servicename}/_query

Query the search index by including a JSON object containing a query property with the value of your search string. You can optionally include:

• a fields property containing a list of fields you would like to target the search against
• a filter property which is an object of key/value pairs to filter the search results

Parameters

Path parameters

• appname - string - the name of your hyper cloud application.
• servicename - string - the name of your hyper cloud service.

Request Body

• query - string - the text you would like to search for matches
• fields - array[string] - a list of fields you would like to target the search against [optional]
  • Each string in the array should match a property in the Fields to store list in the indexed document. See Adding a Search Service.
• filter - object - this object contains key/value pairs that should reduce the results based on the result of the filter. [optional]. Each key should match a property in the Fields to store list that you provided when you created the search index. See Adding a Search Service.

{
    "query": "Ghostbusters",
    "fields": ["title"],
    "filter": {"year": "1984"}
}

Examples

We are searching for all books within the default index where the author is "Frank Herbert".

import { connect } from 'hyper-connect'

const hyper = connect(process.env.HYPER)

const author = 'Frank Herbert'

const result = await hyper.search.query(author, { fields: ['author'] })

console.log(result)

Responses