Create a Replica Index

By design, Algolia provides one ranking formula per index; therefore, when you want to provide different rankings for the same data, you need to use different indices for each ranking. These additional indices are called replicas.

You can create replicas through the API and the Dashboard.

Using the API

To create replicas, you need to use the setSettings method on your primary index. You can add more than one replica at a time if you want to provide multiple alternative sorting strategies.

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

1
2
3
4
5
index.set_settings({
  replicas: [
    'products_price_desc'
  ]
})

1
2
3
4
5
index.setSettings({
  replicas: [
    'products_price_desc'
  ]
});

1
2
3
4
5
index.set_settings({
  'replicas': [
    'products_price_desc'
  ]
})

1
2
3
4
5
index.setSettings([
  "replicas": [
    "products_price_desc"
  ]
])

1
2
3
4
5
6
7
index.setSettings(
  new JSONObject().put(
    "replicas",
    new JSONArray()
      .put("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);

1
2
3
4
5
index.setSettings(
  new IndexSettings().setReplicas(Collections.singletonList(
    "products_price_desc"
  ))
);

1
2
3
res, err := index.SetSettings(search.Settings{
  Replicas: opt.Replicas("products_price_desc"),
})

1
2
3
4
5
6
7
client.execute {
  changeSettings of "products" `with` IndexSettings(
    replicas = Some(Seq(
      "products_price_desc"
    ))
  )
}

1
2
3
4
5
6
7
val settings = settings {
    replicas {
        +"products_price_desc"
    }
}

index.setSettings(settings)

Using the Dashboard

1. Go to your dashboard and select your index.
2. Click the Replicas tab.
3. Click the “Create Replica Index” button, type a name for your replica and press Enter.
4. Repeat for all additional replicas you want to add.
5. Don’t forget to save your changes.