diff --git a/docs/reference/images/sql/client-apps/dbvis-1-driver-manager.png b/docs/reference/images/sql/client-apps/dbvis-1-driver-manager.png index d9290e63deac..8cde47bb64ea 100644 Binary files a/docs/reference/images/sql/client-apps/dbvis-1-driver-manager.png and b/docs/reference/images/sql/client-apps/dbvis-1-driver-manager.png differ diff --git a/docs/reference/images/sql/client-apps/dbvis-2-driver-manager-elasticsearch.png b/docs/reference/images/sql/client-apps/dbvis-2-driver-manager-elasticsearch.png new file mode 100644 index 000000000000..ac30326b966e Binary files /dev/null and b/docs/reference/images/sql/client-apps/dbvis-2-driver-manager-elasticsearch.png differ diff --git a/docs/reference/images/sql/client-apps/dbvis-2-driver.png b/docs/reference/images/sql/client-apps/dbvis-2-driver.png deleted file mode 100644 index a5cbddfefbda..000000000000 Binary files a/docs/reference/images/sql/client-apps/dbvis-2-driver.png and /dev/null differ diff --git a/docs/reference/images/sql/client-apps/dbvis-3-add-driver.png b/docs/reference/images/sql/client-apps/dbvis-3-add-driver.png deleted file mode 100644 index bab82fae3f22..000000000000 Binary files a/docs/reference/images/sql/client-apps/dbvis-3-add-driver.png and /dev/null differ diff --git a/docs/reference/images/sql/client-apps/dbvis-3-driver-manager-download.png b/docs/reference/images/sql/client-apps/dbvis-3-driver-manager-download.png new file mode 100644 index 000000000000..d3dee62dc8aa Binary files /dev/null and b/docs/reference/images/sql/client-apps/dbvis-3-driver-manager-download.png differ diff --git a/docs/reference/images/sql/client-apps/dbvis-4-driver-manager-ready.png b/docs/reference/images/sql/client-apps/dbvis-4-driver-manager-ready.png new file mode 100644 index 000000000000..6e7003cc479d Binary files /dev/null and b/docs/reference/images/sql/client-apps/dbvis-4-driver-manager-ready.png differ diff --git a/docs/reference/images/sql/client-apps/dbvis-4-new-conn.png b/docs/reference/images/sql/client-apps/dbvis-4-new-conn.png deleted file mode 100644 index 3001641b5314..000000000000 Binary files a/docs/reference/images/sql/client-apps/dbvis-4-new-conn.png and /dev/null differ diff --git a/docs/reference/images/sql/client-apps/dbvis-5-conn-props.png b/docs/reference/images/sql/client-apps/dbvis-5-conn-props.png deleted file mode 100644 index e59e8215ec60..000000000000 Binary files a/docs/reference/images/sql/client-apps/dbvis-5-conn-props.png and /dev/null differ diff --git a/docs/reference/images/sql/client-apps/dbvis-5-new-conn.png b/docs/reference/images/sql/client-apps/dbvis-5-new-conn.png new file mode 100644 index 000000000000..b4102ad1b853 Binary files /dev/null and b/docs/reference/images/sql/client-apps/dbvis-5-new-conn.png differ diff --git a/docs/reference/images/sql/client-apps/dbvis-6-data.png b/docs/reference/images/sql/client-apps/dbvis-6-data.png deleted file mode 100644 index 65f8a04eb5d1..000000000000 Binary files a/docs/reference/images/sql/client-apps/dbvis-6-data.png and /dev/null differ diff --git a/docs/reference/images/sql/client-apps/dbvis-6-new-conn-elasticsearch.png b/docs/reference/images/sql/client-apps/dbvis-6-new-conn-elasticsearch.png new file mode 100644 index 000000000000..e69e62657820 Binary files /dev/null and b/docs/reference/images/sql/client-apps/dbvis-6-new-conn-elasticsearch.png differ diff --git a/docs/reference/images/sql/client-apps/dbvis-7-new-conn-connect.png b/docs/reference/images/sql/client-apps/dbvis-7-new-conn-connect.png new file mode 100644 index 000000000000..51773b62bf10 Binary files /dev/null and b/docs/reference/images/sql/client-apps/dbvis-7-new-conn-connect.png differ diff --git a/docs/reference/images/sql/client-apps/dbvis-8-data.png b/docs/reference/images/sql/client-apps/dbvis-8-data.png new file mode 100644 index 000000000000..a2c5d0c3450e Binary files /dev/null and b/docs/reference/images/sql/client-apps/dbvis-8-data.png differ diff --git a/docs/reference/sql/endpoints/client-apps/dbvis.asciidoc b/docs/reference/sql/endpoints/client-apps/dbvis.asciidoc index c6e61e66758d..abae16a6e6a7 100644 --- a/docs/reference/sql/endpoints/client-apps/dbvis.asciidoc +++ b/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} <> -==== Add {es} JDBC driver +Note:: +Pre 13.0 versions of DbVisualizer can still connect to {es} by having the <> 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.png[] +image:images/sql/client-apps/dbvis-2-driver-manager-elasticsearch.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[] +Download the driver locally: + +image:images/sql/client-apps/dbvis-3-driver-manager-download.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[] -One can use the wizard or add the settings all at once: +by double-clicking the {es} entry in the list of available drivers: -image:images/sql/client-apps/dbvis-5-conn-props.png[] +image:images/sql/client-apps/dbvis-6-new-conn-elasticsearch.png[] -Press *Connect* and the driver version (as that of the cluster) should show up under *Connection Message*. +Enter the connection details, then 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[]