简介

Databricks SQL CLI是一个针对Databricks SQL的命令行界面（CLI），可以进行自动完成和语法高亮，并且是dbcli社区的一名自豪成员。

快速入门

通过pip安装

您需要Python 3.7或更高版本。

python3 -m pip install databricks-sql-cli

您现在可以从终端运行dbsqlcli。

身份验证

为了与SQL端点连接，dbsqlcli需要从Databricks SQL中的连接详情界面获取主机名和http路径，以及一个个人访问令牌。您可以通过命令行参数、设置环境变量或将它们写入dbsqlclirc文件的[credentials]部分（见下文）来提供这些信息。

配置

首次启动时（运行dbsqlcli），将在~/.dbsqlcli/dbsqlclirc自动创建一个配置文件。请参阅文件本身以了解所有可用选项的描述。

运行查询

$ dbsqlcli -e 'select id, name from minifigs LIMIT 10'

运行.sql文件

$ dbsqlcli -e query.sql

运行.sql文件并保存到CSV

$ dbsqlcli -e query.sql > output.csv

REPL

$ cd <directory containing dbsqlcli binary>
$ ./dbslqcli [<database_name>]

运行help;命令以查看快捷方式列表

功能

• 在键入时自动完成SQL关键字以及数据库中的表和列。
• 语法高亮。
• 智能完成将建议上下文相关的完成。
  • SELECT * FROM <tab>将只显示表名。
  • SELECT * FROM users WHERE <tab>将只显示列名。
• 以美观的方式打印表格数据和各种表格格式。
• 一些特殊命令。例如：收藏的查询。
• 别名支持。即使表名使用别名，列补全也能正常工作。

用法

$ dbsqlcli --help
Usage: dbsqlcli [OPTIONS] [DATABASE]

  A DBSQL terminal querying client with auto-completion and syntax
  highlighting.

  Examples:
    - dbsqlcli
    - dbsqlcli my_database

Options:
  -e, --execute TEXT   Execute a command (or a file) and quit.
  --hostname TEXT      Hostname  [env var: DBSQLCLI_HOST_NAME]
  --http-path TEXT     HTTP Path  [env var: DBSQLCLI_HTTP_PATH]
  --access-token TEXT  Access Token  [env var: DBSQLCLI_ACCESS_TOKEN]
  --clirc FILE         Location of clirc file.
  --table-format TEXT  Table format used with -e option.
  --help               Show this message and exit.

贡献

我们使用Poetry进行开发。按照说明在您的系统上安装Poetry。

1. 克隆此仓库
2. poetry install将安装其依赖项
3. poetry shell将激活本地虚拟环境
4. python app.py将运行dbsqlcli并包含您所做的任何本地更改

鸣谢

非常感谢https://github.com/dbcli/athenacli的维护者，本项目基于此项目构建。

类似项目

GitHub上的DBCLI组织维护了MySQL、Postgres和MSSQL等众多数据库平台的CLIs。

• https://github.com/dbcli/mycli
• https://github.com/dbcli/pgcli
• https://github.com/dbcli/mssql-cli