Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation example for change in API #1812

Merged
merged 3 commits into from
Feb 16, 2022
Merged

Update documentation example for change in API #1812

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
197303e
Update documentation example for change in API
alamb Feb 12, 2022
71ed91a
Update docs/source/user-guide/example-usage.md
alamb Feb 15, 2022
4a89732
Update docs/source/user-guide/example-usage.md
alamb Feb 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions docs/source/user-guide/example-usage.md
View file
Open in desktop
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:

```yaml
alamb marked this conversation as resolved.
Show resolved Hide resolved
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?;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing! unexpectedly, no .await before.


// 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