https://github.com/zen-xu/harlequin-risingwave
Harlequin adapter for Risingwave.
https://github.com/zen-xu/harlequin-risingwave
database python risingwave tui
Last synced: 8 months ago
JSON representation
Harlequin adapter for Risingwave.
- Host: GitHub
- URL: https://github.com/zen-xu/harlequin-risingwave
- Owner: zen-xu
- License: mit
- Created: 2024-04-11T03:49:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T03:50:31.000Z (over 1 year ago)
- Last Synced: 2025-01-02T13:52:07.423Z (over 1 year ago)
- Topics: database, python, risingwave, tui
- Language: Python
- Homepage:
- Size: 871 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# harlequin-risingwave
This repo provides the Harlequin adapter for [Risingwave](https://github.com/risingwavelabs/risingwave).
## Installation
`harlequin-risingwave` depends on `harlequin` and `harlequin-postgres`, so installing this package will also install these packages.
### Using pip
To install this adapter into an activated virtual environment:
```bash
pip install harlequin-risingwave
```
### Using poetry
```bash
poetry add harlequin-risingwave
```
### Using pipx
If you do not already have Harlequin installed:
```bash
pip install harlequin-risingwave
```
If you would like to add the Risingwave adapter to an existing Harlequin installation:
```bash
pipx inject harlequin harlequin-risingwave
```
## Usage and Configuration
You can open Harlequin with the Risingwave adapter by selecting it with the `-a` option and passing a [Posgres DSN](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING):
```bash
harlequin -a risingwave "postgres://my-user:my-pass@localhost:5432/my-database"
```
You can also pass all or parts of the connection string as separate options. The following is equivalent to the above DSN:
```bash
harlequin -a risingwave -h localhost -p 5432 -U my-user --password my-pass -d my-database
```
Many more options are available; to see the full list, run:
```bash
harlequin --help
```
For more information, see the [Harlequin Docs](https://harlequin.sh/docs/postgres/index).