Create an Index

POST /{appname}/data/{servicename}/_index

Indexes are used to provide fast search when querying a data service. With this command, you can create a specific index that can be applied to your query command, for more efficient response times.

Parameters

Path

• appname - string - path parameters
• servicename - value requirements
  • See Parameters

Request Body

{
  "fields": ["title", "year"],
  "name": "idx-title-year",
  "type": "json"
}

Request body parameters

• fields - JSON array describing the index to create
• name - The name of the index
• type - index type - should always be "JSON"

Example

This example creates an index on the fields named title and year. When querying for both title and year, the datastore can use this index for faster response times.

import { connect } from "hyper-connect";

const hyper = connect(process.env.HYPER);

const result = await hyper.data.index('title-year-idx', ['title', 'year'])

console.log(result)

// => { ok: true }

Responses