/sqlterm

🖥️ A modern command-line client for SQL

Primary LanguagePython

A modern command-line client for SQL

An example SQLTerm session

Installation

The latest release version of SQLTerm may be installed from PyPI using pip:

pip install sqlterm

Alternatively, the latest commit may be installed from this repo if preferred:

git clone https://github.com/will-hinson/sqlterm.git
cd sqlterm
pip install .

Getting Started

If you installed SQLTerm using pip, it should already be in your shell's path:

sqlterm

# alternatively, run as a module using python
python -m sqlterm

Supported Dialects

The following SQL dialect and driver combinations are fully supported by SQLTerm for queries and autocompletion:

Dialect Driver Connection Schema
Microsoft SQL Server pyodbc mssql+pyodbc://
PostgreSQL psycopg2 postgresql+psycopg2://
MySQL mysqlconnector mysql+mysqlconnector://
SQLite sqlite sqlite://
Oracle SQL oracledb oracle+oracledb://

SQLTerm is integrated with SQLAlchemy and any of its supported dialects should be supported in theory. However, queries will be limited to a single result set and autocompletion support will be limited to objects in the INFORMATION_SCHEMA.