Skip to content

Commit 6d25719

Browse files
authored
DOC: Update SQL docs for DbVis and Workbench/J (elastic#45981)
Refresh the setup for the new versions of DbVisualizer and SQL Workbench/J which have Elasticsearch JDBC support out of the box.
1 parent a6e915b commit 6d25719

16 files changed

+19
-10
lines changed
Loading
Loading
Loading
Binary file not shown.
Binary file not shown.
Loading
Loading
Binary file not shown.
Loading
Binary file not shown.
Loading
Loading

docs/reference/sql/endpoints/client-apps/dbvis.asciidoc

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ IMPORTANT: Elastic does not endorse, promote or provide support for this applica
1212

1313
==== Prerequisites
1414

15+
* DbVisualizer 10.0.21 or higher
1516
* {es-sql} <<sql-jdbc, JDBC driver>>
1617

1718
==== Add {es} JDBC driver
@@ -20,25 +21,28 @@ Add the {es} JDBC driver to DbVisualizer through *Tools* > *Driver Manager*:
2021

2122
image:images/sql/client-apps/dbvis-1-driver-manager.png[]
2223

23-
Create a new driver entry through *Driver* > *Create Driver* entry and add the JDBC driver in the files panel
24-
through the buttons on the right. Once specify, the driver class and its version should be automatically picked up - one can force the refresh through the *Find driver in listed locations* button, the second from the bottom on the right hand side:
25-
24+
Select *Elasticsearch* driver name from the left sidebar and add the JDBC driver in the files panel through the buttons on the right; if there is no such driver name check the DbVisualizer version or create a new driver entry through *Driver* > *Create Driver*.
25+
2626
image:images/sql/client-apps/dbvis-2-driver.png[]
2727

28+
Once specified, the driver class and its version should be automatically picked up - one can force the refresh through the *Find driver in listed locations* button, the second from the bottom on the right hand side:
29+
30+
image:images/sql/client-apps/dbvis-3-add-driver.png[]
31+
2832
==== Create a new connection
2933

3034
Once the {es} driver is in place, create a new connection:
3135

32-
image:images/sql/client-apps/dbvis-3-new-conn.png[]
36+
image:images/sql/client-apps/dbvis-4-new-conn.png[]
3337

3438
One can use the wizard or add the settings all at once:
3539

36-
image:images/sql/client-apps/dbvis-4-conn-props.png[]
40+
image:images/sql/client-apps/dbvis-5-conn-props.png[]
3741

3842
Press *Connect* and the driver version (as that of the cluster) should show up under *Connection Message*.
3943

4044
==== Execute SQL queries
4145

4246
The setup is done. DbVisualizer can be used to run queries against {es} and explore its content:
4347

44-
image:images/sql/client-apps/dbvis-5-data.png[]
48+
image:images/sql/client-apps/dbvis-6-data.png[]

docs/reference/sql/endpoints/client-apps/workbench.asciidoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ IMPORTANT: Elastic does not endorse, promote or provide support for this applica
1212

1313
==== Prerequisites
1414

15+
* SQL Workbench/J build 125 or higher
1516
* {es-sql} <<sql-jdbc, JDBC driver>>
1617

1718
==== Add {es} JDBC driver
@@ -20,15 +21,19 @@ Add the {es} JDBC driver to SQL Workbench/J through *Manage Drivers* either from
2021

2122
image:images/sql/client-apps/workbench-1-manage-drivers.png[]
2223

23-
Add a new entry to the list through the blank page button in the upper left corner. Add the JDBC jar, provide a name and click on the magnifier button to have the driver *Classname* picked-up automatically:
24+
Select *Elasticsearch* profile from the left-hand side (if it is missing check the SQL Workbench/J version or add a new entry to the list through the blank page button in the upper left corner):
2425

25-
image:images/sql/client-apps/workbench-2-add-driver.png[]
26+
image:images/sql/client-apps/workbench-2-select-driver.png[]
27+
28+
Add the JDBC jar (if the driver name hasn't been picked up already, click on the magnifier button):
29+
30+
image:images/sql/client-apps/workbench-3-add-jar.png[]
2631

2732
==== Create a new connection profile
2833

2934
With the driver configured, create a new connection profile through *File* > *Connect Window* (or Alt+C shortcut):
3035

31-
image:images/sql/client-apps/workbench-3-connection.png[]
36+
image:images/sql/client-apps/workbench-4-connection.png[]
3237

3338
Select the previously configured driver and set the URL of your cluster using the JDBC syntax.
3439
Verify the connection through the *Test* button - a confirmation window should appear that everything is properly configured.
@@ -39,4 +44,4 @@ The setup is complete.
3944

4045
SQL Workbench/J is ready to talk to {es} through SQL: click on the profile created to execute statements or explore the data:
4146

42-
image:images/sql/client-apps/workbench-4-data.png[]
47+
image:images/sql/client-apps/workbench-5-data.png[]

0 commit comments

Comments
 (0)