From ad349b06adb761123b60078b6a34a3e0da67abc3 Mon Sep 17 00:00:00 2001 From: Nikolay Ulmasov Date: Wed, 28 Dec 2022 11:37:09 +0000 Subject: [PATCH] update readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4ee5db1..fbb4abc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +![experimental](https://github.com/GIScience/badges/raw/master/status/experimental.svg) [![main](https://github.com/r3stl355/delta-sharing-rust-client/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/r3stl355/delta-sharing-rust-client/actions/workflows/main.yml) # Delta Sharing client library for Rust @@ -7,18 +8,18 @@ This is a simple library for Rust to access data published via Delta Sharing ## Features - Retrieve Delta Sharing information (shares, schemas, tables and files) -- Query shared table data using [Polars](https://pola-rs.github.io/polars/polars/index.html). `get_dataframe` downloads the table's parquet files (and caches then locally for subsequent queries) and returns a lazy abstraction (logical plan) over an eager DataFrame. This lazy abstraction provides methods for incrementally modifying that logical plan until output is requested (via `collect`). +- Query shared table data using [Polars](https://pola-rs.github.io/polars/polars/index.html). `get_dataframe` downloads the table's parquet files (and caches then locally for subsequent reads) and returns a lazy abstraction (logical plan) over an eager DataFrame. This lazy abstraction provides methods for incrementally modifying that logical plan until the final output is requested (via `collect`). ## Pre-requisites - [Delta Sharing](https://databricks.com/product/delta-sharing) set up with at least one shared table - Rust is installed, e.g. as described [here](https://doc.rust-lang.org/cargo/getting-started/installation.html) -## Sample use +## Quick start Use this [sample project](https://github.com/r3stl355/delta-sharing-rust-cllient-use-example) for a quick start -## TODO +## TODO (Work in progress) -- move to `async` mode (e.g. swap blocking `reqwest` Client to async version) +- implement `async` mode (e.g. swap blocking `reqwest` client to async version) - - write more tests \ No newline at end of file