Move Index | Ruby API Client V1 (Deprecated)

This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.

client.move_index(
  String indexNameSrc,
  String indexNameDest
)

About this method

Rename an index. Normally used to reindex your data atomically, without any down time.

The move index method is a safe and atomic way to rename an index.

By using this method, you can keep your existing service running while the data from the old index is being imported into the new index.

This method doesn’t trigger a complete rebuild of the destination index unless it has replicas.

Moving an index overrides the objects and settings of the destination index, with the objects and settings of the source index.

Before performing a move operation, make sure your source index exists. Our API creates a job even when an index doesn’t exist, but because it has no source index, the job won’t be able to end. If you perform a waitTask for this job, the wait will never resolve.

Regarding replicas:

• Moving to an index having replicas is possible, it will replace the destination index data with the source index data, and the data will be propagated to the replicas
• Moving an index having replicas is not possible, as it would break the relationship with its replicas

Note this is an expensive operation:

• when you have more than 100 requests pending, your requests will be throttled.
• when you have more than 5000 requests pending, further requests will be ignored.
• if needed, these values can be tuned through configuration.

Moving an index will have no impact on Analytics data because you cannot move an index’s Analytics data.

Examples

Move index

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

1
2
# Rename indexNameSrc to indexNameDest (and overwrite it)
puts 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
2
// Rename indexNameSrc to indexNameDest (and overwrite it)
client.moveIndexAsync("indexNameSrc", "indexNameDest", null);

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

1
index.moveIndex(indexName)

Parameters

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

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