From b7a362b247881ca89268a4671cd6a48601c30bf7 Mon Sep 17 00:00:00 2001 From: Nikolay Ulmasov Date: Thu, 14 Jul 2022 09:19:01 +0100 Subject: [PATCH] tidy up instructions --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 015baa7..559df45 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,24 @@ 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`). + ## Pre-requisites - [Delta Sharing](https://databricks.com/product/delta-sharing) set up with at least one shared table -- Rust installed, e.g. as described [here](https://doc.rust-lang.org/cargo/getting-started/installation.html) +- Rust is installed, e.g. as described [here](https://doc.rust-lang.org/cargo/getting-started/installation.html) ## Sample use -1. Create a Rust binary package, e.g. `cargo new delta_sharing_test --bin` +1. Create a new Rust binary package, e.g. `cargo new delta_sharing_test --bin` 2. Add the following dependencies to `Cargo.toml` ``` -delta_sharing = { git = "https://github.com/r3stl355/delta-sharing-rust-client" } +delta-sharing = { git = "https://github.com/r3stl355/delta-sharing-rust-client" } serde = { version = "1.0", features = ["derive"] } serde_json = "1.0" env_logger = "0.9" @@ -57,4 +62,9 @@ fn main() { ``` -5. Run, e.g. `cargo run --bin main` (alternatively, you can use `RUST_LOG=debug cargo run --bin main` if you want to see some extra debugging information) \ No newline at end of file +5. Run, e.g. `cargo run main` (alternatively, you can use `RUST_LOG=debug cargo run main` if you want to see some extra debugging information) + +## TODO + +- move to `async` mode (e.g. swap blocking `reqwest` Client to async version) +- write more tests \ No newline at end of file