Upgrade guides for the API client

Upgrade to v6

The design of the latest version of the .NET client is almost the same as the previous version to make upgrading as smooth as possible. The names of the client and index classes changed to SearchClient and SearchIndex with similar method names.

This new version is compatible with the same .NET versions as before: from .NET 4.5 to .NET Core 2.2.

Upgrading the library

With the .NET command-line tool

1
dotnet add package Algolia.Search

With the NuGet Package Manager console

1
Update-Package Algolia.Search

With the NuGet website

Download the package on NuGet.org.

Client instantiation

Replace the instantiation of the client as shown below.

1
2
3
4
5
6
7
// Before
AlgoliaClient client = new AlgoliaClient("YourApplicationID", "YourAdminAPIKey");
Index index = client.InitIndex("your_index_name");

// After
SearchClient client = new SearchClient("YourApplicationID", "YourAdminAPIKey");
SearchIndex index = client.InitIndex("your_index_name");

Configure the client

You can instantiate all clients with configuration objects. This is useful to change how a client behaves. You can configure:

• DefaultHeaders to set HTTP Headers for every request
• BatchSize to customize the size of batch for save methods
• Hosts to set custom hosts

Example:

1
2
3
4
5
6
7
8
9
10
SearchConfig config = new SearchConfig("YourApplicationID", "YourAdminAPIKey")
{
  BatchSize = 2000,
  DefaultHeaders = new Dictionary<string, string>
  {
    { "MyCustomerHeaderKey", "MyCustomerHeaderValue" }
  }
};

SearchClient client = new SearchClient(config);

Analytics instantiation

Similarly, you need to update the way you initialize the Analytics client.

1
2
3
4
5
6
// Before
AlgoliaClient client = new AlgoliaClient("YourApplicationID", "YourAdminAPIKey");
Analytics analytics = new Analytics(client);

// After
AnalyticsClient analytics = new AnalyticsClient("YourApplicationID", "YourAdminAPIKey");

New methods

The client has some new methods to help implement commonly used features. These features were always available but required either a deeper understanding or custom code.

• CopySettings: lets you copy settings between indices.
• CopySynonyms: lets you copy synonyms between indices.
• CopyRules: lets you copy rules between indices.
• ReplaceAllObjects: lets you add new objects to an index and remove all existing ones, atomically.
• ReplaceAllSynonyms: lets you add new synonyms to an index and remove all existing ones, atomically.
• ReplaceAllRules: lets you add new Rules to an index and remove all existing ones, atomically.
• AccountClient.CopyIndex: lets you copy an index between Algolia applications.
• CustomRequest: lets you request the Algolia API with custom parameters, URLs, and headers.

Breaking changes

JObject and types

The v6 of the client, in contrast to the previous one, is typed for every method. This implies a breaking change on most methods. You can still save and retrieve your records with JObject. For Settings, Rules, APIkeys, and Synonyms, you need to convert your JObject to a class.

How to export JObject to new types

Example with settings:

1
2
3
4
// Your old JObject
JObject oldObject = JObject.Parse("{\"customRanking\":[\"desc(population)\", \"asc(name)\"], \"attributesToIndex\":[\"attr1\", \"attr2\"],\"numericAttributesToIndex\": [\"attr1\", \"attr2\"]}");

IndexSettings settings = oldObject.ToObject<IndexSettings>();

This snippet also works for all other classes in the client, such as Rules, APIkeys, and Synonyms.

List of method changes

List of return type changes

AlgoliaClient/SearchClient

AlgoliaClient/AnalyticsClient

Index/SearchIndex