Skip to content

Commit

Permalink
Update datafusion-cli docs, split up (apache#10078)
Browse files Browse the repository at this point in the history
* Update datafusion-cli docs, split up

* remove PiPI instructions
  • Loading branch information
alamb authored Apr 16, 2024
1 parent 8730466 commit 0573f78
Show file tree
Hide file tree
Showing 8 changed files with 777 additions and 665 deletions.
8 changes: 4 additions & 4 deletions datafusion-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@

[DataFusion](https://arrow.apache.org/datafusion/) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.

The DataFusion CLI is a command line utility that runs SQL queries using the DataFusion engine.
DataFusion CLI (`datafusion-cli`) is a small command line utility that runs SQL queries using the DataFusion engine.

# Frequently Asked Questions

## Where can I find more information?

Answer: See the [`datafusion-cli` documentation](https://arrow.apache.org/datafusion/user-guide/cli.html) for further information.
See the [`datafusion-cli` documentation](https://arrow.apache.org/datafusion/user-guide/cli.html) for further information.

## How do I make my IDE work with `datafusion-cli`?

Answer: "open" the `datafusion/datafusion-cli` project as its own top level
"open" the `datafusion/datafusion-cli` project as its own top level
project in my IDE (rather than opening `datafusion`)

The reason `datafusion-cli` is not listed as part of the workspace in the main
The reason `datafusion-cli` is not part of the main workspace in
[`datafusion Cargo.toml`] file is that `datafusion-cli` is a binary and has a
checked in `Cargo.lock` file to ensure reproducible builds.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Please see the `developer’s guide`_ for contributing and `communication`_ for

user-guide/introduction
user-guide/example-usage
user-guide/cli
user-guide/cli/index
user-guide/dataframe
user-guide/expressions
user-guide/sql/index
Expand Down
Loading

0 comments on commit 0573f78

Please sign in to comment.