-
Notifications
You must be signed in to change notification settings - Fork 598
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(risingwave): add backend docs page for RisingWave
- Loading branch information
Showing
1 changed file
with
103 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
# 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 | ||
|
||
```{python} | ||
#| echo: false | ||
#| output: asis | ||
from _utils import render_do_connect | ||
render_do_connect("risingwave") | ||
``` | ||
|
||
```{python} | ||
#| echo: false | ||
BACKEND = "Risingwave" | ||
``` | ||
|
||
{{< include ./_templates/api.qmd >}} |