Upgrading NEST 1 to 2

Breaking1.9.2 → 2.5.8Breaking20Platform1Deprecated12New60Changed43Fixed127Other12

BreakingUpgrade verdict

18 breaking changes and a platform requirement change.

In plain terms

When a document is missing, get and delete calls no longer report an invalid response; instead they succeed and you must check whether the document was found.
Removes `RethrowKeepingStackTrace` in favour of simply `throw`ing the exception.
The low-level client interface has a new name, so code referring to the old name must be updated.
Update now supports fields and is no longer generic.

Must act Top 5 of 31 that need code or config changes

Requires Target frameworks .NETFramework4.5, .NETFramework4.6, .NETStandard1.3 from 2.4.0 (none stated before).

Adds netstandard.library 1.6.0, system.collections.specialized 4.3.0, system.linq.queryable 4.0.1, system.reflection.typeextensions 4.3.0.

Moves elasticsearch.net [1.9.2, 2.0) → [2.5.8, 3.0.0), newtonsoft.json [9.0, 10.0) → [11.0.1, 12.0.0). Your build may pick other versions.

What you must change

Breaking18

404s on Get<T>() and Delete<T>() (and async variants) now return .IsValid as true and deserialize the response, setting .Found.

Get<T>()Delete<T>().IsValid.Found

2.4.7GitHub ReleaseSummarizedView source

Removes RethrowKeepingStackTrace in favour of simply throwing the exception.

RethrowKeepingStackTrace

2.1.0GitHub ReleaseSummarizedView source

Renames IElasticsearchClient to IElasticLowLevelClient to better specify intent.

IElasticsearchClientIElasticLowLevelClient

2.0.0GitHub ReleaseSummarizedView source

Update now supports fields and is no longer generic.

Update

2.0.0-rc1GitHub ReleaseSummarizedView source

Renames ConnectionStatusHandler to OnRequestCompleted and restores its functionality.

ConnectionStatusHandlerOnRequestCompleted

2.0.0-alpha2GitHub ReleaseSummarizedView source

Removes filter constructs from the code base to reflect the removal of filters in Elasticsearch 2.0.

2.0.0-alpha1GitHub ReleaseSummarizedView source

Splits ElasticPropertyAttribute into individual per-type attributes and renames ElasticTypeAttribute to ElasticsearchTypeAttribute.

ElasticPropertyAttributeElasticTypeAttributeElasticsearchTypeAttributeStringDateNumberNestedElasticType

2.0.0-alpha1GitHub ReleaseSummarizedView source

Moves Analyze API parameters from the query string to the request body.

Analyze

2.4.4GitHub ReleaseSummarizedView source

Rewrites NEST internals, replacing TPL-based code with async/await and reworking exception and error handling.

2.0.0GitHub ReleaseSummarizedView source

Replaces many NEST 1.x exception types with deterministic ElasticsearchClientException, UnexpectedElasticsearchClientException and CLR runtime exceptions.

MaxRetryExceptionElasticsearchAuthExceptionElasticsearchServerExceptionDslExceptionIConnectionPoolElasticsearchClientExceptionUnexpectedElasticsearchClientException

2.0.0GitHub ReleaseSummarizedView source

Merges query and filter constructs into queries, renaming filters such as AndFilter to AndQuery.

AndFilterAndQuery

2.0.0GitHub ReleaseSummarizedView source

Requires descending into isolated descriptors, for example Search().Sort(ss=>ss...) instead of SortAscending and SortScript on Search().

Search()SortAscending()SortScript()Sort()Field()Script()Ascending()GeoDistance()

2.0.0GitHub ReleaseSummarizedView source

Replaces ElasticPropertyAttribute with type-specific attributes such as ElasticsearchType, String, Date, Number and Nested.

ElasticsearchTypeElasticsearchType.NameElasticsearchType.IdPropertyStringDateNumberNestedElasticPropertyAttribute

2.0.0GitHub ReleaseSummarizedView source

Changes many string or primitive parameters to strongly typed objects such as Id, Field, Fields, Index, Indices, Type, Types and DocumentPath<T>.

IdFieldFieldsIndexIndicesTypeTypesDocumentPath<T>

2.0.0GitHub ReleaseSummarizedView source

High level methods now take Time instead of TimeSpan.

TimeTimeSpan

2.0.0-alpha2GitHub ReleaseSummarizedView source

Replaces ThrowOnElasticsearchServerExceptions() with ThrowExceptions() to control whether the client throws exceptions.

ThrowOnElasticsearchServerExceptions()ThrowExceptions()

2.0.0-alpha1GitHub ReleaseSummarizedView source

Reduces the exception types the client throws to ElasticsearchClientException, UnexpectedElasticsearchClientException, and development time CLR exceptions.

ElasticsearchClientExceptionUnexpectedElasticsearchClientException

2.0.0-alpha1GitHub ReleaseSummarizedView source

Introduces many breaking changes in NEST 2.0 and revalidates request and response domain objects against Elasticsearch 2.0.

2.0.0-alpha1GitHub ReleaseSummarizedView source

Platform1

NEST 2.0.0-alpha1 supports only .NET 4.5 and up; PCL/.NET Core support is not yet part of the build and CI.

2.0.0-alpha1GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated12

Introduces EndOffset on AnalyzeToken and deprecates the misspelt EndPostion.

AnalyzeTokenEndOffsetEndPostion

2.5.3GitHub ReleaseSummarizedView source

Marks IsValid obsolete for Get and Delete responses to warn about the behavioural change in #2637.

IsValid

2.5.3GitHub ReleaseSummarizedView source

Marks type level analyzers as obsolete; they will be removed in Elasticsearch 6.0.

2.5.2GitHub ReleaseSummarizedView source

Introduces TookAsLong for the Took value, caps Took at int.MaxValue, and marks Took Obsolete.

TookTookAsLong

2.4.7GitHub ReleaseSummarizedView source

Marks properties removed in 5.0 with ObsoleteAttribute.

ObsoleteAttribute

2.4.7GitHub ReleaseSummarizedView source

Marks MissingQuery with ObsoleteAttribute as removed in 5.0.

MissingQueryObsoleteAttribute

2.4.7GitHub ReleaseSummarizedView source

Marks IndexName on property mappings with ObsoleteAttribute as removed in 5.0.

IndexNameObsoleteAttribute

2.4.7GitHub ReleaseSummarizedView source

Marks .Highlights on SearchResponse<T> as obsolete, to be removed in 5.x.

SearchResponse<T>.HighlightsHitsMetaData.Hits

2.4.6GitHub ReleaseSummarizedView source

Deprecates Alias on GetAlias() in favour of Name.

GetAlias()AliasName

2.4.4GitHub ReleaseSummarizedView source

Deprecates the misnamed Field() method on SuggestContextDescriptor in favor of Path().

SuggestContextDescriptor.Field()SuggestContextDescriptor.Path()

2.4.2GitHub ReleaseSummarizedView source

Deprecates factor on DateHistogramAggregation.

factorDateHistogramAggregation

2.3.3GitHub ReleaseSummarizedView source

Mappings: Marks PositionOffsetGap as obsolete in favor of PositionIncrementGap.

PositionOffsetGapPositionIncrementGap

2.2.0GitHub ReleaseSummarizedView source