Merged
Conversation
alexfrancoeur
force-pushed
the
cli-improvements
branch
from
eef8d74 to
f8cbbf1
Compare
tsg
approved these changes
May 27, 2025
Member
|
Ah, I think these installation commands are not valid: 
|
divyenduz
approved these changes
May 28, 2025
Contributor
divyenduz
left a comment
divyenduz
left a comment
There was a problem hiding this comment.
LGTM, thanks for this ✅
| - [branch get](/cli/branch#get) - Get a field from a branch description | ||
| - [branch wait-ready](/cli/branch#wait-ready) - Wait for a branch to be ready | ||
|
|
||
| ### Schema Migrations |
Contributor
There was a problem hiding this comment.
Nit: order of the list of these comments should be start/ migrate before complete etc OR lexicographically sorted. They are random right now, feels off 🤔
|
|
||
| ```bash | ||
| xata roll start | ||
| xata roll start <file> [--lock-timeout <ms>] [--pgroll-schema <schema>] [--postgres-url <url>] [--role <role>] [--schema <schema>] [--verbose] [--backfill-batch-delay <delay>] [--backfill-batch-size <size>] [--complete] [--skip-validation] [-h|--help] |
Contributor
There was a problem hiding this comment.
Do we want to list all flags here? These are pgroll flags. Most of the time, I try to not list them out loud unless the user needs something specific and can use CLI help.
Maybe it is okay in a CLI reference (not sure)
Member
|
I fixed the CLI install command in #14 |
Contributor
Author
|
@divyenduz I'll open a PR to address the ordering of the flags and will open up the discussion around the pgroll flags. I could go either way. |
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
3 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.
More detailed CLI docs