Skip to content

Commit c7ac8b8

Browse files
authored
Minor: Examples cleanup + more docs in pruning example (#11086)
* Fix ticks * Update comments
1 parent 3051d19 commit c7ac8b8

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

datafusion-examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ cargo run --example csv_sql
6262
- [`function_factory.rs`](examples/function_factory.rs): Register `CREATE FUNCTION` handler to implement SQL macros
6363
- [`make_date.rs`](examples/make_date.rs): Examples of using the make_date function
6464
- [`memtable.rs`](examples/memtable.rs): Create an query data in memory using SQL and `RecordBatch`es
65-
- ['parquet_index.rs'](examples/parquet_index.rs): Create an secondary index over several parquet files and use it to speed up queries
65+
- [`parquet_index.rs`](examples/parquet_index.rs): Create an secondary index over several parquet files and use it to speed up queries
6666
- [`parquet_sql.rs`](examples/parquet_sql.rs): Build and run a query plan from a SQL statement against a local Parquet file
6767
- [`parquet_sql_multiple_files.rs`](examples/parquet_sql_multiple_files.rs): Build and run a query plan from a SQL statement against multiple local Parquet files
68-
- ['parquet_exec_visitor.rs'](examples/parquet_exec_visitor.rs): Extract statistics by visiting an ExecutionPlan after execution
68+
- [`parquet_exec_visitor.rs`](examples/parquet_exec_visitor.rs): Extract statistics by visiting an ExecutionPlan after execution
6969
- [`parse_sql_expr.rs`](examples/parse_sql_expr.rs): Parse SQL text into Datafusion `Expr`.
7070
- [`plan_to_sql.rs`](examples/plan_to_sql.rs): Generate SQL from Datafusion `Expr` and `LogicalPlan`
7171
- [`pruning.rs`](examples/parquet_sql.rs): Use pruning to rule out files based on statistics

datafusion-examples/examples/pruning.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ use std::sync::Arc;
3333
/// quickly eliminate entire files / partitions / row groups of data from
3434
/// consideration using statistical information from a catalog or other
3535
/// metadata.
36+
///
37+
/// This example uses a user defined catalog to supply pruning information, as
38+
/// one might do as part of a higher level storage engine. See
39+
/// `parquet_index.rs` for an example that uses pruning in the context of an
40+
/// individual query.
3641
#[tokio::main]
3742
async fn main() {
3843
// In this example, we'll use the PruningPredicate to determine if

0 commit comments

Comments
 (0)