API client / Methods / Manage indices

Jun. 08, 2023

Move index

Required API Key: any key with the addObject ACL

Method signature

$client->moveIndex(
  string indexNameSrc,
  string indexNameDest
);

client.move_index(
  String indexNameSrc,
  String indexNameDest
)

client.moveIndex(
  string indexNameSrc,
  string indexNameDest
)

client.move_index(
  str indexNameSrc,
  str indexNameDest
)

client.moveIndex(
  from source: IndexName,
  to destination: IndexName,
  requestOptions: RequestOptions? = nil,
  completion: Result<WaitableWrapper<IndexRevision>> -> Void
)

suspend fun Index.moveIndex(
    destination: IndexName,
    requestOptions: RequestOptions? = null
): RevisionIndex

client.MoveIndex(
  String indexNameSrc,
  String indexNameDest
)

client.moveIndex(
  String indexNameSrc,
  String indexNameDest
)

client.MoveIndex(
  String indexNameSrc,
  String indexNameDest,
)

move.index(
  indexNameSrc,
  indexNameDest
)

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Move or rename an index.

Using this method, you can keep your existing service running while data from the old index is added to the new index. Moving doesn’t trigger a complete rebuild of the destination index unless it has replicas.

Moving an index is expensive and is rate-limited:

If you have more than 100 pending requests, the engine throttles your requests.
If you have more than 5,000 pending requests, further requests are ignored.

Analytics

If an index has analytics data, renaming doesn’t erase it but be aware of the consequences:

The destination’s analytics keep their original name
A new set of analytics is started with the new name.

To access the original analytics in the dashboard’s Analytics menu, first create a new empty index with the original index name.

If your source index doesn’t exist, the move operation is ignored. You can still use waitTask for this job.

Moving indices between apps

To move an index between apps, use the copyIndex method.

Moving from and to replicas

You can move a source index to a destination index that has replicas. The process replaces the destination index with the source index , and copies the source data to its replicas.

You can’t move a source index that has replicas.

Examples

Read the Algolia CLI documentation for more information.

Move index

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" }

Parameters

Parameter	Description
`indexNameSrc`	type: string Required Index name of the index to move.
`indexNameDest`	type: string Required Index name of the destination index.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

          {
  "updatedAt": "2017-12-18T21:22:40.761Z",
  "taskID": 19541511530
}

        

Field Description

Field	Description
`updatedAt`	string The date, in Unix timestamp format, when the job to copy the index was created.
`taskID`	integer The `taskID` used with the `waitTask` method. You can use either the source or destination index to wait on the resulting `taskID`. In either case, the wait includes the entire copy process.


          updatedAt

string

The date, in Unix timestamp format, when the job to copy the index was created.


          taskID

integer

The taskID used with the waitTask method.

You can use either the source or destination index to wait on the resulting taskID. In either case, the wait includes the entire copy process.

Did you find this page helpful?

Move index

About this method

Analytics

Moving indices between apps

Moving from and to replicas

Examples

Move index

Parameters

Response

JSON format

On this page