60 lines
2.2 KiB
Plaintext
60 lines
2.2 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[sql-client-apps-dbeaver]]
|
|
=== DBeaver
|
|
|
|
[quote, https://dbeaver.io/]
|
|
____
|
|
https://dbeaver.io/[DBeaver] DBeaver is free and open source universal database tool for developers and database administrators.
|
|
____
|
|
|
|
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.
|
|
|
|
==== Prerequisites
|
|
|
|
* DBeaver version 6.0.0 or higher
|
|
* {es-sql} <<sql-jdbc, JDBC driver>>
|
|
|
|
==== New Connection
|
|
|
|
Create a new connection either through the menu *File* > *New* > *Database Connection* menu or directly through the *Database Connection* panel.
|
|
|
|
image:images/sql/client-apps/dbeaver-1-new-conn.png[]
|
|
|
|
==== Select {es} type
|
|
Select the {es} type from the available connection types:
|
|
|
|
image:images/sql/client-apps/dbeaver-2-conn-es.png[]
|
|
|
|
==== Specify the {es} cluster information
|
|
|
|
Configure the {es-sql} connection appropriately:
|
|
|
|
image:images/sql/client-apps/dbeaver-3-conn-props.png[]
|
|
|
|
==== Verify the driver version
|
|
|
|
Make sure the correct JDBC driver version is used by using the *Edit Driver Settings* button:
|
|
|
|
image:images/sql/client-apps/dbeaver-4-driver-ver.png[]
|
|
|
|
DBeaver is aware of the {es} JDBC maven repository so simply *Download/Update* the artifact or add a new one. As an alternative one can add a local file instead if the {es} Maven repository is not an option.
|
|
|
|
When changing the driver, make sure to click on the *Find Class* button at the bottom - the Driver class should be picked out automatically however this provides a sanity check that the driver jar is properly found and it is not corrupt.
|
|
|
|
==== Test connectivity
|
|
|
|
Once the driver version and the settings are in place, use *Test Connection* to check that everything works. If things are okay, one should get a confirmation window with the version of the driver and that of {es-sql}:
|
|
|
|
image:images/sql/client-apps/dbeaver-5-test-conn.png[]
|
|
|
|
Click *Finish* and the new {es} connection appears in the *Database Connection* panel.
|
|
|
|
DBeaver is now configured to talk to {es}.
|
|
|
|
==== Connect to {es}
|
|
|
|
Simply click on the {es} connection and start querying and exploring {es}:
|
|
|
|
image:images/sql/client-apps/dbeaver-6-data.png[]
|