Metadata-Version: 2.4
Name: harlequin-risingwave
Version: 0.6.0
Summary: A Harlequin adapter for Risingwave.
Author-email: "ZhengYu, Xu" <zen-xu@outlook.com>
License: MIT
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: harlequin-postgres>=1.3
Requires-Dist: harlequin>=2.5
Requires-Dist: psycopg-pool>=3.1
Requires-Dist: psycopg[binary]>=3.1
Description-Content-Type: text/markdown

# harlequin-risingwave

This repo provides the Harlequin adapter for [Risingwave](https://github.com/risingwavelabs/risingwave).

![](https://github.com/zen-xu/harlequin-risingwave/blob/main/assets/demo.jpg?raw=true)

## 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 uv

```bash
uv add harlequin-risingwave
```

Or run directly without installing:

```bash
uvx --with harlequin-risingwave harlequin -a 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).
