Skip to content

docs: list the \i and \pset commands in the CLI usage guide - #26655

Open
rawsun007 wants to merge 1 commit into
apache:mainfrom
rawsun007:docs-cli-include-pset
Open

rawsun007 wants to merge 1 commit into
apache:mainfrom
rawsun007:docs-cli-include-pset

Conversation

@rawsun007

Copy link
Copy Markdown
Contributor

Important

Fork CI setup: For pull requests from a fork to main, enable workflows in your fork's Actions tab before you push.
See the fork CI setup guide.

Which issue does this PR close?

  • None; documentation fix.

  • Closes #.

Rationale for this change

The CLI usage guide's Commands section lists \q, \?, \d, \quiet, \h and \object_store_profiling, but not \i filename (run the SQL in a file) or \pset (show or change the output format), both of which \? lists.

What changes are included in this PR?

Two entries added to docs/source/user-guide/cli/usage.md, in the same style as the others.

What is the testing strategy for this PR?

Ran \i, \pset, \pset format csv, \pset format nd-json and an invalid format in datafusion-cli built from main; each behaves as described. ./ci/scripts/doc_prettier_check.sh passes. Docs only, no test.

Are there any user-facing changes?

Documentation only.

Generated with Claude Code (claude-opus-5-5), by comparing the commands datafusion-cli accepts with the ones the guide documents.

Both commands exist in datafusion-cli but were missing from the Commands section.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 23, 2026
@alamb alamb added the Prolific Author author has opened PRs in many repositories in the last month label Oct 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Prolific Author author has opened PRs in many repositories in the last month

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants