Copy or move an index

Copies or moves (renames) an index within the same Algolia application.

• Existing destination indices are overwritten, except for their analytics data.
• If the destination index doesn’t exist yet, it’ll be created.
• This operation is resource-intensive.

Copy

• Copying a source index that doesn’t exist creates a new index with 0 records and default settings.
• The API keys of the source index are merged with the existing keys in the destination index.
• You can’t copy the enableReRanking, mode, and replicas settings.
• You can’t copy to a destination index that already has replicas.
• Be aware of the size limits.
• Related guide: Copy indices

Move

• Moving a source index that doesn’t exist is ignored without returning an error.
• When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name.
• If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices.
• Related guide: Move indices.

This operation is subject to indexing rate limits.

Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
from algoliasearch.search.client import SearchClientSync

# In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.operation_index(
    index_name="<SOURCE_INDEX_NAME>",
    operation_index_params={
        "operation": "move",
        "destination": "<DESTINATION_INDEX_NAME>",
        "scope": [
            "rules",
            "settings",
        ],
    },
)