Skip to main content

A DBCLI client for Databricks SQL

Project description

Introduction

Databricks SQL CLI is a command line interface (CLI) for Databricks SQL that can do auto-completion and syntax highlighting, and is a proud member of the dbcli community.

Quick Start

Install via pip

You'll need Python 3.7 or newer.

python3 -m pip install databricks-sql-cli

You can now run dbsqlcli from your terminal.

Authentication

To connect with SQL Endpoints dbsqlcli needs the host name and http path from the connection details screen in Databricks SQL and a personal access token. You can provide these to dbsqlcli as command line arguments, by setting environment variables, or by writing them into the [credentials] section of the dbsqlclirc file (see below).

Config

A config file is automatically created at ~/.dbsqlcli/dbsqlclirc at first launch (run dbsqlcli). See the file itself for a description of all available options.

Run a query

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

Run a .sql file

$ dbsqlcli -e query.sql

Run a .sql file and save to CSV

$ dbsqlcli -e query.sql > output.csv

REPL

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

Run the help; command to see a list of shortcuts

Features

  • Auto-completes as you type for SQL keywords as well as tables and columns in the database.
  • Syntax highlighting.
  • Smart-completion will suggest context-sensitive completion.
    • SELECT * FROM <tab> will only show table names.
    • SELECT * FROM users WHERE <tab> will only show column names.
  • Pretty prints tabular data and various table formats.
  • Some special commands. e.g. Favorite queries.
  • Alias support. Column completions will work even when table names are aliased.

Usages

$ 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.

Contributions

We use Poetry for development. Follow the instructions to install Poetry on your system.

  1. Clone this repository
  2. poetry install will install its dependencies
  3. poetry shell will activate the local virtual environment
  4. python app.py will run dbsqlcli incorporating any of your local changes

Credits

Huge thanks to the maintainers of https://github.com/dbcli/athenacli upon which this project is built.

Similar projects

The DBCLI organization on Github maintains CLIs for numerous database platforms including MySQL, Postgres, and MSSQL.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

databricks-sql-cli-0.1.4.tar.gz (41.2 kB view hashes)

Uploaded source

Built Distribution

databricks_sql_cli-0.1.4-py3-none-any.whl (48.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page