Create a replica index

Standard and virtual replicas

Standard replicas are exact copies of your index. They let you to have a completely different configuration of your index, while keeping the data in sync with your primary index.

Virtual replicas don’t copy the data from their primary index. They’re more efficient than standard replica, but you can only change a subset of the index settings. Virtual replicas are optimized for relevant sorting.

Virtual replicas aren’t available on the Grow plan.

Naming replica indices

To help you identify your replica indices, you should adopt a naming pattern, such as {primaryIndex}_{sortingAttribute}_{asc_or_desc}. For example, products_price_desc is a replica index of your products index, where the results are sorted by the price attribute in descending order.

Create replica indices in the dashboard

Go to the Algolia dashboard and select your Algolia application.
On the left sidebar, select Search.
Select your Algolia index:
On the Replicas tab, click Create Replica Index.
In the Create a new replica dialog, select Standard Replica (default) or Virtual Replica for Relevant Sort, enter a name for your replica, and click Create replica.
You can add multiple replicas at once.
Click Review and Save Settings.

Create replica indices with the API

To create replica indices, use the replicas setting in your primary index.

Copy

1
2
3
4
5
$index->setSettings([
  'replicas' => [
    'products_price_desc'
  ]
]);

1
2
3
4
5
6
7
8
9
10
11
12
IndexSettings settings = new IndexSettings
{
  Replicas = new List<string>
  {
    "products_price_desc"
  }
};

index.SetSettings(settings);

// Asynchronous
await index.SetSettingsAsync(settings);

To create virtual indices, use the virtual modifier for the replica index name:

Copy

1
2
3
4
5
$index->setSettings([
  'replicas' => [
    'virtual(products_price_desc)'
  ]
]);

1
2
3
4
5
6
7
8
9
10
11
12
IndexSettings settings = new IndexSettings
{
  Replicas = new List<string>
  {
    "virtual(products_price_desc)"
  }
};

index.SetSettings(settings);

// Asynchronous
await index.SetSettingsAsync(settings);

Next steps

After creating your replica indices, you can change their settings—for example, by adding a attribute for sorting.

Did you find this page helpful?