Add SQL output format option#5459
Merged
Merged
Conversation
clockwork-labs-bot
requested review from
bfops,
cloutiertyler and
jdetter
as code owners
bfops
approved these changes
Jun 29, 2026
bfops
left a comment
bfops
left a comment
Collaborator
There was a problem hiding this comment.
seems to work as expected for me, with both
cargo run -pspacetimedb-cli -- sql -s maincloud --format=json spacetime-control
and
cargo run -pspacetimedb-cli -- sql -s maincloud --format=json spacetime-control --interactive
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of Changes
Adds
--formattospacetime sql, matchingspacetime logswithtextas the default andjsonas the raw API response output. The REPL path passes the selected format through to each query while preserving the existing text output and stats behavior by default.Closes #5450.
API and ABI breaking changes
None.
Expected complexity level and risk
Testing
PATH=/Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin:$PATH /Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin/rustfmt --check crates/cli/src/subcommands/sql.rs crates/cli/src/subcommands/repl.rsgit diff --checkPATH=/Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin:$PATH /Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin/cargo check -p spacetimedb-cliPATH=/Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin:$PATH /Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin/cargo test -p spacetimedb-cli subcommands::sql::tests:: -- --nocapturePATH=/Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin:$PATH /Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin/cargo run -p spacetimedb-cli -- sql --helpPATH=/Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin:$PATH /Users/clockworklabs/.rustup/toolchains/1.93.0-aarch64-apple-darwin/bin/cargo ci self-docs --checkNote:
cargo ci self-docs --checkprinted the existing warningargument dotnet is missing help text.Note:
cargo fmt --all --checkcould not be run in this shell because the installed cargo toolchains do not exposecargo-fmt;rustfmt --checkwas run directly on the touched Rust files instead.