website logo
⌘K
πŸ–οΈIntroduction to hyper cloud
🍎Getting Started
😍What's New
Blueberry Migration Guide
πŸ’ͺWorkshops
Deno Workshops
NodeJS Workshops
⚑Quickstarts
NodeJS Quickstarts
πŸ”ŒAPI Reference (hyper cloud)
🍎Basics
⚑hyper connect
πŸ”‘JWT Auth
πŸ’ΎData API
🏎️Cache API
πŸ”ŽSearch API
πŸ—„οΈStorage API
πŸ€“Queue API
πŸ”“Sign In
⚑Applications
βš™οΈSettings
πŸ”‘App Keys
πŸ‘₯Teams
Switching Between Accounts
Application Services
Application Service Instances
Adding a Queue Service
Adding a Search Service
Subscriptions
πŸ€‘Upgrade
πŸ“•Terminology
Parameters
πŸ’³Billing
Payment and Pricing Terms
πŸ’ΌLegal
Terms of Service
Acceptable Use Policy
Privacy Policy
πŸ•ΆοΈHyper Vision
Docs powered byΒ archbeeΒ 
11min

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

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.

Node.js
Curl
|

Responses

Status Code

Description

Example Value

200

Successfully created index

{"ok": true}

500

Error occured trying to create index

{"ok": false,"msg": "...."}

Need Help?

You can always reach out to our support team for any additional assistance on slack.

Updated 24 Mar 2022
Did this page help you?
Yes
No
UP NEXT
Run a Query
Docs powered byΒ archbeeΒ 
TABLE OF CONTENTS
POST /{appname}/data/{servicename}/_index
Parameters
Path
Request Body
Request body parameters
Example
Responses
Need Help?