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
[DOCS] Refactor quick start guide and README (#71331) (#71937)
Changes:
* Refactors the "Getting Started" content down to one page.
* Refactors the README to reduce duplicated content and better mirror
Kibana's.
* Focuses the quick start on time series data, including data streams
and runtime fields.
* Streamlines self-managed install instructions to Docker.
Co-authored-by: debadair <debadair@elastic.co>
curl -X GET 'http://localhost:9200/my-index-000001/_search?pretty=true' -H 'Content-Type: application/json' -d '
92
-
{
93
-
"query" : {
94
-
"match" : { "user.id": "kimchy" }
95
-
}
96
-
}'
97
-
----
98
-
99
-
You can also retrieve all documents in `my-index-000001`.
100
-
101
-
----
102
-
curl -X GET 'http://localhost:9200/my-index-000001/_search?pretty=true' -H 'Content-Type: application/json' -d '
103
-
{
104
-
"query" : {
105
-
"match_all" : {}
106
-
}
107
-
}'
108
-
----
109
-
110
-
During indexing, Elasticsearch automatically mapped the `@timestamp` field as a
111
-
date. This lets you run a range search.
112
-
113
-
----
114
-
curl -X GET 'http://localhost:9200/my-index-000001/_search?pretty=true' -H 'Content-Type: application/json' -d '
115
-
{
116
-
"query" : {
117
-
"range" : {
118
-
"@timestamp": {
119
-
"from": "2099-11-15T13:00:00",
120
-
"to": "2099-11-15T14:00:00"
121
-
}
122
-
}
123
-
}
124
-
}'
125
-
----
126
-
127
-
=== Multiple indices
128
-
129
-
Elasticsearch supports multiple indices. The previous examples used an index
130
-
called `my-index-000001`. You can create another index, `my-index-000002`, to
131
-
store additional data when `my-index-000001` reaches a certain age or size. You
132
-
can also use separate indices to store different types of data.
133
-
134
-
You can configure each index differently. The following request
135
-
creates `my-index-000002` with two primary shards rather than the default of
136
-
one. This may be helpful for larger indices.
137
-
138
-
----
139
-
curl -X PUT 'http://localhost:9200/my-index-000002?pretty' -H 'Content-Type: application/json' -d '
140
-
{
141
-
"settings" : {
142
-
"index.number_of_shards" : 2
143
-
}
144
-
}'
145
-
----
146
-
147
-
You can then add a document to `my-index-000002`.
148
-
149
-
----
150
-
curl -X POST 'http://localhost:9200/my-index-000002/_doc?pretty' -H 'Content-Type: application/json' -d '
151
-
{
152
-
"@timestamp": "2099-11-16T13:12:00",
153
-
"message": "GET /search HTTP/1.1 200 1070000",
154
-
"user": {
155
-
"id": "kimchy"
156
-
}
157
-
}'
158
-
----
159
-
160
-
You can search and perform other operations on multiple indices with a single
161
-
request. The following request searches `my-index-000001` and `my-index-000002`.
162
-
163
-
----
164
-
curl -X GET 'http://localhost:9200/my-index-000001,my-index-000002/_search?pretty=true' -H 'Content-Type: application/json' -d '
165
-
{
166
-
"query" : {
167
-
"match_all" : {}
168
-
}
169
-
}'
170
-
----
171
-
172
-
You can omit the index from the request path to search all indices.
173
-
174
-
----
175
-
curl -X GET 'http://localhost:9200/_search?pretty=true' -H 'Content-Type: application/json' -d '
176
-
{
177
-
"query" : {
178
-
"match_all" : {}
179
-
}
180
-
}'
181
-
----
182
-
183
-
=== Distributed, highly available
184
-
185
-
Let's face it; things will fail...
186
-
187
-
Elasticsearch is a highly available and distributed search engine. Each index is broken down into shards, and each shard can have one or more replicas. By default, an index is created with 1 shard and 1 replica per shard (1/1). Many topologies can be used, including 1/10 (improve search performance) or 20/1 (improve indexing performance, with search executed in a MapReduce fashion across shards).
188
-
189
-
To play with the distributed nature of Elasticsearch, bring more nodes up and shut down nodes. The system will continue to serve requests (ensure you use the correct HTTP port) with the latest data indexed.
190
-
191
-
=== Where to go from here?
192
-
193
-
We have just covered a tiny portion of what Elasticsearch is all about. For more information, please refer to the https://www.elastic.co/products/elasticsearch[elastic.co] website. General questions can be asked on the https://discuss.elastic.co[Elastic Forum] or https://ela.st/slack[on Slack]. The Elasticsearch GitHub repository is reserved for bug reports and feature requests only.
194
-
195
-
=== Building from source
40
+
[[build-source]]
41
+
== Build from source
196
42
197
43
Elasticsearch uses https://gradle.org[Gradle] for its build system.
198
44
199
-
To build a distribution for your local OS and print its output location upon
45
+
To build a distribution for your local OS and print its output location upon
200
46
completion, run:
201
47
----
202
-
./gradlew localDistro
48
+
./gradlew localDistro
203
49
----
204
50
205
51
To build a distribution for another platform, run the related command:
@@ -214,10 +60,31 @@ To build distributions for all supported platforms, run:
214
60
./gradlew assemble
215
61
----
216
62
217
-
Finished distributions are output to `distributions/archives`.
63
+
Distributions are output to `distributions/archives`.
64
+
65
+
To run the test suite, see xref:TESTING.asciidoc[TESTING].
66
+
67
+
[[docs]]
68
+
== Documentation
69
+
70
+
For the complete Elasticsearch documentation visit
ensure someone else hasn't created an issue for the same topic.
222
87
223
-
To ensure a smooth upgrade process from earlier versions of Elasticsearch, please see our https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html[upgrade documentation] for more details on the upgrade process.
88
+
* Need help using Elasticsearch? Reach out on the
89
+
https://discuss.elastic.co[Elastic Forum] or https://ela.st/slack[Slack]. A
90
+
fellow community member or Elastic engineer will be happy to help you out.
0 commit comments