This is an automated email from the ASF dual-hosted git repository.
kszucs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 30ab761 ARROW-4926: [Rust] [DataFusion] Update README for 0.13.0
30ab761 is described below
commit 30ab7618f0587c6c6b69ab6cd15335f9eb009950
Author: Andy Grove <[email protected]>
AuthorDate: Mon Mar 18 15:52:17 2019 +0100
ARROW-4926: [Rust] [DataFusion] Update README for 0.13.0
Author: Andy Grove <[email protected]>
Author: Krisztián Szűcs <[email protected]>
Closes #3962 from andygrove/ARROW-4926 and squashes the following commits:
114b1f00 <Krisztián Szűcs> correct path in release script
1cb20d93 <Andy Grove> update README again
b3e0a6c5 <Andy Grove> Update release script to increment version number in
DataFusion README
19193f33 <Andy Grove> Update DataFusion README for 0.13.0
---
dev/release/00-prepare.sh | 10 ++++++++++
rust/datafusion/README.md | 42 ++++++++++++++++++++++++++++++++++++++++--
2 files changed, 50 insertions(+), 2 deletions(-)
diff --git a/dev/release/00-prepare.sh b/dev/release/00-prepare.sh
index 9e0a89b..5f7c098 100755
--- a/dev/release/00-prepare.sh
+++ b/dev/release/00-prepare.sh
@@ -121,6 +121,16 @@ update_versions() {
parquet/README.md
rm -f parquet/README.md.bak
git add parquet/README.md
+
+ # Update version number for datafusion README
+ sed -i.bak -E -e \
+ "s/^datafusion = \".+\"/datafusion = \"${version}\"/g" \
+ datafusion/README.md
+ sed -i.bak -E -e \
+
"s/docs.rs\/crate\/datafusion\/.+\)/docs.rs\/crate\/datafusion\/${version}\)/g"
\
+ datafusion/README.md
+ rm -f datafusion/README.md.bak
+ git add datafusion/README.md
cd -
}
diff --git a/rust/datafusion/README.md b/rust/datafusion/README.md
index e837483..23aa45c 100644
--- a/rust/datafusion/README.md
+++ b/rust/datafusion/README.md
@@ -19,11 +19,49 @@
# DataFusion
-DataFusion is an in-memory query engine that uses Apache Arrow as the memory
model
+DataFusion is an in-memory query engine that uses Apache Arrow as the memory
model. It supports executing SQL queries against CSV and Parquet files as well
as querying directly against in-memory data.
+
+## Usage
+
+Add this to your Cargo.toml:
+
+```toml
+[dependencies]
+datafusion = "0.12"
+```
# Status
-The current code supports single-threaded execution of limited SQL queries
(projection, selection, and aggregates) against CSV files. Parquet files will
be supported shortly.
+## General
+
+[x] SQL Parser
+[x] SQL Query Planner
+[x] Query Optimizer
+[x] Projection push down
+[ ] Predicate push down
+[x] Type coercion
+[ ] Parallel query execution
+
+## SQL Support
+
+[x] Projection
+[x] Selection
+[x] Aggregate
+[ ] Sorting
+[x] Limit
+[ ] Nested types and dot notation
+[ ] Lists
+[ ] UDFs
+[ ] Subqueries
+[ ] Joins
+
+## Data Sources
+
+[x] CSV
+[x] Parquet primitive types
+[ ] Parquet nested types
+
+# Example
Here is a brief example for running a SQL query against a CSV file. See the
[examples](examples) directory for full examples.
