Manage Indices
List of methods
| List indices |
Get a list of indices with their associated metadata. |
| Delete index |
Delete an index and all its settings, including links to its replicas. |
| Copy index |
Make a copy of an index, including its records, settings, Synonyms, and Rules except for the enableReRanking setting. |
| Browse index |
Get all index content without any record limit. Can be used for backups. |
| Move index |
Renames an index. This is used internally to reindex your data without any downtime. |
| Index exists |
Returns whether an index exists or not. |
It’s recommended to use the Kotlin API client, which is better suited for Android development.
Create an index
You don’t need to create an index explicitly; the engine does it for you the first time you add an object or set settings.
Make sure you don’t use sensitive or personally identifiable information (PII) as your index name, including customer names, user IDs, or email addresses. Index names appear in network requests and should be considered publicly visible.
Asynchronous methods
All the manage indices methods are asynchronous. What you’re doing when calling these methods is adding a new job to a queue: it’s this job, and not the method, that performs the desired action. Usually, the job takes seconds or milliseconds, but this depends on what’s in the queue: if the queue has many pending tasks, the new job must wait its turn.
To help the management of the job queue, each method returns a unique taskID which you can pass to the waitTask method. Waiting on a task guarantees that the job has finished before proceeding with your new requests. Use waitTask to manage dependencies, for example, when deleting an index before creating a new index with the same name, or clearing an index before adding new objects.
Analytics data
Analytics data is based on the index, and uses the index’s name.
Analytics data is collected on a separate server, using separate processes to your main indices. There’s no hard link between your indices and the collection and storage of their analytics data. They’re two sets of data on separate servers. Therefore, actions like deleting or moving an index don’t affect your analytics data.
Copying or moving an index doesn’t transfer analytics data from source to destination:
- The analytics data stays on the source index.
- The destination index doesn’t gain any new analytics data.
Even if you delete an index or change its name, the analytics data isn’t erased: you can still access it from the dashboard’s Analytics menu (by first creating a new blank index using the original index name).
