Skip to content

Commit

Permalink
Update documentation example for change in API (#1812)
Browse files Browse the repository at this point in the history
* Update documentation example for change in API

* Update docs/source/user-guide/example-usage.md

* Update docs/source/user-guide/example-usage.md

Co-authored-by: xudong.w <wxd963996380@gmail.com>

Co-authored-by: xudong.w <wxd963996380@gmail.com>
  • Loading branch information
alamb and xudong963 authored Feb 16, 2022
1 parent 0a1eee0 commit 2a5a431
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions docs/source/user-guide/example-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,16 @@

# Example Usage

Run a SQL query against data stored in a CSV:
## Update `Cargo.toml`

Add the following to your `Cargo.toml` file:

```toml
datafusion = "7.0.0"
tokio = "1.0"
```

## Run a SQL query against data stored in a CSV:

```rust
use datafusion::prelude::*;
Expand All @@ -28,18 +37,18 @@ use datafusion::prelude::*;
async fn main() -> datafusion::error::Result<()> {
// register the table
let mut ctx = ExecutionContext::new();
ctx.register_csv("example", "tests/example.csv", CsvReadOptions::new())?;
ctx.register_csv("example", "tests/example.csv", CsvReadOptions::new()).await?;

// create a plan to run a SQL query
let df = ctx.sql("SELECT a, MIN(b) FROM example GROUP BY a LIMIT 100")?;
let df = ctx.sql("SELECT a, MIN(b) FROM example GROUP BY a LIMIT 100").await?;

// execute and print results
df.show().await?;
Ok(())
}
```

Use the DataFrame API to process data stored in a CSV:
## Use the DataFrame API to process data stored in a CSV:

```rust
use datafusion::prelude::*;
Expand All @@ -48,7 +57,7 @@ use datafusion::prelude::*;
async fn main() -> datafusion::error::Result<()> {
// create the dataframe
let mut ctx = ExecutionContext::new();
let df = ctx.read_csv("tests/example.csv", CsvReadOptions::new())?;
let df = ctx.read_csv("tests/example.csv", CsvReadOptions::new()).await?;

let df = df.filter(col("a").lt_eq(col("b")))?
.aggregate(vec![col("a")], vec![min(col("b"))])?;
Expand All @@ -59,7 +68,7 @@ async fn main() -> datafusion::error::Result<()> {
}
```

Both of these examples will produce
## Output from both examples

```text
+---+--------+
Expand Down

0 comments on commit 2a5a431

Please sign in to comment.