workbench.asciidoc 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[sql-client-apps-workbench]]
  4. === SQL Workbench/J
  5. [quote, https://www.sql-workbench.eu/]
  6. ____
  7. https://www.sql-workbench.eu/[SQL Workbench/J] is a free, DBMS-independent, cross-platform SQL query tool.
  8. ____
  9. 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.
  10. ==== Prerequisites
  11. * {es-sql} <<sql-jdbc, JDBC driver>>
  12. ==== Add {es} JDBC driver
  13. Add the {es} JDBC driver to SQL Workbench/J through *Manage Drivers* either from the main windows in the *File* menu or from the *Connect* window:
  14. image:images/sql/client-apps/workbench-1-manage-drivers.png[]
  15. Add a new entry to the list through the blank page button in the upper left corner. Add the JDBC jar, provide a name and click on the magnifier button to have the driver *Classname* picked-up automatically:
  16. image:images/sql/client-apps/workbench-2-add-driver.png[]
  17. ==== Create a new connection profile
  18. With the driver configured, create a new connection profile through *File* > *Connect Window* (or Alt+C shortcut):
  19. image:images/sql/client-apps/workbench-3-connection.png[]
  20. Select the previously configured driver and set the URL of your cluster using the JDBC syntax.
  21. Verify the connection through the *Test* button - a confirmation window should appear that everything is properly configured.
  22. The setup is complete.
  23. ==== Execute SQL queries
  24. SQL Workbench/J is ready to talk to {es} through SQL: click on the profile created to execute statements or explore the data:
  25. image:images/sql/client-apps/workbench-4-data.png[]