Forward Settings to Replicas

Example

Back to our example. Let’s say we have a primary index called products and a products_price_desc replica. Both indices have the same data and settings, apart from the ranking setting.

Now imagine we want to change the typoTolerance from true to "strict" for all indices, primary and replicas. We can achieve this by leveraging the forwardToReplicas parameter.

Using the API

The setSettings method, along with all synonyms and Query Rules methods, have a forwardToReplicas parameter. By default, forwardToReplicas is set to false, so any setting, synonym, or rule change only applies to the target index. By setting it to true, you can forward these changes to all the replicas belonging to the index you target.

1
2
3
4
5
6
7
8
$forwardToReplicas = true;

$index->setSettings(
  [
    "typoTolerance": "strict"
  ],
  $forwardToReplicas
);

1
index.set_settings({ typoTolerance: 'strict' }, { forwardToReplicas: true })

1
2
3
4
5
6
7
8
index.setSettings({
  'typoTolerance': 'strict'
}, {
  forwardToReplicas: true
}, (err, content) => {
  if (err) throw err;
  console.log(content);
});

1
2
3
index.set_settings({'typoTolerance': 'strict'}, {
    'forwardToReplicas': True,
})

1
2
3
4
5
6
7
index.setSettings(
  ["typoTolerance": "strict"],
  forwardToReplicas: true,
  completionHandler: { (content, error) -> Void in
    // [...]
  }
)

1
2
3
4
5
6
7
boolean forwardToReplicas = true;

index.setSettings(
  new JSONObject()
    .put("typoTolerance", "strict"),
  forwardToReplicas
);

1
2
3
4
5
6
7
8
9
IndexSettings settings = new IndexSettings
{
    TypoTolerance = "strict"
};

replicaIndex.SetSettings(settings, forwardToReplicas: true);

// Asynchronous
await replicaIndex.SetSettingsAsync(settings, forwardToReplicas: true);

1
2
3
4
5
6
7
boolean forwardToReplicas = true;

index.setSettings(
  new IndexSettings()
    .setTypoTolerance(TypoTolerance.of("strict")),
  forwardToReplicas
);

1
2
3
4
5
settings := search.Settings{
  TypoTolerance: opt.TypoToleranceStrict(),
}

res, err := index.SetSettings(settings, opt.ForwardToReplicas(true))

1
2
3
4
5
val result: Future[IndexSettings] = client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    typoTolerance = Some(TypoTolerance.strict)
  ) and forwardToReplicas
}

1
2
3
4
5
val settings = settings {
    typoTolerance = TypoTolerance.Strict
}

index.setSettings(settings, forwardToReplicas = true)

Using the Dashboard

The Algolia dashboard only allows forwarding to replicas when setting up synonyms and Query Rules. For other settings, you need to use the API.

When adding, editing, or deleting a synonym or a rule, check the Forward to replica indices checkbox before you click the Save button.