Delete a Replica Index

Introduction

You can delete a standard or virtual replica through the API or your Algolia dashboard.

Using the API

To delete a standard or virtual replica index through the API, you need to use the setSettings method on the original index to unlink the replica, then use the deleteIndex method on the replica index to delete it.

In the below example, we want to delete the products_price_asc replica.

If the primary index has other replica indices which you don’t want to unlink, they should remain in the replicas parameter.

Copy

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

$products_price_asc->delete();

1
2
3
4
5
6
7
8
9
10
11
12
13
primary_index.setSettings([
  "replicas": []
])


client.deleteIndex(
  withName: "products_price_asc",
  completionHandler: { (content, error) -> Void in
    if error != nil {
      print("Could not delete: \(error!)")
    }
  }
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
IndexSettings settings = new IndexSettings
{
    Replicas = new List<string>
    {
    }
};

// Set Settings--Synchronous
primary_index.SetSettings(settings);

// Set Settings--Asynchronous
await primary_index.SetSettingsAsync(settings);

// Deletion--Synchronous
products_price_asc.Delete();

// Deletion--Asynchronous
await products_price_asc.DeleteAsync();

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

client.execute { delete index "products_price_asc" }

Using the Dashboard

You can also delete replica indices in your Algolia dashboard with the following steps:

Deleting a replica through the dashboard

Go to your dashboard and select your primary index from the Indices tab.
Click on the Replicas tab.
Click on the Unlink Replica button to remove the relevant replica.
Don’t forget to save your changes.

Did you find this page helpful?

Delete a Replica Index

On this page

Introduction

Using the API

Using the Dashboard

On this page