forked from elastic/elasticsearch-net
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
170 lines (114 loc) · 6.77 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<title>NEST - Introduction</title>
<meta http-equiv="cache-control" content="no-cache" />
<meta http-equiv="pragma" content="no-cache" />
<meta http-equiv="content-type" content="text/html;charset=utf-8" />
<meta http-equiv="expires" content="0">
<meta name="description" content="elasticsearch" />
<meta name="keywords" content="elastic, search, cloud, elasticsearch, indexing, lucene, distributed lucene, shay banon, .net, nest" />
<meta name="author" content="martijn laarman" />
<link rel="stylesheet" type="text/css" href="http://mpdreamz.github.com/NEST/styles/layout.css">
<link rel="stylesheet" type="text/css" href="http://mpdreamz.github.com/NEST/styles/pygments.css">
<link href='http://fonts.googleapis.com/css?family=Ubuntu+Mono|Ubuntu' rel='stylesheet' type='text/css'>
<link href="http://mpdreamz.github.com/NEST/prettify/prettify.css" type="text/css" rel="stylesheet" />
<link href="http://mpdreamz.github.com/NEST/prettify/sunburst.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="http://mpdreamz.github.com/NEST/prettify/prettify.js"></script>
<script src="http://code.jquery.com/jquery.min.js" type="text/javascript"></script>
<script type="text/javascript" src="http://ajax.aspnetcdn.com/ajax/jquery.templates/beta1/jquery.tmpl.js"></script>
</head>
<body onload="prettyPrint()">
<section id="site">
<aside>
<ul id="top_left_menu">
<h4>External</h4>
<li><a href="http://www.elasticsearch.org" target="_blank">Elasticsearch Docs</a></li>
<li><a href="http://mpdreamz.mit-license.org/" target="_blank">MIT license</a></li>
</ul>
</aside>
<section id="content" class="">
<aside id="menu">
<ul id="top_left_menu">
<h4>- Concepts</h4>
<ul>
<li><a class="selected" href="http://mpdreamz.github.com/NEST">Introduction</a></li>
<li><a class="" href="http://mpdreamz.github.com/NEST/concepts/connecting.html">Connecting</a></li>
<li><a class="" href="http://mpdreamz.github.com/NEST/concepts/handling-responces.html">Response handling</a></li>
</ul>
<li><a class="" href="http://mpdreamz.github.com/NEST/core/index.html">+ Core</a></li>
<li><a class="" href="http://mpdreamz.github.com/NEST/indices/aliases.html">+ Indices</a></li>
<li><a class="" href="http://mpdreamz.github.com/NEST/cluster/health.html">+ Cluster</a></li>
<li><a class="" href="http://mpdreamz.github.com/NEST/search/basics.html">+ Search</a></li>
<li><a class="" href="http://mpdreamz.github.com/NEST/facets/handling.html">+ Facets</a></li>
<li><a class="" href="http://mpdreamz.github.com/NEST/query/text.html">+ Query DSL</a></li>
<li><a class="" href="http://mpdreamz.github.com/NEST/filter/and.html">+ Filter DSL</a></li>
</ul>
</aside>
<article>
<div id="content-margin-fix">
<h1>Introduction</h1>
<p>NEST aims to be a .net client with a very concise API. Its main goal is to provide a solid strongly typed Elasticsearch client. It also has string/dynamic overloads for more dynamic usecases. </p>
<p>Indexing is as simple as:</p>
<pre class="prettyprint"><code class="language-cs"><code>var post = new Post() { Id = 12, ... }
client.Index(post);
</code></code></pre>
<p>Indexing asynchronously is as easy as:</p>
<pre class="prettyprint"><code class="language-cs"><code>//IndexAsync returns a Task<ConnectionStatus>
var task = client.IndexAsync(post);
</code></code></pre>
<p>Searching is fluid:</p>
<pre class="prettyprint"><code class="language-cs"><code>var results = this.ConnectedClient.Search<ElasticSearchProject>(s => s
.From(0)
.Size(10)
.Fields(f => f.Id, f => f.Name)
.SortAscending(f => f.LOC)
.SortDescending(f => f.Name)
.Query(q=>q.Term(f=>f.Name, "NEST", Boost: 2.0))
);
</code></code></pre>
<h2>Installing</h2>
<p>Nest can be installed through NuGet:</p>
<pre class="prettyprint"><code class="language-cs"><code>PM> Install-Package NEST
</code></code></pre>
<p>Or searching for "elasticsearch" will get you to nest as well. </p>
<h2>Copyright</h2>
<p>Copyright (c) 2010 Martijn Laarman and everyone wonderful enough to contribute to <a href="https://github.com/Mpdreamz/NEST">NEST</a></p>
<h2>License</h2>
<p>NEST is licensed under <a href="http://www.opensource.org/licenses/mit-license.php" title="Read more about the MIT license form">MIT</a>. Refer to <a href="https://github.com/Mpdreamz/NEST/blob/master/src/license.txt">license.txt</a> for more information.</p>
<h2>Contributors</h2>
<p>A special shoutout to <a href="http://github.com/stephenpope">@stephenpope</a> for allowing his port
of the java factory based dsl <a href="http://github.com/stephenpope/Rubber">Rubber</a> to be merged into NEST.
NEST now has <strong>two types of query dsl's</strong> (lambda and factory based)!</p>
<p>Some of the other wonderful features in NEST were pushed by these wonderful folks:</p>
<ul>
<li><a href="https://github.com/nordbergm/NEST">@nordbergm</a></li>
<li><a href="https://github.com/kevingessner/NEST">@kevingessner</a></li>
<li><a href="https://github.com/EFJoseph/NEST">@EFJoseph</a></li>
<li><a href="https://github.com/pkrakowiak/NEST">@pkrakowiak</a> </li>
<li><a href="https://github.com/q42jaap/NEST">@q42jaap</a></li>
</ul>
<script id="contributorTemplate" type="text/x-jQuery-tmpl">
<div style="clear:both; margin: 8px; height: 80px; width: 600px;" id="contributor">
<img src="http://gravatar.com/avatar/${gravatar_id}" alt="${name || login}" style="float:left;" />
<div style="float:left; margin-left: 12px;">
<h3>#${$index + 1} (${contributions} commits)</h3>
<h2>${name ? name.replace(" ", " '" + login + "' ") + "!" : login}</h2>
<a href="https://github.com/${login}">https://github.com/${login}</a>
</div>
</div>
</script>
<div id="contributors"> </div>
<p>
Spotted a mistake? Something to add?
<a href="https://github.com/Mpdreamz/NEST/blob/master/docs/index.markdown">
Fork and edit this file on github
</a>
without leaving the browser
</div>
<section>
</article>
</section>
<a href="http://github.com/mpdreamz/nest"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub" /></a>
</body>
</html>