Upgrade Guide

Upgrading from v1 to v2

If you have been using AlgoliaSearch for Django v1, you can upgrade to v2 by running the following command:

1
pip install -U algoliasearch_django>=2.0

There are some breaking changes in this new version you need to consider:

1. Upgrade usage of Python API Client to 2.0.0

AlgoliaSearch for Django v2 depends on the newest release of the Python API client.

• If you used AlgoliaSearch for Django v1 without directly using Python API client, you have nothing to do.

• If you used AlgoliaSearch for Django v1 and on some occasions used the Python API client directly, you need to migrate all these occurrences according to the Python API client upgrade guide.

2. Remove usage of deprecated method clear_index

The method clear_index was removed and replaced by clear_objects to match the names found in the newer version of the Python API client.

1
2
3
4
5
6
- from algoliasearch_django import clear_index
+ from algoliasearch_django import clear_objects


- clear_index(model)
+ clear_objects(model)