Move indices

Rename indices in the Algolia dashboard

Go to the Algolia dashboard and select your Algolia application.
On the left sidebar, select Search.
Select the Algolia index you want to configure:
Select Manage index > Rename.

The Rename option only shows if you selected a primary index. It doesn’t show for replica indices.
Enter the current and new index names and click Rename.

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

Rename indices with the API

To rename or move an index with the API, use one of these methods:

API clients: moveIndex
Algolia CLI: algolia indices move

To move an index between different Algolia applications, see Copy indices between apps.

Copy

1
2
3
4
5
6
7
8
9
10
11
<?php
require_once __DIR__."/vendor/autoload.php";
use Algolia\AlgoliaSearch\SearchClient;

// Use an API key with `addObject` ACL
$client = SearchClient::create(
  'YourApplicationID', 'YourAPIKey'
);

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

1
2
3
4
5
6
7
8
9
require 'algolia'

# Use an API key with `addObject` ACL
client = Algolia::Search::Client.create(
  'YourApplicationID', 'YourAPIKey'
)

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

1
2
3
4
5
6
7
const algoliasearch = require('algoliasearch');

// Use an API key with `addObject` ACL
const client = algoliasearch('YourApplicationID', 'YourAPIKey');

// Rename indexNameSrc to indexNameDest (and overwrite it)
client.moveIndex('indexNameSrc', 'indexNameDest');

1
2
3
4
5
6
7
from algoliasearch.search_client import SearchClient

# Use an API key with `addObject` ACL
client = SearchClient.create("YourApplicationID", "YourAPIKey")

# Rename `indexNameSrc` to `indexNameDest` (and overwrite it)
client.move_index("indexNameSrc", "indexNameDest")

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import AlgoliaSearchClient

// Use an API key with `addObject` ACL
let client = SearchClient(
  appID: "YourApplicationID",
  apiKey: "YourAPIKey"
)

// 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
2
3
4
5
6
7
8
// Use an API key with `addObject` ACL
val client = ClientSearch(
  ApplicationID("YourApplicationID")
  APIKey("YourAPIKey")
)
// Rename `indexNameSrc` to `indexNameDest` (and overwrite it)
val index = client.initIndex(IndexName("indexNameSrc"))
index.moveIndex(IndexName("indexNameDest"))

1
2
3
4
5
6
7
8
// Use an API key with `addObject` ACL
var client = new SearchClient("YourApplicationID", "YourAPIKey");

// Rename `indexNameSrc` to `indexNameDest` (and overwrite it)
client.MoveIndex("indexNameSrc", "indexNameDest");

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

1
2
3
4
5
6
7
8
// Use an API key with `addObject` ACL
SearchClient client = DefaultSearchClient.create("YourApplicationID", "YourAPIKey");

// Rename `indexNameSrc` to `indexNameDest` (and overwrite it)
client.moveIndex("indexNameSrc", "indexNameDest");

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

1
2
3
4
5
// Use an API key with `addObject` ACL
client := search.NewClient("YourApplicationID", "YourAPIKey")

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

1
2
3
4
5
// Use an API key with `addObject` ACL
val client = new AlgoliaClient("YourApplicationID", "YourAPIKey")

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

If an index with the new name already exists, move overwrites it. If you want to avoid overwriting existing indices, you can check if an index exists with the indexExists method.

If the source index doesn’t exist, Algolia ignores the move operation.

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.

Indices with replicas

You can’t move a source index with replicas. It would break the relationship between the index and its replicas.

You can move an index to a destination index with replicas. First, the source index data replaces the destination index data. Then, the data is copied to the replicas.

If an index is the data source for Recommend models, you can’t rename it directly. If you do so, you’ll lose the relationship between the recommended records and their source.

Instead:

Copy the index.
To keep the events you already collected, train a new model on the copy index using the old index as an additional events source.
After training, switch your own apps and services to use the new index.
Delete the old index and the old model (from the Algolia dashboard).

Did you find this page helpful?

Move indices

On this page

Rename indices in the Algolia dashboard

Rename indices with the API

Indices with replicas

On this page

Move indices

On this page

Rename indices in the Algolia dashboard

Rename indices with the API

Indices with replicas

Moving indices used as a Recommend data source

On this page