Harlequin
你的终端中的 SQL IDE。
[!TIP] 本 README 包含 harlequin.sh 上可用文档的一个小子集。
安装 Harlequin
Harlequin 是一个 Python 程序，有许多安装和运行它的方式。我们强烈建议使用 uv：
-
安装 uv。在 POSIX shell 中，运行：
curl -LsSf https://astral.sh/uv/install.sh | sh
或者使用 Windows Powershell：
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"-
使用
uv将 Harlequin 安装为工具：uv tool install harlequin
此命令会将 Harlequin 安装到一个隔离的环境中，并将其添加到你的 PATH 中，以便你可以轻松运行可执行文件。
其他安装方法
或者，如果你知道自己在做什么，在安装 Python 3.9 或更高版本后，使用 pip、pipx、poetry 或任何其他可以从 PyPI 安装 Python 包的程序来安装 Harlequin：
pip install harlequin此外，还有一个 Harlequin 的 Homebrew 公式，尽管该公式由社区维护，且不如 Python 安装方式经过严格测试。请注意，该公式包含多个 Harlequin 适配器包（Postgres、MySQL/MariaDB 和 ODBC）及其依赖项，这虽然方便，但会增加应用程序的大小。
brew install harlequin安装数据库适配器
Harlequin 可以使用适配器插件连接到数十种数据库。适配器以独立的 Python 包形式分发，需要安装到与 Harlequin 相同的环境中。
有关由 Harlequin 维护者或更广泛的社区提供的已知适配器列表，请参阅 adapters 页面。
适配器文档还包含安装说明。某些适配器可以作为 Harlequin 的附加组件安装，例如 postgres。如果你使用 uv 安装了 Harlequin：
uv tool install 'harlequin[postgres]'您可以安装多个 extras：
uv tool install 'harlequin[postgres,mysql,s3]'运行 Harlequin
安装 Harlequin 后，您从命令行运行它。您在命令行中传入的参数和选项会影响 Harlequin 的行为，例如它使用的数据库适配器、连接的数据库、文件选择器是否可见等。假设您已安装 Harlequin 并将其置于 PATH（uv tool install harlequin 会自动完成此操作），您通过在 shell 中输入以下形式的命令来运行 Harlequin：
harlequin [OPTIONS] [CONN_STR]其中 [OPTIONS] 是 0 个或多个形式为 --[option-name] [option-value] 的配对，而 [CONN_STR] 是 0 个或多个连接字符串。[OPTIONS] 由 Harlequin 选项和适配器选项组成。要查看完整的选项列表，请使用 --help 选项运行 Harlequin：
harlequin --help使用 Harlequin 配合 DuckDB
Harlequin 默认使用其 DuckDB 数据库适配器，该适配器随 Harlequin 一起提供，并包含完整的 DuckDB 进程内数据库。
要打开一个内存中的 DuckDB 会话，请不带任何参数运行 Harlequin：
harlequin要打开一个或多个 DuckDB 数据库文件，请将相对路径或绝对路径作为连接字符串传入（如果 DuckDB 数据库不存在，Harlequin 将会创建它们）：
harlequin "path/to/duck.db" "another_duck.db"如果你想控制 Harlequin 使用的 DuckDB 版本，请参阅 Troubleshooting 页面。
使用 Harlequin 配合 SQLite 及其他适配器
Harlequin 还附带了一个 SQLite3 适配器。要使用该适配器，请指定 --adapter sqlite 选项。与 DuckDB 类似，你可以通过省略连接字符串来打开一个内存中的 SQLite 数据库：
harlequin --adapter sqlite您可以通过将路径作为连接字符串传入来打开一个或多个 SQLite 数据库文件；请注意，--adapter 选项有一个简短别名，即 -a：
harlequin -a sqlite "path/to/sqlite.db" "another_sqlite.db"其他适配器可以作为插件安装；有关更多信息，请参阅安装指南，以及各个适配器的指南。每个适配器都可以定义自己的选项，您可以使用 harlequin --help 查看。
配置 Harlequin
Harlequin 包含大量选项，允许您设置主题、自定义按键绑定、显示远程和本地文件、设置数字格式化的区域设置，等等。这些选项始终可以在命令行中输入，但将其定义为配置文件可能更方便。有关配置 Harlequin 的更多信息，请参阅使用配置文件。
在 Django 中使用 Harlequin
django-harlequin 提供了一个命令，用于使用 Django 的数据库配置启动 Harlequin，例如：
./manage.py harlequin继续阅读 harlequin.sh
访问 harlequin.sh 查看功能概览和完整文档，从如何编辑和执行查询、使用数据目录、导出数据等的引导式教程开始。
获取帮助
要查看 Harlequin 的所有命令行选项以及所有已安装的适配器，安装后，只需输入：
harlequin --help要在应用内查看这些文档的子集（以及返回此处的链接），请按
请参阅 故障排除 指南，以获取关于按键绑定、外观问题、复制粘贴等方面的帮助。
GitHub 讨论区 是提问、请求功能以及打招呼的好地方。
GitHub 问题 是报告 bug 的最佳场所。
赞助 Harlequin
请考虑 赞助 Harlequin 的作者，以便他能继续投入时间到 Harlequin。
贡献
感谢您对 Harlequin 的兴趣！Harlequin 主要由 Ted Conbeer 维护，但他欢迎所有贡献！
请参阅 CONTRIBUTING.md 以获取更多信息。