harlequin-exasol

Harelequin adapter for Exasol

⚠️ Disclaimer

The current state of this project is a spike—an initial evaluation of what is possible and how much effort specific tasks will require. It should only be used for evaluating Exasol usage via Harlequin.

Below, you will find information if you are interested in trying it out and getting an idea of it. While issues reported beyond the mentioned limitations are welcome for tracking purposes, addressing these issues is unlikely at any point. However, having a list of issues may be helpful to other evaluators.

🚀 Features

• Basic Catalog
• Basic Query Completion
• Basic Query Support, including DDL

Getting Started

🔌️ Prerequisites

• Python >= 3.9

💾 Installation

Install the package using pipx:

pipx install harlequin-exasol --include-deps

▶️ Starting Harlequin

Open Harlequin and connect it to your database:

harlequin -a exasol --schema 'foo' --host '8.9.10.1' --port 8563 ...

For connecting to a standard Exasol Docker DB, most defaults should work just fine:

harlequin -a exasol --disable-certificate-validation

📚 Documentation

Note: For further help on the supported settings and flags, check out the Exasol Adapter Options section in the help provided by Harlequin:

harlequin --help

Details about Harlequin can be found on the official website:

• Keyboard bindings
• Configuration
• Theming

💥 Known Issues

• Queries cannot be sent while metadata is loading. (@exaSR)
• Only empty error windows will be shown. (Multiple Reports)

💡 Ideas

• (upstream) Make it possible to disable or toggle the datacatalogue tab to increase available space for power users (@exaSR)

📝 Todo's

• Investigate dbapi2 issue with parameters in the prepared statement where clause (exasol.driver.dbapi2):

  schema = 'foo'
  query = f"SELECT TABLE_NAME FROM EXA_ALL_TABLES WHERE TABLE_SCHEMA='{schema}';"
  cursor.execute(query)

  vs

  schema = 'foo'
  query = "SELECT TABLE_NAME FROM EXA_ALL_TABLES WHERE TABLE_SCHEMA=?;"
  cursor.execute(query, schema)

• Consider making catalog functions asynchronous to improve progress indicator updates.

• Support subcategories for system tables based on schema (SYS, EXA_STATISTICS).

• Support table details (columns) for system tables.

• Add/Update unit/integration tests.

• Add CI/CD.

• Contact the maintainer of Harlequin to mention Exasol support on the Harlequin website.