Browse Source

SQL: Update DbVisualizer connection steps (#85167)

Update DbVisualizer connection steps to reflect version 13.0's integrated
Elasticsearch support.
Bogdan Pintea 3 years ago
parent
commit
f50ceecbd4

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


BIN
docs/reference/images/sql/client-apps/dbvis-2-driver-manager-elasticsearch.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-driver-manager-download.png


BIN
docs/reference/images/sql/client-apps/dbvis-4-driver-manager-ready.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-new-conn.png


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


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


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


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


+ 23 - 14
docs/reference/sql/endpoints/client-apps/dbvis.asciidoc

@@ -4,41 +4,50 @@
 
 You can use the {es} JDBC driver to access {es} data from DbVisualizer.
 
-IMPORTANT: Elastic does not endorse, promote or provide support for this application; for native Elasticsearch integration in this product, please reach out to its vendor.
+IMPORTANT: Elastic does not endorse, promote or provide support for this application.
 
 ==== Prerequisites
 
-* https://www.dbvis.com/[DbVisualizer] 10.0.21 or higher
+* https://www.dbvis.com/[DbVisualizer] 13.0 or higher
 * {es-sql} <<sql-jdbc, JDBC driver>>
 
-==== Add {es} JDBC driver
+Note::
+Pre 13.0 versions of DbVisualizer can still connect to {es} by having the <<sql-jdbc, JDBC driver>> set up from the generic *Custom* template.
 
-Add the {es} JDBC driver to DbVisualizer through *Tools* > *Driver Manager*:
+==== Setup the {es} JDBC driver
+
+Setup the {es} JDBC driver through *Tools* > *Driver Manager*:
 
 image:images/sql/client-apps/dbvis-1-driver-manager.png[]
 
-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*.
+Select *Elasticsearch* driver template from the left sidebar to create a new user driver:
+
+image:images/sql/client-apps/dbvis-2-driver-manager-elasticsearch.png[]
+
+Download the driver locally:
 
-image:images/sql/client-apps/dbvis-2-driver.png[]
+image:images/sql/client-apps/dbvis-3-driver-manager-download.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[]
+and check its availability status:
+
+image:images/sql/client-apps/dbvis-4-driver-manager-ready.png[]
 
 ==== Create a new connection
 
 Once the {es} driver is in place, create a new connection:
 
-image:images/sql/client-apps/dbvis-4-new-conn.png[]
+image:images/sql/client-apps/dbvis-5-new-conn.png[]
+
+by double-clicking the {es} entry in the list of available drivers:
 
-One can use the wizard or add the settings all at once:
+image:images/sql/client-apps/dbvis-6-new-conn-elasticsearch.png[]
 
-image:images/sql/client-apps/dbvis-5-conn-props.png[]
+Enter the connection details, then press *Connect* and the driver version (as that of the cluster) should show up under *Connection Message*.
 
-Press *Connect* and the driver version (as that of the cluster) should show up under *Connection Message*.
+image:images/sql/client-apps/dbvis-7-new-conn-connect.png[]
 
 ==== Execute SQL queries
 
 The setup is done. DbVisualizer can be used to run queries against {es} and explore its content:
 
-image:images/sql/client-apps/dbvis-6-data.png[]
+image:images/sql/client-apps/dbvis-8-data.png[]