v1.22.0

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.22.0] - 2024-06-27

Features

• Harlequin now loads key bindings from keymap plug-ins, and accepts a --keymap_name CLI option to specify a keymap to be loaded. This option can be repeated to load (and merge) multiple keymaps.
• Harlequin now also loads key bindings from keymaps configured in Harlequin config files or pyproject.toml files. To merge user-defined keymaps with keymap plug-ins, repeat the --keymap-name option. For example: --keymap-name vscode --keymap-name my_custom_keymap. For more information on user-defined keymaps, see Harlequin's docs.
• Harlequin ships with a new app for creating keymaps to customize keybindings. You can run it with harlequin --keys. The new app will load any existing keymap config and allow you to edit individual bindings. On quitting the app, it will write the new keymap to a file, so you can use it the next time you start Harlequin.

Changed

• The default key bindings have been refactored to a plug-in in a separate package (harlequin_vscode) that is distributed with Harlequin.

[1.21.0] - 2024-06-17

• The Cassandra adapter is now installable as an extra; use pip install harlequin[cassandra].
• The NebulaGraph adapter is now installable as an extra; use pip install harlequin[nebulagraph].

[1.20.0] - 2024-04-29

Features

• For adapters that support it, Harlequin now provides a buttons to toggle the transaction mode of the database connection, and commit and roll back transactions (#334).
• Adapters can now implement HarlequinConnection.transaction_mode and HarlequinConnection.toggle_transaction_mode() to enable the new Transaction Mode UI for their adapter.

Changed

• SQLite adapter: The adapter no longer accepts an --isolation-level option on Python 3.12 or higher; instead, the adapter allows autocommit configuration via the Harlequin UI.

[1.19.0] - 2024-04-25

Features

• SQLite adapter: Harlequin now executes an initialization script on start-up of the SQLite adapter. By default, it executes the script found at ~/.sqliterc. To execute a different script, start Harlequin with the --init-path option (aliases -i/-init):

  harlequin -a sqlite --init-path ./my-project-script

  To start Harlequin without executing an initialization script, use the --no-init flag:

  harlequin -a sqlite --no-init

  Note: SQLite initialization scripts can contain dot commands or SQL statements. If Harlequin encounters a dot command, it will attempt to rewrite it as a SQL statement, and then execute the rewritten statement. Otherwise, it will ignore the dot command. Currently, Harlequin can only rewrite .open and .load commands.

  (#325)

• SQLite adapter: Adds a new CLI option, --extension or -e, which will load a SQLite extension. Note: SQLite extensions are not supported by Python on most platforms by default. See here for more details (#533).

[1.18.0] - 2024-04-19

Features

• The Query Editor's Open and Save dialogs now display the full computed file path that will be opened or saved (tconbeer/textual-textarea#232 - thank you @bjornasm!)
• The Query Editor adds a "Find" action with ctrl+f and "Find Next" action with F3.
• The Query Editor adds a "Go To Line" action with ctrl+g.
• The Query Editor adds bindings for ctrl+shift+home/end to select text while moving the cursor to the start/end of the document.

Bug Fixes

• Fixes a crash from initializing the Error Modal incorrectly from the Query Editor.
• Fixes a crash from saving to a path in a non-existent directory.

Changes

• The Query Editor uses a slightly different implementation of undo and redo, with improved performance and some subtly different behavior (#240.

[1.17.0] - 2024-04-16

Features

• A new HarlequinConnection.close() method can be implemented by adapters to gracefully close database connections when the application exits.
• The ADBC adapter is now installable as an extra; use pip install harlequin[adbc].

Bug Fixes

• Fixes broken link on clipboard error message (#509)

[1.16.2] - 2024-03-29

Bug Fixes

• If the cursor is after the final semicolon in the query editor, and there is only whitespace after the semicolon, Harlequin will now execute the last query before the semicolon, instead of doing nothing when clicking Run Query or pressing ctrl+j.

[1.16.1] - 2024-03-27

Bug Fixes

• Pressing F8 on the history screen no longer causes a crash (#485)

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) ([#375](https://github.com/tconbeer/harlequin/...

v1.21.0

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.21.0] - 2024-06-17

• The Cassandra adapter is now installable as an extra; use pip install harlequin[cassandra].
• The NebulaGraph adapter is now installable as an extra; use pip install harlequin[nebulagraph].

[1.20.0] - 2024-04-29

Features

• For adapters that support it, Harlequin now provides a buttons to toggle the transaction mode of the database connection, and commit and roll back transactions (#334).
• Adapters can now implement HarlequinConnection.transaction_mode and HarlequinConnection.toggle_transaction_mode() to enable the new Transaction Mode UI for their adapter.

Changed

• SQLite adapter: The adapter no longer accepts an --isolation-level option on Python 3.12 or higher; instead, the adapter allows autocommit configuration via the Harlequin UI.

[1.19.0] - 2024-04-25

Features

• SQLite adapter: Harlequin now executes an initialization script on start-up of the SQLite adapter. By default, it executes the script found at ~/.sqliterc. To execute a different script, start Harlequin with the --init-path option (aliases -i/-init):

  harlequin -a sqlite --init-path ./my-project-script

  To start Harlequin without executing an initialization script, use the --no-init flag:

  harlequin -a sqlite --no-init

  Note: SQLite initialization scripts can contain dot commands or SQL statements. If Harlequin encounters a dot command, it will attempt to rewrite it as a SQL statement, and then execute the rewritten statement. Otherwise, it will ignore the dot command. Currently, Harlequin can only rewrite .open and .load commands.

  (#325)

• SQLite adapter: Adds a new CLI option, --extension or -e, which will load a SQLite extension. Note: SQLite extensions are not supported by Python on most platforms by default. See here for more details (#533).

[1.18.0] - 2024-04-19

Features

• The Query Editor's Open and Save dialogs now display the full computed file path that will be opened or saved (tconbeer/textual-textarea#232 - thank you @bjornasm!)
• The Query Editor adds a "Find" action with ctrl+f and "Find Next" action with F3.
• The Query Editor adds a "Go To Line" action with ctrl+g.
• The Query Editor adds bindings for ctrl+shift+home/end to select text while moving the cursor to the start/end of the document.

Bug Fixes

• Fixes a crash from initializing the Error Modal incorrectly from the Query Editor.
• Fixes a crash from saving to a path in a non-existent directory.

Changes

• The Query Editor uses a slightly different implementation of undo and redo, with improved performance and some subtly different behavior (#240.

[1.17.0] - 2024-04-16

Features

• A new HarlequinConnection.close() method can be implemented by adapters to gracefully close database connections when the application exits.
• The ADBC adapter is now installable as an extra; use pip install harlequin[adbc].

Bug Fixes

• Fixes broken link on clipboard error message (#509)

[1.16.2] - 2024-03-29

Bug Fixes

• If the cursor is after the final semicolon in the query editor, and there is only whitespace after the semicolon, Harlequin will now execute the last query before the semicolon, instead of doing nothing when clicking Run Query or pressing ctrl+j.

[1.16.1] - 2024-03-27

Bug Fixes

• Pressing F8 on the history screen no longer causes a crash (#485)

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01...

v1.20.0

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.20.0] - 2024-04-29

Features

• For adapters that support it, Harlequin now provides a buttons to toggle the transaction mode of the database connection, and commit and roll back transactions (#334).
• Adapters can now implement HarlequinConnection.transaction_mode and HarlequinConnection.toggle_transaction_mode() to enable the new Transaction Mode UI for their adapter.

Changed

• SQLite adapter: The adapter no longer accepts an --isolation-level option on Python 3.12 or higher; instead, the adapter allows autocommit configuration via the Harlequin UI.

[1.19.0] - 2024-04-25

Features

• SQLite adapter: Harlequin now executes an initialization script on start-up of the SQLite adapter. By default, it executes the script found at ~/.sqliterc. To execute a different script, start Harlequin with the --init-path option (aliases -i/-init):

  harlequin -a sqlite --init-path ./my-project-script

  To start Harlequin without executing an initialization script, use the --no-init flag:

  harlequin -a sqlite --no-init

  Note: SQLite initialization scripts can contain dot commands or SQL statements. If Harlequin encounters a dot command, it will attempt to rewrite it as a SQL statement, and then execute the rewritten statement. Otherwise, it will ignore the dot command. Currently, Harlequin can only rewrite .open and .load commands.

  (#325)

• SQLite adapter: Adds a new CLI option, --extension or -e, which will load a SQLite extension. Note: SQLite extensions are not supported by Python on most platforms by default. See here for more details (#533).

[1.18.0] - 2024-04-19

Features

• The Query Editor's Open and Save dialogs now display the full computed file path that will be opened or saved (tconbeer/textual-textarea#232 - thank you @bjornasm!)
• The Query Editor adds a "Find" action with ctrl+f and "Find Next" action with F3.
• The Query Editor adds a "Go To Line" action with ctrl+g.
• The Query Editor adds bindings for ctrl+shift+home/end to select text while moving the cursor to the start/end of the document.

Bug Fixes

• Fixes a crash from initializing the Error Modal incorrectly from the Query Editor.
• Fixes a crash from saving to a path in a non-existent directory.

Changes

• The Query Editor uses a slightly different implementation of undo and redo, with improved performance and some subtly different behavior (#240.

[1.17.0] - 2024-04-16

Features

• A new HarlequinConnection.close() method can be implemented by adapters to gracefully close database connections when the application exits.
• The ADBC adapter is now installable as an extra; use pip install harlequin[adbc].

Bug Fixes

• Fixes broken link on clipboard error message (#509)

[1.16.2] - 2024-03-29

Bug Fixes

• If the cursor is after the final semicolon in the query editor, and there is only whitespace after the semicolon, Harlequin will now execute the last query before the semicolon, instead of doing nothing when clicking Run Query or pressing ctrl+j.

[1.16.1] - 2024-03-27

Bug Fixes

• Pressing F8 on the history screen no longer causes a crash (#485)

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01-09

Bug Fixes

• Improves compatibility for adapter return types...

v1.19.0

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.19.0] - 2024-04-25

Features

• SQLite adapter: Harlequin now executes an initialization script on start-up of the SQLite adapter. By default, it executes the script found at ~/.sqliterc. To execute a different script, start Harlequin with the --init-path option (aliases -i/-init):

  harlequin -a sqlite --init-path ./my-project-script

  To start Harlequin without executing an initialization script, use the --no-init flag:

  harlequin -a sqlite --no-init

  Note: SQLite initialization scripts can contain dot commands or SQL statements. If Harlequin encounters a dot command, it will attempt to rewrite it as a SQL statement, and then execute the rewritten statement. Otherwise, it will ignore the dot command. Currently, Harlequin can only rewrite .open and .load commands.

  (#325)

• SQLite adapter: Adds a new CLI option, --extension or -e, which will load a SQLite extension. Note: SQLite extensions are not supported by Python on most platforms by default. See here for more details (#533).

[1.18.0] - 2024-04-19

Features

• The Query Editor's Open and Save dialogs now display the full computed file path that will be opened or saved (tconbeer/textual-textarea#232 - thank you @bjornasm!)
• The Query Editor adds a "Find" action with ctrl+f and "Find Next" action with F3.
• The Query Editor adds a "Go To Line" action with ctrl+g.
• The Query Editor adds bindings for ctrl+shift+home/end to select text while moving the cursor to the start/end of the document.

Bug Fixes

• Fixes a crash from initializing the Error Modal incorrectly from the Query Editor.
• Fixes a crash from saving to a path in a non-existent directory.

Changes

• The Query Editor uses a slightly different implementation of undo and redo, with improved performance and some subtly different behavior (#240.

[1.17.0] - 2024-04-16

Features

• A new HarlequinConnection.close() method can be implemented by adapters to gracefully close database connections when the application exits.
• The ADBC adapter is now installable as an extra; use pip install harlequin[adbc].

Bug Fixes

• Fixes broken link on clipboard error message (#509)

[1.16.2] - 2024-03-29

Bug Fixes

• If the cursor is after the final semicolon in the query editor, and there is only whitespace after the semicolon, Harlequin will now execute the last query before the semicolon, instead of doing nothing when clicking Run Query or pressing ctrl+j.

[1.16.1] - 2024-03-27

Bug Fixes

• Pressing F8 on the history screen no longer causes a crash (#485)

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01-09

Bug Fixes

• Improves compatibility for adapter return types to accept a sequence of any iterable (tconbeer/textual-fastdatatable#68).

[1.9.0] - 2024-01-08

Features

• Improves keyboard navigation of the Results Viewer by adding key bindings, including ctrl+right/left/up/down/home/end, tab, and ctrl+a.
• The Trino adapter is now installable as an extra; use pip install harlequin[trino].
• Harlequin will automatically download a missing timezone database on Windows. Prevent this behavior with --no-download-tzdata.

Bug Fixes

• Fixes a crash when selecting data from a timest...

v1.18.0

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.18.0] - 2024-04-19

Features

• The Query Editor's Open and Save dialogs now display the full computed file path that will be opened or saved (tconbeer/textual-textarea#232 - thank you @bjornasm!)
• The Query Editor adds a "Find" action with ctrl+f and "Find Next" action with F3.
• The Query Editor adds a "Go To Line" action with ctrl+g.
• The Query Editor adds bindings for ctrl+shift+home/end to select text while moving the cursor to the start/end of the document.

Bug Fixes

• Fixes a crash from initializing the Error Modal incorrectly from the Query Editor.
• Fixes a crash from saving to a path in a non-existent directory.

Changes

• The Query Editor uses a slightly different implementation of undo and redo, with improved performance and some subtly different behavior (#240.

[1.17.0] - 2024-04-16

Features

• A new HarlequinConnection.close() method can be implemented by adapters to gracefully close database connections when the application exits.
• The ADBC adapter is now installable as an extra; use pip install harlequin[adbc].

Bug Fixes

• Fixes broken link on clipboard error message (#509)

[1.16.2] - 2024-03-29

Bug Fixes

• If the cursor is after the final semicolon in the query editor, and there is only whitespace after the semicolon, Harlequin will now execute the last query before the semicolon, instead of doing nothing when clicking Run Query or pressing ctrl+j.

[1.16.1] - 2024-03-27

Bug Fixes

• Pressing F8 on the history screen no longer causes a crash (#485)

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01-09

Bug Fixes

• Improves compatibility for adapter return types to accept a sequence of any iterable (tconbeer/textual-fastdatatable#68).

[1.9.0] - 2024-01-08

Features

• Improves keyboard navigation of the Results Viewer by adding key bindings, including ctrl+right/left/up/down/home/end, tab, and ctrl+a.
• The Trino adapter is now installable as an extra; use pip install harlequin[trino].
• Harlequin will automatically download a missing timezone database on Windows. Prevent this behavior with --no-download-tzdata.

Bug Fixes

• Fixes a crash when selecting data from a timestamptz field (#382) (or another field with an invalid Arrow data type).

[1.8.0] - 2023-12-21

Features

• Select a range of cells in the Results Viewer by clicking and dragging or by holding shift while moving the cursor with the keyboard.
• Copy selected cells from the Results Viewer by pressing ctrl+c.
• Very long values in the Results Viewer are now truncated, with an elipsis (…). The full value is shown in a tooltip when hovering over a truncated value. (The full value will also be copied to the clipboard).
• The BigQuery adapter is now installable as an extra; use pip install harlequin[bigquery].

Bug Fixes

• Fixes an issue on Windows where pressing shift or ctrl would hide the member autocomplete menu.
• Fixes flaky query execution behavior on some platforms.

Testing

• tests/functional_tests/test_app.py has been refactored into many smaller files.
• Fixes an issue with cache tests where the user's main harlequin cache was used instead of a mocked cache location.

[1.7.3] - 2023-12-15

Bug Fixes

• Fixes an issue where completions were truncated improperly in the autocomplete menu.
  ...

v1.17.0

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.17.0] - 2024-04-16

Features

• A new HarlequinConnection.close() method can be implemented by adapters to gracefully close database connections when the application exits.
• The ADBC adapter is now installable as an extra; use pip install harlequin[adbc].

Bug Fixes

• Fixes broken link on clipboard error message (#509)

[1.16.2] - 2024-03-29

Bug Fixes

• If the cursor is after the final semicolon in the query editor, and there is only whitespace after the semicolon, Harlequin will now execute the last query before the semicolon, instead of doing nothing when clicking Run Query or pressing ctrl+j.

[1.16.1] - 2024-03-27

Bug Fixes

• Pressing F8 on the history screen no longer causes a crash (#485)

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01-09

Bug Fixes

• Improves compatibility for adapter return types to accept a sequence of any iterable (tconbeer/textual-fastdatatable#68).

[1.9.0] - 2024-01-08

Features

• Improves keyboard navigation of the Results Viewer by adding key bindings, including ctrl+right/left/up/down/home/end, tab, and ctrl+a.
• The Trino adapter is now installable as an extra; use pip install harlequin[trino].
• Harlequin will automatically download a missing timezone database on Windows. Prevent this behavior with --no-download-tzdata.

Bug Fixes

• Fixes a crash when selecting data from a timestamptz field (#382) (or another field with an invalid Arrow data type).

[1.8.0] - 2023-12-21

Features

• Select a range of cells in the Results Viewer by clicking and dragging or by holding shift while moving the cursor with the keyboard.
• Copy selected cells from the Results Viewer by pressing ctrl+c.
• Very long values in the Results Viewer are now truncated, with an elipsis (…). The full value is shown in a tooltip when hovering over a truncated value. (The full value will also be copied to the clipboard).
• The BigQuery adapter is now installable as an extra; use pip install harlequin[bigquery].

Bug Fixes

• Fixes an issue on Windows where pressing shift or ctrl would hide the member autocomplete menu.
• Fixes flaky query execution behavior on some platforms.

Testing

• tests/functional_tests/test_app.py has been refactored into many smaller files.
• Fixes an issue with cache tests where the user's main harlequin cache was used instead of a mocked cache location.

[1.7.3] - 2023-12-15

Bug Fixes

• Fixes an issue where completions were truncated improperly in the autocomplete menu.

Testing

• Prevents limit input cursor blink when running tests in headless mode, for less flaky tests.

[1.7.2] - 2023-12-14

Features

• The MySQL adapter is now installable as an extra; use pip install harlequin[mysql].

[1.7.1] - 2023-12-14

Bug Fixes

• Fixes a crash when using harlequin-postgres and executing a select statement that returns zero records.

[1.7.0] - 2023-12-13

Features

• AUTOCOMPLETE! Harlequin's query editor will now offer completions in a drop-down for SQL keywords, functions, and database objects (like tables, views, columns). With the autocomplete list open, use up, down, PgUp, PgDn, to select an option and enter or Tab to insert it into the editor.
• Harlequin now uses a new TextArea widget for its code editor. This improves performance for long queries, adds line numbers in a gutter, and changes the underlying engine for syntax highlighting from Pygments to Tree Sitte...

v1.16.2

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.16.2] - 2024-03-29

Bug Fixes

• If the cursor is after the final semicolon in the query editor, and there is only whitespace after the semicolon, Harlequin will now execute the last query before the semicolon, instead of doing nothing when clicking Run Query or pressing ctrl+j.

[1.16.1] - 2024-03-27

Bug Fixes

• Pressing F8 on the history screen no longer causes a crash (#485)

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01-09

Bug Fixes

• Improves compatibility for adapter return types to accept a sequence of any iterable (tconbeer/textual-fastdatatable#68).

[1.9.0] - 2024-01-08

Features

• Improves keyboard navigation of the Results Viewer by adding key bindings, including ctrl+right/left/up/down/home/end, tab, and ctrl+a.
• The Trino adapter is now installable as an extra; use pip install harlequin[trino].
• Harlequin will automatically download a missing timezone database on Windows. Prevent this behavior with --no-download-tzdata.

Bug Fixes

• Fixes a crash when selecting data from a timestamptz field (#382) (or another field with an invalid Arrow data type).

[1.8.0] - 2023-12-21

Features

• Select a range of cells in the Results Viewer by clicking and dragging or by holding shift while moving the cursor with the keyboard.
• Copy selected cells from the Results Viewer by pressing ctrl+c.
• Very long values in the Results Viewer are now truncated, with an elipsis (…). The full value is shown in a tooltip when hovering over a truncated value. (The full value will also be copied to the clipboard).
• The BigQuery adapter is now installable as an extra; use pip install harlequin[bigquery].

Bug Fixes

• Fixes an issue on Windows where pressing shift or ctrl would hide the member autocomplete menu.
• Fixes flaky query execution behavior on some platforms.

Testing

• tests/functional_tests/test_app.py has been refactored into many smaller files.
• Fixes an issue with cache tests where the user's main harlequin cache was used instead of a mocked cache location.

[1.7.3] - 2023-12-15

Bug Fixes

• Fixes an issue where completions were truncated improperly in the autocomplete menu.

Testing

• Prevents limit input cursor blink when running tests in headless mode, for less flaky tests.

[1.7.2] - 2023-12-14

Features

• The MySQL adapter is now installable as an extra; use pip install harlequin[mysql].

[1.7.1] - 2023-12-14

Bug Fixes

• Fixes a crash when using harlequin-postgres and executing a select statement that returns zero records.

[1.7.0] - 2023-12-13

Features

• AUTOCOMPLETE! Harlequin's query editor will now offer completions in a drop-down for SQL keywords, functions, and database objects (like tables, views, columns). With the autocomplete list open, use up, down, PgUp, PgDn, to select an option and enter or Tab to insert it into the editor.
• Harlequin now uses a new TextArea widget for its code editor. This improves performance for long queries, adds line numbers in a gutter, and changes the underlying engine for syntax highlighting from Pygments to Tree Sitter (tconbeer/textual-textarea#123).
• In the Query Editor: double-click to select a word, triple-click to select a line, and quadruple-click to select the entire query (tconbeer/textual-textarea#111, [tconbeer/textual-textarea#112](https://github.com/tconbeer/textual-textarea/issu...

v1.16.1

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.16.1] - 2024-03-27

Bug Fixes

• Pressing F8 on the history screen no longer causes a crash (#485)

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01-09

Bug Fixes

• Improves compatibility for adapter return types to accept a sequence of any iterable (tconbeer/textual-fastdatatable#68).

[1.9.0] - 2024-01-08

Features

• Improves keyboard navigation of the Results Viewer by adding key bindings, including ctrl+right/left/up/down/home/end, tab, and ctrl+a.
• The Trino adapter is now installable as an extra; use pip install harlequin[trino].
• Harlequin will automatically download a missing timezone database on Windows. Prevent this behavior with --no-download-tzdata.

Bug Fixes

• Fixes a crash when selecting data from a timestamptz field (#382) (or another field with an invalid Arrow data type).

[1.8.0] - 2023-12-21

Features

• Select a range of cells in the Results Viewer by clicking and dragging or by holding shift while moving the cursor with the keyboard.
• Copy selected cells from the Results Viewer by pressing ctrl+c.
• Very long values in the Results Viewer are now truncated, with an elipsis (…). The full value is shown in a tooltip when hovering over a truncated value. (The full value will also be copied to the clipboard).
• The BigQuery adapter is now installable as an extra; use pip install harlequin[bigquery].

Bug Fixes

• Fixes an issue on Windows where pressing shift or ctrl would hide the member autocomplete menu.
• Fixes flaky query execution behavior on some platforms.

Testing

• tests/functional_tests/test_app.py has been refactored into many smaller files.
• Fixes an issue with cache tests where the user's main harlequin cache was used instead of a mocked cache location.

[1.7.3] - 2023-12-15

Bug Fixes

• Fixes an issue where completions were truncated improperly in the autocomplete menu.

Testing

• Prevents limit input cursor blink when running tests in headless mode, for less flaky tests.

[1.7.2] - 2023-12-14

Features

• The MySQL adapter is now installable as an extra; use pip install harlequin[mysql].

[1.7.1] - 2023-12-14

Bug Fixes

• Fixes a crash when using harlequin-postgres and executing a select statement that returns zero records.

[1.7.0] - 2023-12-13

Features

• AUTOCOMPLETE! Harlequin's query editor will now offer completions in a drop-down for SQL keywords, functions, and database objects (like tables, views, columns). With the autocomplete list open, use up, down, PgUp, PgDn, to select an option and enter or Tab to insert it into the editor.
• Harlequin now uses a new TextArea widget for its code editor. This improves performance for long queries, adds line numbers in a gutter, and changes the underlying engine for syntax highlighting from Pygments to Tree Sitter (tconbeer/textual-textarea#123).
• In the Query Editor: double-click to select a word, triple-click to select a line, and quadruple-click to select the entire query (tconbeer/textual-textarea#111, tconbeer/textual-textarea#112).

Changes

• Changes the default theme to harlequin.

Adapter API Changes

• Many key types are now exported from the main harlequin package: HarlequinAdapter, HarlequinConnection, HarlequinCursor, HarlequinAdapterOption, HarlequinCopyFormat, HarlequinCompletion.
• ...

v1.16.0

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.16.0] - 2024-02-22

Changes

• The default search path and priority for config files has changed, to better align with the standard defined by each operating system. Harlequin now loads config files from the following locations (and merges them, with items listed first taking priority):
  1. The file located at the path provided by the --config-path CLI option.
  2. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the current working directory.
  3. Files named harlequin.toml, .harlequin.toml, or config.toml in the user's default config directory, in the harlequin subdirectory. For example:
     • Linux: $XDG_CONFIG_HOME/harlequin/config.toml or ~/.config/harlequin/config.toml
     • Mac: ~/Library/Application Support/harlequin/config.toml
     • Windows: ~\AppData\Local\harlequin\config.toml
  4. Files named harlequin.toml, .harlequin.toml, or pyproject.toml in the user's home directory (~).
     (#471)

Features

• harlequin --config option now accepts the --config-path CLI option (#466).
• harlequin --config now defaults to updating the nearest (highest priority) existing config file in the default search path, instead of ./.harlequin.toml.

Bug Fixes

• harlequin --config creates a new file (parent folder as well, if non-existent) instead of crashing with FileNotFoundError (#465)

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01-09

Bug Fixes

• Improves compatibility for adapter return types to accept a sequence of any iterable (tconbeer/textual-fastdatatable#68).

[1.9.0] - 2024-01-08

Features

• Improves keyboard navigation of the Results Viewer by adding key bindings, including ctrl+right/left/up/down/home/end, tab, and ctrl+a.
• The Trino adapter is now installable as an extra; use pip install harlequin[trino].
• Harlequin will automatically download a missing timezone database on Windows. Prevent this behavior with --no-download-tzdata.

Bug Fixes

• Fixes a crash when selecting data from a timestamptz field (#382) (or another field with an invalid Arrow data type).

[1.8.0] - 2023-12-21

Features

• Select a range of cells in the Results Viewer by clicking and dragging or by holding shift while moving the cursor with the keyboard.
• Copy selected cells from the Results Viewer by pressing ctrl+c.
• Very long values in the Results Viewer are now truncated, with an elipsis (…). The full value is shown in a tooltip when hovering over a truncated value. (The full value will also be copied to the clipboard).
• The BigQuery adapter is now installable as an extra; use pip install harlequin[bigquery].

Bug Fixes

• Fixes an issue on Windows where pressing shift or ctrl would hide the member autocomplete menu.
• Fixes flaky query execution behavior on some platforms.

Testing

• tests/functional_tests/test_app.py has been refactored into many smaller files.
• Fixes an issue with cache tests where the user's main harlequin cache was used instead of a mocked cache location.

[1.7.3] - 2023-12-15

Bug Fixes

• Fixes an issue where completions were truncated improperly in the autocomplete menu.

Testing

• Prevents limit input cursor blink when running tests in headless mode, for less flaky tests.

[1.7.2] - 2023-12-14

Features

• The MySQL adapter is now installable as an extra; use pip install harlequin[mysql].

[1.7.1] - 2023-12-14

Bug Fixes

• Fixes a crash when using harlequin-postgres and executing a select statement that returns zero records.

[1.7.0] - 2023-12-13

Features

• AUTOCOMPLETE! Harlequin's query editor will now offer completions in a drop-down for SQL keywords, functions, and database objects (like tables, views, columns). With the autocomplete list open, use up, down, PgUp, PgDn, to select an option and enter or Tab to insert it into the editor.
• Harlequin now uses a new TextArea widget for its code editor. This improves performance for long queries, adds line numbers in a gutter, and changes the underlying engine for syntax highlighting from Pygments to Tree Sitter (tconbeer/textual-textarea#123).
• In the Query Editor: double-click to select a word, triple-click to select a line, and quadruple-click to select the entire query (tconbeer/textual-textarea#111, tconbeer/textual-textarea#112).

Changes

• Changes the default theme to harlequin.

Adapter API Changes

• Many key types are now exported from the main harlequin package: HarlequinAdapter, HarlequinConnection, HarlequinCursor, HarlequinAdapterOption, HarlequinCopyFormat, HarlequinCompletion.
• HarlequinConnections may now (optionally) define a get_completions() method, which should return a list of HarlequinCompletion instances; each returned complet...

v1.15.0

Harlequin CHANGELOG

All notable changes to this project will be documented in this file.

[Unreleased]

[1.15.0] - 2024-02-12

Features

• The Data Exporter has been refactored to work with any adapter.
• The Data Exporter now supports two additional formats: Feather and ORC (ORC is not supported on Windows).

Bug Fixes

• The Query Editor no longer loses focus after pressing escape (regression since 1.14.0).

[1.14.0] - 2024-02-07

Features

• The Databricks adapter is now installable as an extra; use pip install harlequin[databricks]. Thank you @alexmalins!
• In the Results Viewer, values are now formatted based on their type. Numbers have separators based on the locale, and numbers, dates/times/etc., and bools are right-aligned. Null values are now shown as a dim ∅ null, instead of a blank cell.
• Adds a --locale option to override the system locale for number formatting.

Bug Fixes

• The result counts in the Query History view now contain thousands separators (#437 - thank you, @code-master-ajay!).
• Harlequin no longer crashes when executing SQLite queries that return multiple types in a single column (#453).

Performance

• Harlequin now starts much faster, especially when restoring multiple buffers from the cache.

[1.13.0] - 2024-01-26

Features

• Adds a Query History Viewer: press F8 to view a list of up to 500 previously-executed queries (#259).

Bug Fixes

• The new --show-files and --show-s3 options are now correctly grouped under "Harlequin Options" in harlequin --help; installed adapters are now alphabetically sorted.

[1.12.0] - 2024-01-22

Features

• Adds an option, --show-files (alias -f), which will display the passed directory in the Data Catalog, alongside the connected database schema, in a second tab. Like database catalog items, you can use ctrl+enter, ctrl+j, or double-click to insert the path into the query editor.
• Adds an option, --show-s3 (alias --s3), which will display objects from the passed URI in the Data Catalog (in another tab). Uses the credentials from the AWS CLI's default profile. Use --show-s3 all to show all objects in all buckets for the currently-authenticated user, or pass buckets and key prefixes to restrict the catalog. For example, these all work:

  harlequin --show-s3 my-bucket
  harlequin --show-s3 my-bucket/my-nested/key-prefix
  harlequin --show-s3 s3://my-bucket
  harlequin --show-s3 https://my-storage.com/my-bucket/my-prefix
  harlequin --show-s3 https://my-bucket.s3.amazonaws.com/my-prefix
  harlequin --show-s3 https://my-bucket.storage.googleapis.com/my-prefix

• Items in the Data Catalog can now be copied to the clipboard with ctrl+c.

[1.11.0] - 2024-01-12

Features

• Harlequin now shows a more helpful error message when attempting to open a sqlite file with the duckdb adapter or vice versa (#401).
• ctrl+r forces a refresh of the Data Catalog (the catalog is automatically refreshed after DDL queries are executed in Harlequin) (#375).
• At startup, Harlequin attempts to load a cached version of the Data Catalog. The Data Catalog will be updated in the background. A loading indicator will be displayed if there is no cached catalog for the connection parameters (#397).

Bug Fixes

• The Data Catalog no longer shows the loading state after an error loading the catalog.
• Harlequin now exits if attempting to open an invalid file with the sqlite adapter.

[1.10.0] - 2024-01-11

Features

• Harlequin now loads immediately and connects to your database in the background (#393).
• Harlequin shows a loading indicator before the Data Catalog is hydrated for the first time (#396).

Bug Fixes

• Fixes a bug where harlequin --config would crash if configuring an adapter that declared no options.

[1.9.2] - 2024-01-10

Features

• The ODBC adapter is now installable as an extra; use pip install harlequin[odbc].

[1.9.1] - 2024-01-09

Bug Fixes

• Improves compatibility for adapter return types to accept a sequence of any iterable (tconbeer/textual-fastdatatable#68).

[1.9.0] - 2024-01-08

Features

• Improves keyboard navigation of the Results Viewer by adding key bindings, including ctrl+right/left/up/down/home/end, tab, and ctrl+a.
• The Trino adapter is now installable as an extra; use pip install harlequin[trino].
• Harlequin will automatically download a missing timezone database on Windows. Prevent this behavior with --no-download-tzdata.

Bug Fixes

• Fixes a crash when selecting data from a timestamptz field (#382) (or another field with an invalid Arrow data type).

[1.8.0] - 2023-12-21

Features

• Select a range of cells in the Results Viewer by clicking and dragging or by holding shift while moving the cursor with the keyboard.
• Copy selected cells from the Results Viewer by pressing ctrl+c.
• Very long values in the Results Viewer are now truncated, with an elipsis (…). The full value is shown in a tooltip when hovering over a truncated value. (The full value will also be copied to the clipboard).
• The BigQuery adapter is now installable as an extra; use pip install harlequin[bigquery].

Bug Fixes

• Fixes an issue on Windows where pressing shift or ctrl would hide the member autocomplete menu.
• Fixes flaky query execution behavior on some platforms.

Testing

• tests/functional_tests/test_app.py has been refactored into many smaller files.
• Fixes an issue with cache tests where the user's main harlequin cache was used instead of a mocked cache location.

[1.7.3] - 2023-12-15

Bug Fixes

• Fixes an issue where completions were truncated improperly in the autocomplete menu.

Testing

• Prevents limit input cursor blink when running tests in headless mode, for less flaky tests.

[1.7.2] - 2023-12-14

Features

• The MySQL adapter is now installable as an extra; use pip install harlequin[mysql].

[1.7.1] - 2023-12-14

Bug Fixes

• Fixes a crash when using harlequin-postgres and executing a select statement that returns zero records.

[1.7.0] - 2023-12-13

Features

• AUTOCOMPLETE! Harlequin's query editor will now offer completions in a drop-down for SQL keywords, functions, and database objects (like tables, views, columns). With the autocomplete list open, use up, down, PgUp, PgDn, to select an option and enter or Tab to insert it into the editor.
• Harlequin now uses a new TextArea widget for its code editor. This improves performance for long queries, adds line numbers in a gutter, and changes the underlying engine for syntax highlighting from Pygments to Tree Sitter (tconbeer/textual-textarea#123).
• In the Query Editor: double-click to select a word, triple-click to select a line, and quadruple-click to select the entire query (tconbeer/textual-textarea#111, tconbeer/textual-textarea#112).

Changes

• Changes the default theme to harlequin.

Adapter API Changes

• Many key types are now exported from the main harlequin package: HarlequinAdapter, HarlequinConnection, HarlequinCursor, HarlequinAdapterOption, HarlequinCopyFormat, HarlequinCompletion.
• HarlequinConnections may now (optionally) define a get_completions() method, which should return a list of HarlequinCompletion instances; each returned completion will be available to users in the autocompletion list.

Bug Fixes

• Fixes a bug that was causing an empty line to appear at the bottom of the Query Editor pane.

[1.6.0] - 2023-12-07

Features

• Harlequin can now be configured using a TOML file. The config file can both specify options for Harlequin (like the theme and row limit) and also for installed adapters (like the host, username, and password for a database connection). The config file can define multiple "profiles" (sets of configuration), and you can select the profile to use when starting Harlequin with the --profile option (alias -P). By default, Harlequin searches the current directory and home directories for files called either .harlequin.toml or pyproject.toml, and merges the config it finds in them. You can specify a different path using the --config-path option. Values loaded from config files can be overridden by passing CLI options (#206).
• Harlequin now ships with a wizard to make it easy to create or update config files. Simply run Harlequin with the --config option.
• Adds a harlequin theme. You can use it with harlequin -t harlequin.

[1.5.0] - 2023-11-28

Breaking Changes

• The SQLite adapter no longer provides a check-same-thread option; the established connection sets this value to False to enable Harlequin features.

Features

• The Postgres adapter is now installable as an extra; use pip install harlequin[postgres].

Bug Fixes

• Harlequin no longer become...