Skip to content

[7.x] [DOCS] Reorganizes Overview and Installation chapters. (1d48e472) #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2020
Merged

[7.x] [DOCS] Reorganizes Overview and Installation chapters. (1d48e472) #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4493a55
[DOCS] Reorganizes Overview and Installation chapters.
szabosteve Oct 1, 2020
b4756b0
Apply suggestions from code review
szabosteve Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 4 additions & 115 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,124 +1,13 @@
= Elasticsearch.pm

== Overview
:doctype: book

Search::Elasticsearch is the official Perl API for Elasticsearch. The full
documentation is available on https://metacpan.org/module/Search::Elasticsearch.
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

It can be installed with:
include::overview.asciidoc[]

[source,sh]
------------------------------------
cpanm Search::Elasticsearch
------------------------------------
include::installation.asciidoc[]

=== Features

This client provides:

* Full support for all Elasticsearch APIs

* HTTP backend (blocking and asynchronous with https://metacpan.org/module/Search::Elasticsearch::Async)

* Robust networking support which handles load balancing, failure detection and failover

* Good defaults

* Helper utilities for more complex operations, such as bulk indexing, scrolled searches and reindexing.

* Logging support via Log::Any

* Compatibility with the official clients for Python, Ruby, PHP and JavaScript

* Easy extensibility

== Synopsis

[source,perl]
------------------------------------
use Search::Elasticsearch;

# Connect to localhost:9200:
my $e = Search::Elasticsearch->new();

# Round-robin between two nodes:
my $e = Search::Elasticsearch->new(
nodes => [
'search1:9200',
'search2:9200'
]
);

# Connect to cluster at search1:9200, sniff all nodes and round-robin between them:
my $e = Search::Elasticsearch->new(
nodes => 'search1:9200',
cxn_pool => 'Sniff'
);

# Index a document:
$e->index(
index => 'my_app',
type => 'blog_post',
id => 1,
body => {
title => 'Elasticsearch clients',
content => 'Interesting content...',
date => '2014-09-24'
}
);

# Get the document:
my $doc = $e->get(
index => 'my_app',
type => 'blog_post',
id => 1
);

# Search:
my $results = $e->search(
index => 'my_app',
body => {
query => {
match => { title => 'elasticsearch' }
}
}
);
------------------------------------

[[v0_90]]
== Elasticsearch 0.90.* and earlier

The current version of the client supports the Elasticsearch 1.0 branch by
default, which is not backwards compatible with the 0.90 branch.

If you need to talk to a version of Elasticsearch before 1.0.0,
please use `Search::Elasticsearch::Client::0_90::Direct` as follows:

[source,perl]
------------------------------------
$es = Search::Elasticsearch->new(
client => '0_90::Direct'
);
------------------------------------


== Reporting issues

The GitHub repository is https://github.com/elastic/elasticsearch-perl
and any issues can be reported on the issues list at
https://github.com/elastic/elasticsearch-perl/issues.

== Contributing

Open source contributions are welcome. Please read our
https://github.com/elastic/elasticsearch-perl/blob/master/CONTRIBUTING.asciidoc[guide to contributing].

== Copyright and License

This software is Copyright (c) 2013-2018 by Elasticsearch BV.

This is free software, licensed under:
https://github.com/elastic/elasticsearch-perl/blob/master/LICENSE.txt[The Apache License Version 2.0].



18 changes: 18 additions & 0 deletions docs/installation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[[installation]]
== Installation

You can install the latest stable release of the Perl Client by using the
following command:

[source,sh]
------------------------------------
cpanm Search::Elasticsearch
------------------------------------

To install a specific version, download the specific version artifact. For
example, to download elasticsearch-perl 6.81, use the following command:

[source,sh]
------------------------------------
cpanm EZIMUEL/Search-Elasticsearch-6.81.tar.gz
------------------------------------
119 changes: 119 additions & 0 deletions docs/overview.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
== Overview

Search::Elasticsearch is the official Perl API for {es}. You can find the full
documentation https://metacpan.org/module/Search::Elasticsearch[here].

The intention of this client is to provide unopinionated and robust support for
the full native {es} API.

=== Features

This client provides:

* Full support for all {es} APIs.

* HTTP backend (blocking and asynchronous with
https://metacpan.org/module/Search::Elasticsearch::Async).

* Robust networking support which handles load balancing, failure detection and
failover.

* Good defaults.

* Helper utilities for more complex operations, such as bulk indexing, scrolled
searches and reindexing.

* Logging support via Log::Any.

* Compatibility with the official clients for Python, Ruby, PHP and JavaScript.

* Easy extensibility.


=== Synopsis

[source,perl]
------------------------------------
use Search::Elasticsearch;

# Connect to localhost:9200:
my $e = Search::Elasticsearch->new();

# Round-robin between two nodes:
my $e = Search::Elasticsearch->new(
nodes => [
'search1:9200',
'search2:9200'
]
);

# Connect to cluster at search1:9200, sniff all nodes and round-robin between them:
my $e = Search::Elasticsearch->new(
nodes => 'search1:9200',
cxn_pool => 'Sniff'
);

# Index a document:
$e->index(
index => 'my_app',
type => 'blog_post',
id => 1,
body => {
title => 'Elasticsearch clients',
content => 'Interesting content...',
date => '2014-09-24'
}
);

# Get the document:
my $doc = $e->get(
index => 'my_app',
type => 'blog_post',
id => 1
);

# Search:
my $results = $e->search(
index => 'my_app',
body => {
query => {
match => { title => 'elasticsearch' }
}
}
);
------------------------------------

[[v0_90]]
=== Elasticsearch 0.90.* and earlier

The current version of the client supports the Elasticsearch 1.0 branch by
default, which is not backwards compatible with the 0.90 branch.

If you need to talk to a version of Elasticsearch before 1.0.0,
please use `Search::Elasticsearch::Client::0_90::Direct` as follows:

[source,perl]
------------------------------------
$es = Search::Elasticsearch->new(
client => '0_90::Direct'
);
------------------------------------


=== Reporting issues

The GitHub repository is https://github.com/elastic/elasticsearch-perl and any
issues can be reported on the issues list at
https://github.com/elastic/elasticsearch-perl/issues.

=== Contributing

Open source contributions are welcome. Please read our
https://github.com/elastic/elasticsearch-perl/blob/master/CONTRIBUTING.asciidoc[guide to contributing].

=== Copyright and License

This software is Copyright (c) 2013-2018 by Elasticsearch BV.

This is free software, licensed under:
https://github.com/elastic/elasticsearch-perl/blob/master/LICENSE.txt[The Apache License Version 2.0].