-
Notifications
You must be signed in to change notification settings - Fork 597
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Adds getting started content based on the template (#2141)
Co-authored-by: Fernando Briano <fernando@picandocodigo.net>
- Loading branch information
1 parent
91c6f87
commit fd46613
Showing
4 changed files
with
146 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
[[getting-started-ruby]] | ||
== Getting started | ||
|
||
This page guides you through the installation process of the Ruby client, shows | ||
you how to instantiate the client, and how to perform basic Elasticsearch | ||
operations with it. | ||
|
||
[discrete] | ||
=== Requirements | ||
|
||
A currently maintained version of Ruby (3.0+) or JRuby (9.3+). | ||
|
||
[discrete] | ||
=== Installation | ||
|
||
To install the latest version of the client, run the following command: | ||
|
||
[source,shell] | ||
-------------------------- | ||
gem install elasticsearch | ||
-------------------------- | ||
|
||
Refer to the <<ruby-install>> page to learn more. | ||
|
||
|
||
[discrete] | ||
=== Connecting | ||
|
||
You can connect to the Elastic Cloud using an API key and the Elasticsearch | ||
endpoint. | ||
|
||
[source,rb] | ||
---- | ||
client = Elasticsearch::Client.new( | ||
cloud_id: '<CloudID>', | ||
api_key: '<ApiKey>' | ||
) | ||
---- | ||
|
||
Your Elasticsearch endpoint can be found on the **My deployment** page of your | ||
deployment: | ||
|
||
image::images/es_endpoint.jpg[alt="Finding Elasticsearch endpoint",align="center"] | ||
|
||
You can generate an API key on the **Management** page under Security. | ||
|
||
image::images/create_api_key.png[alt="Create API key",align="center"] | ||
|
||
For other connection options, refer to the <<connecting>> section. | ||
|
||
|
||
[discrete] | ||
=== Operations | ||
|
||
Time to use Elasticsearch! This section walks you through the basic, and most | ||
important, operations of Elasticsearch. For more operations and more advanced | ||
examples, refer to the <<examples>> page. | ||
|
||
|
||
[discrete] | ||
==== Creating an index | ||
|
||
This is how you create the `my_index` index: | ||
|
||
[source,rb] | ||
---- | ||
client.indices.create(index: 'my_index') | ||
---- | ||
|
||
|
||
[discrete] | ||
==== Indexing documents | ||
|
||
This is a simple way of indexing a document: | ||
|
||
[source,rb] | ||
---- | ||
document = { name: 'elasticsearch-ruby' } | ||
response = client.index(index: 'my_index', body: document) | ||
# You can get the indexed document id with: | ||
response['_id'] | ||
=> "PlgIDYkBWS9Ngdx5IMy-" | ||
id = response['_id'] | ||
---- | ||
|
||
|
||
[discrete] | ||
==== Getting documents | ||
|
||
You can get documents by using the following code: | ||
|
||
[source,rb] | ||
---- | ||
client.get(index: 'my_index', id: id) | ||
---- | ||
|
||
|
||
[discrete] | ||
==== Searching documents | ||
|
||
This is how you can create a single match query with the Ruby client: | ||
|
||
[source,rb] | ||
---- | ||
client.search(index: 'my_index', body: { query: { match_all: {} } }) | ||
---- | ||
|
||
|
||
[discrete] | ||
==== Updating documents | ||
|
||
This is how you can update a document, for example to add a new field: | ||
|
||
[source,rb] | ||
---- | ||
client.update(index: 'my_index', id: id, body: { doc: { language: 'Ruby' } }) | ||
---- | ||
|
||
|
||
[discrete] | ||
==== Deleting documents | ||
|
||
[source,rb] | ||
---- | ||
client.delete(index: 'my_index', id: id) | ||
---- | ||
|
||
|
||
[discrete] | ||
==== Deleting an index | ||
|
||
[source,rb] | ||
---- | ||
client.indices.delete(index: 'my_index') | ||
---- | ||
|
||
|
||
[discrete] | ||
== Further reading | ||
|
||
* Use <<Helpers>> for a more confortable experience with the APIs. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters