Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(risingwave): add backend docs page for RisingWave #8286

Merged
merged 1 commit into from
Feb 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions docs/backends/risingwave.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# RisingWave

[https://risingwave.com/](https://risingwave.com/)

![](https://img.shields.io/badge/memtables-fallback-yellow?style=flat-square) ![](https://img.shields.io/badge/inputs-Postgres tables-blue?style=flat-square) ![](https://img.shields.io/badge/outputs-Postgres tables | CSV | pandas | Parquet | PyArrow-orange?style=flat-square)

## Install

Install Ibis and dependencies for the RisingWave backend:

::: {.panel-tabset}

## `pip`

Install with the `risingwave` extra:

```{.bash}
pip install 'ibis-framework[risingwave]'
```

And connect:

```{.python}
import ibis

con = ibis.risingwave.connect() # <1>
```

1. Adjust connection parameters as needed.

## `conda`

Install for Risingwave:

```{.bash}
conda install -c conda-forge ibis-risingwave
```

And connect:

```{.python}
import ibis

con = ibis.risingwave.connect() # <1>
```

1. Adjust connection parameters as needed.

## `mamba`

Install for Risingwave:

```{.bash}
mamba install -c conda-forge ibis-risingwave
```

And connect:

```{.python}
import ibis

con = ibis.risingwave.connect() # <1>
```

1. Adjust connection parameters as needed.

:::

## Connect

### `ibis.risingwave.connect`

```python
con = ibis.risingwave.connect(
user="username",
password="password",
host="hostname",
port=4566,
database="database",
)
```

::: {.callout-note}
`ibis.risingwave.connect` is a thin wrapper around
[`ibis.backends.risingwave.Backend.do_connect`](#ibis.backends.risingwave.Backend.do_connect).
:::


### Connection Parameters
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be "Connection parameters" per style guide (but seeing it's this for all the other backends, so maybe keep + fix this in a future PR)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, can handle that in a followup


```{python}
#| echo: false
#| output: asis
from _utils import render_do_connect

render_do_connect("risingwave")
```

```{python}
#| echo: false
BACKEND = "Risingwave"
```

{{< include ./_templates/api.qmd >}}
Loading