Skip to content
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

SQL: specify command to run the CLI on a remote machine without Elasticsearch #52626

Merged
merged 4 commits into from
Feb 21, 2020
Merged

SQL: specify command to run the CLI on a remote machine without Elasticsearch #52626

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad41146
Specify command line to use when running the SQL CLI on a machine where
astefan Feb 21, 2020
19c30b9
Merge branch 'master' of https://github.com/elastic/elasticsearch int…
astefan Feb 21, 2020
2a75b4b
Added alternative command using -jar
astefan Feb 21, 2020
9925288
Address feedback
astefan Feb 21, 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
27 changes: 23 additions & 4 deletions docs/reference/sql/endpoints/cli.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ Elasticsearch ships with a script to run the SQL CLI in its `bin` directory:
$ ./bin/elasticsearch-sql-cli
--------------------------------------------------

The jar containing the SQL CLI is a stand alone Java application and
the scripts just launch it. You can move it around to other machines
without having to install Elasticsearch on them.

You can pass the URL of the Elasticsearch instance to connect to as
the first parameter:

Expand Down Expand Up @@ -47,3 +43,26 @@ James S.A. Corey |Leviathan Wakes |561 |1306972800000
--------------------------------------------------
// TODO it'd be lovely to be able to assert that this is correct but
// that is probably more work then it is worth right now.

The jar containing the SQL CLI is a stand alone Java application and
the scripts just launch it. You can move it around to other machines
without having to install Elasticsearch on them. Without the already
provided script files, you can use a command similar to the following
to start the SQL CLI:

[source,bash]
--------------------------------------------------
$ ./java -jar [PATH_TO_CLI_JAR]/elasticsearch-sql-cli-[VERSION].jar https://some.server:9200
--------------------------------------------------

or

[source,bash]
--------------------------------------------------
$ ./java -cp [PATH_TO_CLI_JAR]/elasticsearch-sql-cli-[VERSION].jar org.elasticsearch.xpack.sql.cli.Cli https://some.server:9200
--------------------------------------------------

The jar name will be different for each Elasticsearch version (for example `elasticsearch-sql-cli-7.3.2.jar`),
thus the generic `VERSION` specified in the example above. Furthermore,
if not running the command from the folder where the SQL CLI jar resides,
you'd have to provide the full path, as well.