dbeaver.asciidoc 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[sql-client-apps-dbeaver]]
  4. === DBeaver
  5. You can use the {es} JDBC driver to access {es} data from DBeaver.
  6. 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.
  7. ==== Prerequisites
  8. * https://dbeaver.io/[DBeaver] version 6.0.0 or higher
  9. * {es-sql} <<sql-jdbc, JDBC driver>>
  10. ==== New Connection
  11. Create a new connection either through the menu *File* > *New* > *Database Connection* menu or directly through the *Database Connection* panel.
  12. image:images/sql/client-apps/dbeaver-1-new-conn.png[]
  13. ==== Select {es} type
  14. Select the {es} type from the available connection types:
  15. image:images/sql/client-apps/dbeaver-2-conn-es.png[]
  16. ==== Specify the {es} cluster information
  17. Configure the {es-sql} connection appropriately:
  18. image:images/sql/client-apps/dbeaver-3-conn-props.png[]
  19. ==== Verify the driver version
  20. Make sure the correct JDBC driver version is used by using the *Edit Driver Settings* button:
  21. image:images/sql/client-apps/dbeaver-4-driver-ver.png[]
  22. 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.
  23. 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.
  24. ==== Test connectivity
  25. 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}:
  26. image:images/sql/client-apps/dbeaver-5-test-conn.png[]
  27. Click *Finish* and the new {es} connection appears in the *Database Connection* panel.
  28. DBeaver is now configured to talk to {es}.
  29. ==== Connect to {es}
  30. Simply click on the {es} connection and start querying and exploring {es}:
  31. image:images/sql/client-apps/dbeaver-6-data.png[]