Create an index
create_indexIndex a value in a list's items, to find items by it (alias), order, filter or search by it, or hide it from tokens (guard). The index is built in the background: until its buildStatus is ready, anything that uses it fails with INDEX_BUILDING. With wait: true this polls until it's built, at 1 metered request per poll (the result says how many). 1 request, plus the polls.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| list | Yes | The list: its id or pathName | |
| name | No | The index's name | |
| tags | No | Tags (at most 20). Replaces the existing tags | |
| wait | No | Wait (up to 30 seconds) for the build to finish, polling with metered requests | |
| alias | No | Items can be found by this value instead of their id. Values must be unique and at most 1024 characters; one alias index per list | |
| guard | No | Hide the value at pointer from token reads (only an identity that owns an item can read it). Not combinable with the other flags | |
| pointer | Yes | A JSON pointer to the indexed value in each item's data, e.g. /score | |
| sorting | No | Items can be ordered by it | |
| pathName | Yes | The name used to filter and order by it, e.g. "score". Unique in the list, and stored lowercase | |
| activated | No | ||
| filtering | No | Items can be filtered by it | |
| searching | No | search_items searches its values | |
| valueType | No | How values are compared (default string) | |
| description | No | ||
| defaultOrderDirection | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index | Yes | ||
| buildStatus | Yes |