elasticsearch/docs/reference/sql/endpoints/client-apps/dbvis.asciidoc
Bogdan Pintea f50ceecbd4
SQL: Update DbVisualizer connection steps (#85167)
Update DbVisualizer connection steps to reflect version 13.0's integrated
Elasticsearch support.
2022-03-31 16:48:24 +02:00

53 lines
1.6 KiB
Text

[role="xpack"]
[[sql-client-apps-dbvis]]
=== DbVisualizer
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.
==== Prerequisites
* https://www.dbvis.com/[DbVisualizer] 13.0 or higher
* {es-sql} <<sql-jdbc, 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.
==== 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 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-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-5-new-conn.png[]
by double-clicking the {es} entry in the list of available drivers:
image:images/sql/client-apps/dbvis-6-new-conn-elasticsearch.png[]
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-8-data.png[]