[arrow-datafusion] branch master updated: Examples section in datafusion crate. Instructions how to run them (#457)

[al...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git


The following commit(s) were added to refs/heads/master by this push:
     new 13c907c  Examples section in datafusion crate. Instructions how to run them (#457)
13c907c is described below

commit 13c907cab8eb0fa7a9a121d9699a4805d5248adc
Author: Michael Lu <mi...@gmail.com>
AuthorDate: Tue Jun 1 21:52:54 2021 +0300

    Examples section in datafusion crate. Instructions how to run them (#457)
---
 datafusion/src/lib.rs | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/datafusion/src/lib.rs b/datafusion/src/lib.rs
index b6f64fe..5b8c9c1 100644
--- a/datafusion/src/lib.rs
+++ b/datafusion/src/lib.rs
@@ -182,6 +182,35 @@
 //! * declare and use user-defined aggregate functions ([`AggregateUDF`](physical_plan::udaf::AggregateUDF))
 //!
 //! you can find examples of each of them in examples section.
+//!
+//! ## Examples
+//!
+//! Examples are located in [datafusion-examples directory](https://github.com/apache/arrow-datafusion/tree/master/datafusion-examples)
+//!
+//! Here's how to run them
+//!
+//! ```bash
+//! git clone https://github.com/apache/arrow-datafusion
+//! cd arrow-datafusion
+//! # Download test data
+//! git submodule update --init
+//! export PARQUET_TEST_DATA=parquet-testing/data
+//! export ARROW_TEST_DATA=testing/data
+//!
+//! cargo run --example csv_sql
+//!
+//! cargo run --example parquet_sql
+//!
+//! cargo run --example dataframe
+//!
+//! cargo run --example dataframe_in_memory
+//!
+//! cargo run --example parquet_sql
+//!
+//! cargo run --example simple_udaf
+//!
+//! cargo run --example simple_udf
+//! ```
 
 extern crate sqlparser;