Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theseus-rs/rsql
Command line interface for DuckDB, LibSQL, MariaDB, MySQL, PostgreSQL, Redshift, Snowflake, SQLite3 and SQL Server
https://github.com/theseus-rs/rsql
command-line data database duckdb mariadb mysql postgres postgresql redshift rust snowflake sql sqlite sqlite3 sqlserver
Last synced: 10 days ago
JSON representation
Command line interface for DuckDB, LibSQL, MariaDB, MySQL, PostgreSQL, Redshift, Snowflake, SQLite3 and SQL Server
- Host: GitHub
- URL: https://github.com/theseus-rs/rsql
- Owner: theseus-rs
- License: apache-2.0
- Created: 2024-03-11T00:16:55.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T18:32:27.000Z (12 days ago)
- Last Synced: 2024-10-29T20:37:46.406Z (12 days ago)
- Topics: command-line, data, database, duckdb, mariadb, mysql, postgres, postgresql, redshift, rust, snowflake, sql, sqlite, sqlite3, sqlserver
- Language: Rust
- Homepage: https://theseus-rs.github.io/rsql/rsql_cli/
- Size: 38.4 MB
- Stars: 123
- Watchers: 1
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Security: SECURITY.md
Awesome Lists containing this project
README
# rsql
[](https://github.com/theseus-rs/rsql/actions/workflows/ci.yml)
[](https://docs.rs/rsql_core)
[](https://codecov.io/gh/theseus-rs/rsql)
[](https://bencher.dev/perf/theseus-rs-rsql)
[](https://crates.io/crates/rsql_cli)
[](https://theseus-rs.github.io/rsql/rsql_cli/)
[](https://github.com/theseus-rs/rsql_cli#license)
[](https://semver.org/spec/v2.0.0.html)
`rsql` is a command line interface for databases. `rsql` is a modern, feature-rich, and user-friendly database client,
that has been designed to be easy to use, and to provide a consistent experience across all supported databases. The
project aims to provide reusable components for building other database clients.
## Getting Started
`rsql` can be installed using the following methods:
### Linux / MacOS
```shell
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/theseus-rs/rsql/releases/latest/download/rsql_cli-installer.sh | sh
```
### Windows
```shell
irm https://github.com/theseus-rs/rsql/releases/latest/download/rsql_cli-installer.ps1 | iex
```
For more information, and additional installations instructions (cargo, homebrew, msi),
visit the [rsql](https://theseus-rs.github.io/rsql/rsql_cli/) site.
## Features
| Feature | |
|-----------------------|-------------------------------------------------------------------------------------------------|
| Databases | DuckDB, LibSQL (Turso), MariaDB, MySQL, PostgreSQL, Redshift, Snowflake, SQLite3, SQL Server |
| Syntax Highlighting | ✅ |
| Result Highlighting | ✅ |
| Query Auto-completion | ✅ |
| History | ✅ |
| SQL File Execution | ✅ |
| Embedded PostgreSQL | ✅ |
| Output Formats | ascii, csv, expanded, html, json, jsonl, markdown, plain, psql, sqlite, tsv, unicode, xml, yaml |
| Localized Interface | 40+ languages¹ |
| Key Bindings | emacs, vi |
¹ Computer translations; human translations welcome
## Usage
### Interactive Mode
```shell
rsql --url ""
```
### Running a single Query
```shell
rsql --url "" -- ""
```
| Driver | URL |
|-------------------|---------------------------------------------------------------------------------------------------------------------------|
| duckdb | `duckdb://?[&file=]` |
| libsql¹ | `libsql://?[][&file=][&auth_token=]` |
| mariadb (sqlx) | `mariadb://[:]@[:]/` |
| mysql (sqlx) | `mysql://[:]@[:]/` |
| postgres | `postgres://[:]@[:]/?` |
| postgresql (sqlx) | `postgresql://[:]@[:]/?` |
| redshift (sqlx) | `redshift://]@[:]/` |
| rusqlite | `rusqlite://?[&file=]` |
| snowflake | `snowflake://[:]@.snowflakecomputing.com/[?private_key_file=pkey_file&public_key_file=pubkey_file]` |
| sqlite (sqlx) | `sqlite://?[&file=]` |
| sqlserver | `sqlserver://[:]@[:]/` |
¹ `libsql` needs to be enabled with the `libsql` feature flag; it is disabled by default as it conflicts
with `rusqlite`.
## Safety
These crates use `#![forbid(unsafe_code)]` to ensure everything is implemented in 100% safe Rust.
## License
Licensed under either of:
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.
