sqluv — A simple terminal UI for querying RDBMS and…

Pitch

Description

Comments

About this project

sqluv delivers an intuitive text-based user interface for executing SQL queries across various DBMS and supporting CSV/TSV/LTSV files. With customizable color themes and a user-friendly design, it simplifies database interactions while maintaining safety against data modifications in production environments.

sqluv is a straightforward text-based user interface designed for interacting with various Relational Database Management Systems (RDBMS) as well as CSV, TSV, and LTSV files. The sqluv read CSV, TSV, and LTSV files from local storage, HTTPS, and Amazon S3. The sqluv automatically decompresses compressed files in .gz, .bz2, .xz, and .zst formats.With sqluv, executing SQL queries becomes a user-friendly experience, allowing seamless connections to databases or local files with ease.

Key Features

Multi-DBMS Support: Connect and interact with popular database systems like MySQL, PostgreSQL, SQLite3, and SQL Server.
File Compatibility: Read data from files in CSV, TSV, and LTSV formats from HTTPS, S3, and local storage.
Support Compressed File: Automatically decompresses compressed files in .gz, .bz2, .xz, and .zst.
Customizable Themes: sqluv supports multiple color themes, enabling customization of the interface based on user preference.

User Interface

The sqluv interface prioritizes ease of use. Upon launching without specifying a file path, users are prompted to enter connection details for their database. Configuration is saved, allowing for easy reconnections in the future. Below is a brief overview of the capabilities:

sqluv [FILE_PATHS]

By running this command with the relevant file paths, users can initiate interactions with local files.

SQL Query Management

All executed SQL queries are captured in a history log, stored at ~/.config/sqluv/history.db, making it simple to revisit and select previous commands.

Intuitive Key Bindings

Key	Description
ESC	Quit
Ctrl + d	Quit
Ctrl + c	Copy selected SQL query
Ctrl + v	Paste copied text
Ctrl + x	Cut selected text
Ctrl + t	Theme selection
TAB	Next field
Shift + TAB	Previous field

Color Themes

sqluv offers a variety of themes to enhance the user experience, including:

Default
Sublime
VS Code
Atom
Dark
Light
Solarized
Monokai
Nord
Cappuccino
Gruvbox
Tokyo Night
Dracula

Safety Precautions

While using sqluv, it's crucial to note that it is currently under development. Users are advised against executing UPDATE or DELETE commands in production environments. While sqluv cannot alter local files, it is capable of executing these commands in connected DBMSs.

Contributions and Feedback

Community contributions are welcome, whether in the form of code contributions or simply by offering a GitHub star to show support. For issues and feature requests, the developer can be contacted through GitHub Issues.

For those looking to enhance their database management experience with a user-friendly interface, sqluv offers a solid choice for connecting to and managing database solutions.