CODEWITHSUNDEEP
azure-cognitive-search
mikeyb
mikeyb

Reputation: 431

How to remove all documents in index

Is there any simple way to remove all documents (or a filtered list or documents) from an Azure search index?

I know the obvious answer is to delete and recreate the index, but I'm wondering if there is any other option.

Upvotes: 17

Views: 16151

Answers (5)

Mutlu Simsek
Mutlu Simsek

Reputation: 1172

You can delete and re-create the index using SearchIndexClient:

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   client.delete_index(name)

https://learn.microsoft.com/en-us/python/api/azure-search-documents/azure.search.documents.indexes.searchindexclient?view=azure-python#azure-search-documents-indexes-searchindexclient-delete-index

Upvotes: 0

mike
mike

Reputation: 374

It's 2023, and it appears this is still not directly possible.

Instead, you have to copy the index schema, delete the entire index, then create a new index with the same name using the copied schema.

I have a node.js script that can be used to to accomplish this easily with a single command:

const axios = require('axios');

const serviceName = 'xxxxx';
const apiKey = 'xxxxx';

const headers = {
  'Content-Type': 'application/json',
  'api-key': apiKey,
};

// example run: node script.js restartIndex indexName
async function restartIndex(indexName) {
  // Get the schema of the existing index
  axios.get(`https://${serviceName}.search.windows.net/indexes/${indexName}?api-version=2020-06-30`, { headers })
    .then((response) => {
      const schema = response.data;
      delete schema.statistics; // Remove statistics from the old index

      // Delete the existing index
      axios.delete(`https://${serviceName}.search.windows.net/indexes/${indexName}?api-version=2020-06-30`, { headers })
        .then(() => {
          // Recreate the index with the fetched schema
          axios.put(`https://${serviceName}.search.windows.net/indexes/${indexName}?api-version=2020-06-30`, schema, { headers })
            .then((response) => {
              console.log('Index restarted successfully:', response.data);
            })
            .catch((error) => {
              console.error('Error creating new index:', error);
            });
        })
        .catch((error) => {
          console.error('Error deleting old index:', error);
        });
    })
    .catch((error) => {
      console.error('Error fetching old index:', error);
    });
}

const args = process.argv.slice(2);

switch (args[0]) {
  case 'restartIndex':
    restartIndex(args[1]);
    break;
  default:
    console.log('Unknown command');
    break;
}

You'll need to run

npm install axios

Once you have this setup, you can run:

node script.js restartIndex indexName

Where script.js is the name that you gave this file, and indexName is the name of your index.

Upvotes: 2

Kevin
Kevin

Reputation: 200

There is a way: query all documents, and use IndexBatch to delete these guys.

    public void DeleteAllDocuments()
    {
        // Get index
        SearchIndexClient indexClient = new SearchIndexClient(SearchServiceName, SearchServiceIndex, new SearchCredentials(SearchServiceQueryApiKey));

        // Query all
        DocumentSearchResult<Document> searchResult;
        try
        {
            searchResult = indexClient.Documents.Search<Document>(string.Empty);
        }
        catch (Exception ex)
        {
            throw new Exception("Error during AzureSearch");
        }

        List<string> azureDocsToDelete =
            searchResult
                .Results
                .Select(r => r.Document["id"].ToString())
                .ToList();

        // Delete all
        try
        {
            IndexBatch batch = IndexBatch.Delete("id", azureDocsToDelete);
            var result = indexClient.Documents.Index(batch);
        }
        catch (IndexBatchException ex)
        {
            throw new Exception($"Failed to delete documents: {string.Join(", ", ex.IndexingResults.Where(r => !r.Succeeded).Select(r => r.Key))}");
        }
    }

Upvotes: 6

gnkc8742
gnkc8742

Reputation: 11

    //searchIndex - Index Name
    //KeyCol - Key column in the index
    public static void ResetIndex(string searchIndex, string KeyCol)
    {
        while (true)
        {
            SearchIndexClient indexClient = new SearchIndexClient(searchServiceName, searchIndex, new SearchCredentials(apiKey));
            DocumentSearchResult<Document> searchResult = indexClient.Documents.Search<Document>(string.Empty);
            List<string> azureDocsToDelete =
            searchResult
                .Results
                .Select(r => r.Document[KeyCol].ToString())
                .ToList();
            if(azureDocsToDelete.Count != 0)
            {
                try
                {
                    IndexBatch batch = IndexBatch.Delete(KeyCol, azureDocsToDelete);
                    var result = indexClient.Documents.Index(batch);
                }
                catch (IndexBatchException ex)
                {
                    throw new Exception($"Failed to reset the index: {string.Join(", ", ex.IndexingResults.Where(r => !r.Succeeded).Select(r => r.Key))}");
                }
            }
            else
            {
                break;
            }
        }
    }

Upvotes: 1

Pablo Castro
Pablo Castro

Reputation: 1681

No, currently there's no way to delete all the documents from an index. As you suspected deleting and re-creating the index is the way to go. For really small indexes you could consider deleting documents individually but given that often apps have code for index creation already, delete/recreate is the quickest path.

Upvotes: 12

Related Questions