Skip to content

Commit

Permalink
docs(backends): add support more supported IO types
Browse files Browse the repository at this point in the history
  • Loading branch information
cpcloud committed Aug 21, 2023
1 parent d487e10 commit 124f085
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 3 deletions.
14 changes: 14 additions & 0 deletions docs/backends/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ backend_name: ClickHouse
backend_url: https://clickhouse.yandex/
backend_module: clickhouse
exports: ["PyArrow", "Parquet", "CSV", "Pandas"]
imports: ["CSV", "Parquet"]
memtable_impl: native
---

Expand Down Expand Up @@ -83,3 +84,16 @@ or
```python
con = ibis.connect("clickhouse://play:[email protected]:443?secure=True")
```

## File Support

<!-- prettier-ignore-start -->
::: ibis.backends.clickhouse.Backend.read_csv
options:
heading_level: 4
show_docstring_returns: false
::: ibis.backends.clickhouse.Backend.read_parquet
options:
heading_level: 4
show_docstring_returns: false
<!-- prettier-ignore-end -->
6 changes: 5 additions & 1 deletion docs/backends/polars.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ backend_module: polars
is_experimental: true
version_added: "4.0"
exports: ["PyArrow", "Parquet", "Delta Lake", "CSV", "Pandas"]
imports: ["CSV", "Parquet", "Delta Lake", "Pandas"]
imports: ["CSV", "Parquet", "Delta Lake", "Pandas", "JSON"]
memtable_impl: native
---

Expand Down Expand Up @@ -73,4 +73,8 @@ con = ibis.polars.connect()
options:
heading_level: 4
show_docstring_returns: false
::: ibis.backends.polars.Backend.read_json
options:
heading_level: 4
show_docstring_returns: false
<!-- prettier-ignore-end -->
6 changes: 5 additions & 1 deletion docs/backends/pyspark.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ backend_url: https://spark.apache.org/docs/latest/api/python/
backend_module: pyspark
backend_param_style: PySpark things
exports: ["PyArrow", "Parquet", "Delta Lake", "Pandas"]
imports: ["CSV", "Parquet", "Delta Lake"]
imports: ["CSV", "Parquet", "Delta Lake", "JSON"]
memtable_impl: native
---

Expand Down Expand Up @@ -68,4 +68,8 @@ con = ibis.pyspark.connect(session=session)
options:
heading_level: 4
show_docstring_returns: false
::: ibis.backends.pyspark.Backend.read_json
options:
heading_level: 4
show_docstring_returns: false
<!-- prettier-ignore-end -->
19 changes: 18 additions & 1 deletion docs/backends/snowflake.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
backend_name: Snowflake
backend_url: https://snowflake.com/
imports: ["CSV"]
imports: ["CSV", "Parquet", "JSON"]
exports: ["PyArrow", "Parquet", "CSV", "Pandas"]
memtable_impl: native
---
Expand Down Expand Up @@ -123,3 +123,20 @@ available databases and schema in the "Data" sidebar item in the Snowflake web
app.

![Snowflake Database](./images/snowflake_database.png)

## File Support

<!-- prettier-ignore-start -->
::: ibis.backends.snowflake.Backend.read_csv
options:
heading_level: 4
show_docstring_returns: false
::: ibis.backends.snowflake.Backend.read_parquet
options:
heading_level: 4
show_docstring_returns: false
::: ibis.backends.snowflake.Backend.read_json
options:
heading_level: 4
show_docstring_returns: false
<!-- prettier-ignore-end -->

0 comments on commit 124f085

Please sign in to comment.