Move Indices

If you want to rename indices, you can move them using the Algolia dashboard or the API. Moving an index doesn’t move the associated analytics data.

Moving or renaming an index is an expensive operation and is rate-limited.

Rename indices from the Algolia dashboard

To rename or move an index in the dashboard:

1. Go to the Algolia dashboard and select your index from the Index menu.

2. Select Manage index > Rename.

   

3. Enter the current and new index names and click Rename.

   

If an index with the new name already exists, it’s overwritten.

Rename indices using the API

To rename or move an index, use the moveIndex method. To move an index between different Algolia applications, see Copy indices between apps.

1
2
// Rename indexNameSrc to indexNameDest (and overwrite it)
$index = $client->moveIndex('indexNameSrc', 'indexNameDest');

1
2
# Rename indexNameSrc to indexNameDest (and overwrite it)
client.move_index('indexNameSrc', 'indexNameDest')

1
2
3
4
// Rename indexNameSrc to indexNameDest (and overwrite it)
client.moveIndex('indexNameSrc', 'indexNameDest').then(() => {
  // done
});

1
2
# Rename indexNameSrc to indexNameDest (and overwrite it)
client.move_index('indexNameSrc', 'indexNameDest')

1
2
3
4
5
6
// Rename indexNameSrc to indexNameDest (and overwrite it)
client.moveIndex(from: "indexNameSrc", to: "indexNameDest") { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
index.moveIndex(indexName)

1
2
3
4
5
// Rename indexNameSrc to indexNameDest (and overwrite it)
client.MoveIndex("indexNameSrc", "indexNameDest");

// Asynchronous
await client.MoveIndexAsync("indexNameSrc", "indexNameDest");

1
2
3
4
5
// Rename indexNameSrc to indexNameDest (and overwrite it)
client.moveIndex("indexNameSrc", "indexNameDest");

// Asynchronous
client.moveIndexAsync("indexNameSrc", "indexNameDest");

1
2
// Rename indexNameSrc to indexNameDest (and overwrite it)
res, err := client.MoveIndex("indexNameSrc", "indexNameDest")

1
2
// Rename indexNameSrc to indexNameDest (and overwrite it)
client.execute { move index "indexNameDest" to "indexNameDest" }

If an index with the new name already exists, it’s overwritten after the renaming. To prevent accidentally overwriting existing indices, you can check if an index exists with the indexExists method.

If the source index doesn’t exist, the move operation is ignored.

Renaming an index doesn’t change the associated analytics:

• Analytics belonging to the original index keep their name.
• A new set of analytics is started with the new name.

See Indices and analytics for more information.

Moving indices with replicas

You can’t move a source index with replicas, as it would break the relationship between the index and its replicas. You can move an index to a destination index with replicas. During the process, the data from the destination index is replaced with the data from the source index. Then, the data is copied to the replicas.