You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>Elasticsearch 1.0 comes with it's own set of breaking changes which <ahref="http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/breaking-changes.html">are all documented in the elasticsearch documentation</a>. This page describes breaking changes NEST introduces in its 1.0 release and to an extend how you should handle Elasticsearch 1.0 changes in your exisiting code base using NEST prior to NEST 1.0.</p>
5
+
<h2id="nest-1-0">NEST 1.0</h2>
6
+
<h3id="strong-named-packages">Strong named packages</h3>
7
+
<p>Prior to 1.0 NEST came with a <code>NEST</code> and <code>NEST.Signed</code> nuget package. In 1.0 there is one package called <code>NEST</code> which is a signed strong named assembly. We follow the example of JSON.NET and only change our <code>AssemblyVersion</code> on major releases only update the <code>AssemblyFileVersion</code> for every release. This way you get most of the benefits of unsigned assemblies while still providing support for developers who's business guidelines mandates the usage of signed assemblies.</p>
8
+
<h3id="ielasticclient">IElasticClient</h3>
9
+
<p>The outer layer of NEST has been completely rewritten from scratch. Many calls will now have a different signature. Although the most common ones have been reimplemented as <ahref="http://github.com/elasticsearch/elasticsearch-net/tree/master/src/Nest/ConvenienceExtensions">extensions methods</a>. Two notable changes should be outlined though. </p>
10
+
<h4id="get-is-now-called-source-">Get() is now called Source()</h4>
11
+
<p>When I first wrote NEST back in 2010 I though it would be handy if the Get() operation returned only the document and if you want the full envelopped elasticsearch response you'd use <code>GetFull()</code>. This was rather confusing and on top of that Elasticsearch 1.0 now has it's own endpoint for getting JUST the document <code>_source</code>.
12
+
Similarily <code>GetMany()</code> is now called <code>SourceMany()</code>.</p>
13
+
<h3id="renamed-queryresponse-to-searchresponse">Renamed QueryResponse to SearchResponse</h3>
14
+
<p>The fact that <code>client.Search<T>()</code> returns a <code>QueryResponse<T></code> and not a <code>SearchResponse<T></code> never felt right to me, NEST 1.0 therefor renamed <code>QueryResponse<T></code> to <code>SearchResponse<T></code></p>
15
+
<h4id="alias-helpers">Alias helpers</h4>
16
+
<p>NEST 0.12.0 had some alias helpers, <code>SwapAlias()</code>, <code>GetIndicesPointingToAlias()</code> these have been removed in favor of just <code>Alias()</code> and <code>GetAliases()</code>. Especially the later could benefit from some extension methods that make the common use cases a bit easier to program with. These did not make the beta release.</p>
17
+
<h4id="fields-vs-sourceinclude-">Fields() vs SourceInclude()</h4>
18
+
<p>Prior to Elasticsearch you could specify to return only certain fields and they would return like this:</p>
</code></pre><p>In many case this could be mapped to the type of DTO you give search (i.e in <code>.Search<DTO>()</code>). Elasticsearch 1.0 now always returns the fields as arrays.</p>
<p>When you do a search with NEST 0.12 you'd get back a <code>QueryResponse<T></code> with two ways to loop over your results. <code>.Documents</code> is an <code>IEnumerable<T></code> and <code>.DocumentsWithMetaData</code> is and <code>IEnumerable<IHit<T>></code> depending on your needs one of them might be easier to use.</p>
42
+
<p>Starting from NEST 1.0 <code>.DocumentsWithMetaData</code> is now called simply <code>.Hits</code>.</p>
43
+
<h3id="int-properties">int Properties</h3>
44
+
<p>In quite a few places values that should have been <code>long</code> were mapped as <code>int</code> in NEST 0.12.0 which could be troublesome if you for instance have more than <code>2,147,483,647</code> matching documents. In my preperations for this release I helped port one of my former employees applications to Elasticsearch 1.1 and NEST 1.0 and found that this change had the most impact on the application and all of its models. </p>
45
+
<h1id="found-another-breaking-change-">Found another breaking change?</h1>
46
+
<p>If you found another breaking chage please let us know on <ahref="http://www.github.com/elasticsearch/elasticsearch-net/issues">the github issues</a></p>
<p>Building <code>Elasticsearch.Net</code> and <code>NEST</code> should be super straightforward. Just fork and clone <ahref="https://github.com/elasticsearch/elasticsearch-net">the repository on github</a> and open <code>Elasticsearch.sln</code> and press build. Alternatively you can run <code>build.bat</code> from the root to build everything the resulting assemblies will be exported to <code>build/output</code>. </p>
4
+
<p>NEST builds strong named assemblies but if you do not have the key the build script and <code>pre build events</code> are in place to generate one for you. The project very much believes in the <ahref="http://www.khalidabuhakmeh.com/the-f5-manifesto-for-net-developers">F5 manifesto</a></p>
5
+
<h2id="buildscript">Buildscript</h2>
6
+
<p>The buildscript depends on quite a few tools</p>
7
+
<ul>
8
+
<li>FAKE - F# make to script the build</li>
9
+
<li>Nuget - used to install some of the dependencies</li>
10
+
<li>NUnit - to run the tests after build</li>
11
+
<li>Nodejs - Use to generate the documentation</li>
12
+
<li>Wintersmith - Used to generate the documentation</li>
13
+
<li>sn.exe - used to check the validity of the signed assemblies during build/release procedures</li>
14
+
</ul>
15
+
<p>All of these will be downloaded and installed locally in your repository the first time you run <code>build.bat</code></p>
16
+
<p><strong>NOTE:</strong> none of these are needed to build from within Visual Studio</p>
17
+
<h3id="build-target">Build target</h3>
18
+
<p>Running <code>build.bat</code> will default to running the <code>Build</code> target which will create certificates in the right place if they do not exist, build the application and run all the unit tests. The resulting assemblies are placed in <code>build/output</code>.</p>
19
+
<h3id="docpreview-target">DocPreview target</h3>
20
+
<p>Running <code>build.bat DocPreview</code> will serve the files under <code>new_docs</code> at <code>http://localhost:8080</code> with live-reload setup. Usefull only when you are working on documentation.</p>
21
+
<h3id="release-target">Release target</h3>
22
+
<p>Running <code>build.bat Release versionnumber</code> will create nuget packages in <code>output/_packages</code>. This could be useful if you need a feature that is not yet released you can temporarily switch to local nuget packages.</p>
23
+
<p>Release will call the build target and in addition patch the assembly files, build the documentation files. </p>
0 commit comments