This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 180cbfb7b3 Minor: Update datafusion-cli README to explain why it is
not in the w… (#8938)
180cbfb7b3 is described below
commit 180cbfb7b32863823c7719cd3bf8c89ab5fd0c7d
Author: Andrew Lamb <[email protected]>
AuthorDate: Mon Jan 22 14:44:19 2024 -0500
Minor: Update datafusion-cli README to explain why it is not in the w…
(#8938)
* Minor: Update datafusion-cli README to explain why it is not in the
workspace
* Update datafusion-cli/README.md
Co-authored-by: Trung Dinh <[email protected]>
---------
Co-authored-by: Trung Dinh <[email protected]>
---
datafusion-cli/README.md | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/datafusion-cli/README.md b/datafusion-cli/README.md
index 1d99cfbcb0..0afcd489f7 100644
--- a/datafusion-cli/README.md
+++ b/datafusion-cli/README.md
@@ -25,4 +25,22 @@
The DataFusion CLI is a command line utility that runs SQL queries using the
DataFusion engine.
-See the [`datafusion-cli`
documentation](https://arrow.apache.org/datafusion/user-guide/cli.html) for
further information.
+# 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.
+
+## How do I make my IDE work with `datafusion-cli`?
+
+Answer: "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
+[`datafusion Cargo.toml`] file is that `datafusion-cli` is a binary and has a
+checked in `Cargo.lock` file to ensure reproducible builds.
+
+However, the `datafusion` and sub crates are intended for use as libraries and
+thus do not have a `Cargo.lock` file checked in.
+
+[`datafusion cargo.toml`]:
https://github.com/apache/arrow-datafusion/blob/main/Cargo.toml
