Browse Source

DOC: Update SQL docs for DbVis and Workbench/J (#45981)

Refresh the setup for the new versions of DbVisualizer and SQL
Workbench/J which have Elasticsearch JDBC support out of the box.
Costin Leau 6 years ago
parent
commit
6d257194c1

BIN
docs/reference/images/sql/client-apps/dbvis-1-driver-manager.png


BIN
docs/reference/images/sql/client-apps/dbvis-2-driver.png


BIN
docs/reference/images/sql/client-apps/dbvis-3-add-driver.png


BIN
docs/reference/images/sql/client-apps/dbvis-3-new-conn.png


BIN
docs/reference/images/sql/client-apps/dbvis-4-conn-props.png


BIN
docs/reference/images/sql/client-apps/dbvis-4-new-conn.png


BIN
docs/reference/images/sql/client-apps/dbvis-5-conn-props.png


BIN
docs/reference/images/sql/client-apps/dbvis-5-data.png


BIN
docs/reference/images/sql/client-apps/dbvis-6-data.png


BIN
docs/reference/images/sql/client-apps/workbench-2-add-driver.png


BIN
docs/reference/images/sql/client-apps/workbench-2-select-driver.png


BIN
docs/reference/images/sql/client-apps/workbench-3-add-jar.png


+ 0 - 0
docs/reference/images/sql/client-apps/workbench-3-connection.png → docs/reference/images/sql/client-apps/workbench-4-connection.png


+ 0 - 0
docs/reference/images/sql/client-apps/workbench-4-data.png → docs/reference/images/sql/client-apps/workbench-5-data.png


+ 10 - 6
docs/reference/sql/endpoints/client-apps/dbvis.asciidoc

@@ -12,6 +12,7 @@ IMPORTANT: Elastic does not endorse, promote or provide support for this applica
 
 ==== Prerequisites
 
+* DbVisualizer 10.0.21 or higher
 * {es-sql} <<sql-jdbc, JDBC driver>>
 
 ==== Add {es} JDBC driver
@@ -20,20 +21,23 @@ Add the {es} JDBC driver to DbVisualizer through *Tools* > *Driver Manager*:
 
 image:images/sql/client-apps/dbvis-1-driver-manager.png[]
 
-Create a new driver entry through *Driver* > *Create Driver* entry and add the JDBC driver in the files panel
-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:
- 
+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*.
+
 image:images/sql/client-apps/dbvis-2-driver.png[]
 
+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:
+ 
+image:images/sql/client-apps/dbvis-3-add-driver.png[]
+
 ==== Create a new connection
 
 Once the {es} driver is in place, create a new connection:
 
-image:images/sql/client-apps/dbvis-3-new-conn.png[]
+image:images/sql/client-apps/dbvis-4-new-conn.png[]
 
 One can use the wizard or add the settings all at once:
 
-image:images/sql/client-apps/dbvis-4-conn-props.png[]
+image:images/sql/client-apps/dbvis-5-conn-props.png[]
 
 Press *Connect* and the driver version (as that of the cluster) should show up under *Connection Message*.
 
@@ -41,4 +45,4 @@ Press *Connect* and the driver version (as that of the cluster) should show up u
 
 The setup is done. DbVisualizer can be used to run queries against {es} and explore its content:
 
-image:images/sql/client-apps/dbvis-5-data.png[]
+image:images/sql/client-apps/dbvis-6-data.png[]

+ 9 - 4
docs/reference/sql/endpoints/client-apps/workbench.asciidoc

@@ -12,6 +12,7 @@ IMPORTANT: Elastic does not endorse, promote or provide support for this applica
 
 ==== Prerequisites
 
+* SQL Workbench/J build 125 or higher
 * {es-sql} <<sql-jdbc, JDBC driver>>
 
 ==== Add {es} JDBC driver
@@ -20,15 +21,19 @@ Add the {es} JDBC driver to SQL Workbench/J through *Manage Drivers* either from
 
 image:images/sql/client-apps/workbench-1-manage-drivers.png[]
 
-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:
+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):
 
-image:images/sql/client-apps/workbench-2-add-driver.png[]
+image:images/sql/client-apps/workbench-2-select-driver.png[]
+
+Add the JDBC jar (if the driver name hasn't been picked up already,  click on the magnifier button):
+
+image:images/sql/client-apps/workbench-3-add-jar.png[]
 
 ==== Create a new connection profile
 
 With the driver configured, create a new connection profile through *File* > *Connect Window* (or Alt+C shortcut):
 
-image:images/sql/client-apps/workbench-3-connection.png[]
+image:images/sql/client-apps/workbench-4-connection.png[]
 
 Select the previously configured driver and set the URL of your cluster using the JDBC syntax.
 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.
 
 SQL Workbench/J is ready to talk to {es} through SQL: click on the profile created to execute statements or explore the data:
 
-image:images/sql/client-apps/workbench-4-data.png[]
+image:images/sql/client-apps/workbench-5-data.png[]