Skip to content

Commit

Permalink
docs(flink): add to the set of documented backends
Browse files Browse the repository at this point in the history
  • Loading branch information
deepyaman authored and gforsyth committed Dec 19, 2023
1 parent 37abea9 commit 83eab61
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 3 deletions.
64 changes: 64 additions & 0 deletions docs/backends/flink.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Flink

[https://nightlies.apache.org/flink/flink-docs-stable/](https://nightlies.apache.org/flink/flink-docs-stable/)

![](https://img.shields.io/badge/memtables-native-green?style=flat-square) ![](https://img.shields.io/badge/inputs-Flink tables-blue?style=flat-square) ![](https://img.shields.io/badge/outputs-Flink tables | pandas-orange?style=flat-square)

## Install

Install Ibis and dependencies for the Flink backend:

::: {.panel-tabset}

## `pip`

Install alongside the `apache-flink` package:

```{.bash}
pip install ibis-framework apache-flink
```

And connect:

```{.python}
import ibis
con = ibis.flink.connect() # <1>
```

1. Adjust connection parameters as needed.

:::

## Connect

### `ibis.flink.connect`

```python
con = ibis.flink.connect(table_env=table_env)
```

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

::: {.callout-note}
The `flink` backend does not create `TableEnvironment` objects; you must create a `TableEnvironment` and pass that to `ibis.flink.connect`.
:::

### Connection Parameters

```{python}
#| echo: false
#| output: asis
from _utils import render_do_connect
render_do_connect("flink")
```

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

{{< include ./_templates/api.qmd >}}
4 changes: 1 addition & 3 deletions docs/backends/pyspark.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,6 @@ con = ibis.pyspark.connect() # <1>

:::



## Connect

### `ibis.pyspark.connect`
Expand All @@ -81,7 +79,7 @@ con = ibis.pyspark.connect(session=session)
:::

::: {.callout-note}
The `pyspark` backend does not create `SparkSession` objects, you must create a `SparkSession` and pass that to `ibis.pyspark.connect`.
The `pyspark` backend does not create `SparkSession` objects; you must create a `SparkSession` and pass that to `ibis.pyspark.connect`.
:::

### Connection Parameters
Expand Down

0 comments on commit 83eab61

Please sign in to comment.