From 124f085a649815871bcb3782f3cc6c3e777af7fe Mon Sep 17 00:00:00 2001 From: Phillip Cloud <417981+cpcloud@users.noreply.github.com> Date: Mon, 21 Aug 2023 12:39:27 -0400 Subject: [PATCH] docs(backends): add support more supported IO types --- docs/backends/clickhouse.md | 14 ++++++++++++++ docs/backends/polars.md | 6 +++++- docs/backends/pyspark.md | 6 +++++- docs/backends/snowflake.md | 19 ++++++++++++++++++- 4 files changed, 42 insertions(+), 3 deletions(-) diff --git a/docs/backends/clickhouse.md b/docs/backends/clickhouse.md index e494240f4d6e..e124990d6f0b 100644 --- a/docs/backends/clickhouse.md +++ b/docs/backends/clickhouse.md @@ -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 --- @@ -83,3 +84,16 @@ or ```python con = ibis.connect("clickhouse://play:clickhouse@play.clickhouse.com:443?secure=True") ``` + +## File Support + + +::: 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 + diff --git a/docs/backends/polars.md b/docs/backends/polars.md index 2f917ce3c007..62ab8fa6865d 100644 --- a/docs/backends/polars.md +++ b/docs/backends/polars.md @@ -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 --- @@ -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 diff --git a/docs/backends/pyspark.md b/docs/backends/pyspark.md index 9417c5313df1..fefc1dd20b87 100644 --- a/docs/backends/pyspark.md +++ b/docs/backends/pyspark.md @@ -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 --- @@ -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 diff --git a/docs/backends/snowflake.md b/docs/backends/snowflake.md index b9dee0f27ff7..bd65dd012d07 100644 --- a/docs/backends/snowflake.md +++ b/docs/backends/snowflake.md @@ -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 --- @@ -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 + + +::: 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 +