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

Update datafusion-cli docs, split up #10078

Merged
merged 3 commits into from
Apr 16, 2024
Merged

Update datafusion-cli docs, split up #10078

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b98fa5e
Update datafusion-cli docs, split up
alamb Apr 14, 2024
d4ab560
remove PiPI instructions
alamb Apr 16, 2024
9329872
Merge remote-tracking branch 'apache/main' into alamb/datafusion_cli_…
alamb Apr 16, 2024
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
8 changes: 4 additions & 4 deletions datafusion-cli/README.md
View file
Open in desktop
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
View file
Open in desktop
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