Skip to content

Conversation

@klion26
Copy link
Member

@klion26 klion26 commented Nov 11, 2025

Which issue does this PR close?

What changes are included in this PR?

Enhance the help message for invalid command, add the help command in the help message.

Are these changes tested?

Manual test

image

Are there any user-facing changes?

No

Before this commit, we just print that the input command is invalid,
in this commit, we add the help command (`\?`) so that user can easily know
the alll commands we supported.
@alamb
Copy link
Contributor

alamb commented Nov 11, 2025

I tried it out and it works great -- thanks @klion26

> \dd
'\dd' is not a valid command, you can use '\?' to see all commands
> \?
Command,Description
\d,list tables
\d name,describe table
\q,quit datafusion-cli
\?,help
\i filename,reads input from the specified filename
\h,function list
\h function,search function
\quiet (true|false)?,print or set quiet mode
\pset [NAME [VALUE]],"set table output option
(format)"
\object_store_profiling (disabled|summary|trace),print or set object store profile mode
10 row(s) fetched.
Elapsed 0.000 seconds.

@alamb alamb added this pull request to the merge queue Nov 11, 2025
@alamb
Copy link
Contributor

alamb commented Nov 11, 2025

Thanks @Jefffrey for the review

Merged via the queue into apache:main with commit 6d9ab45 Nov 11, 2025
28 checks passed
@klion26 klion26 deleted the enhance_help_msg branch November 11, 2025 12:26
@klion26
Copy link
Member Author

klion26 commented Nov 11, 2025

@Jefffrey @alamb thanks for the quick review and merge!

@alamb
Copy link
Contributor

alamb commented Nov 11, 2025

@Jefffrey @alamb thanks for the quick review and merge!

you make it easy!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhance the help message for invalid command in datafusion-cli

3 participants