Skip to main content

harlequin-mysql

This repo provides the Harlequin adapter for MySQL/MariaDB.

Installation

You must install the harlequin-mysql package into the same environment as harlequin. The best and easiest way to do this is to use uv to install Harlequin with the mysql extra:

uv tool install 'harlequin[mysql]'

Usage and Configuration

You can open Harlequin with the MySQL/MariaDB adapter by selecting it with the -a option and passing connection parameters as CLI options:

harlequin -a mysql -h localhost -p 3306 -U root --password example --database dev

Note: use -a mysql for both MySQL and MariaDB servers.

The MySQL/MariaDB adapter does not accept a connection string or DSN.

Read-only mode

This adapter supports Harlequin's --read-only option:

harlequin --read-only -a mysql -h localhost -U root --password example --database dev

Every connection runs set session transaction read only, so the server refuses DML and DDL with error 1792 (tested on MySQL 8.0 and MariaDB 10.11). Statements that do not touch data, like set global ..., are still allowed; for a stronger guarantee, connect with a read-only account.

This adapter supports Harlequin's --catalog-search option:

hsql --catalog-search customer_id -a mysql -h localhost -U root --password example

The term matches any part of a database, table, view, or column name, case-insensitively; one query searches every database.

Many more options are available; to see the full list, run:

harlequin --help

For more information, see the Harlequin Docs.

Metadata

Release files for harlequin-mysql 1.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for harlequin-mysql 1.5.0
File Size Uploaded Provenance Actions
harlequin_mysql-1.5.0.tar.gz 26.6 kB With provenance Details for harlequin_mysql-1.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for harlequin-mysql 1.5.0
File Interpreter ABI Platform Actions
harlequin_mysql-1.5.0-py3-none-any.whl Python 3 none any Details for harlequin_mysql-1.5.0-py3-none-any.whl

Total release size: 52.8 kB

Release files / harlequin_mysql-1.5.0.tar.gz

Download URL harlequin_mysql-1.5.0.tar.gz
Size 26.6 kB
Tags Source
SHA-256 checksum
How to use checksums
84ab123f74ac1e9fcfcda486b842401f0ee9e42acde3dd1d6d4da7c0f844211c
BLAKE2b-256 checksum
How to use checksums
f234e0b31d86cc318c2df15e01d7420681b3f4f1fe49ec8a3c6215ca113e1bef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.

Transparency log

Release files / harlequin_mysql-1.5.0-py3-none-any.whl

Download URL harlequin_mysql-1.5.0-py3-none-any.whl
Size 26.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
333258b81c7e4640fb118c30706b3ad7fee2a7c6a9c1fa1c1b79ca692e764268
BLAKE2b-256 checksum
How to use checksums
61fffd54f2f31cbe2aef7df7af9b148ccc080b4760257a7d34f94627c96d4828
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.

Transparency log

Security for harlequin-mysql 1.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for harlequin_mysql-1.5.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page