update help text for top-level super command #5426
Merged
+32
−36
Conversation
This file contains 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
philrz
approved these changes
Nov 3, 2024
cmd/super/root/command.go
Outdated
| HiddenFlags: "cpuprofile,memprofile,pathregexp", | ||
| Long: ` | ||
| XXX "super" is a command-line tool for processing data in diverse input formats, | ||
| The "super" command provides a way to process data in diverse input formats, | ||
| providing search, analytics, and extensive transormations using |
There was a problem hiding this comment.
Suggested change
| providing search, analytics, and extensive transormations using | |
| providing search, analytics, and extensive transformations using |
cmd/super/root/command.go
Outdated
| A query typically applies Boolean logic or keyword search to filter | ||
| the input and then transforms or analyzes the filtered stream. | ||
| Output is written to one or more files or to standard output. | ||
|
|
||
| A Zed query is comprised of one or more operators interconnected | ||
| A query is comprised of one or more operators interconnected | ||
| into a pipeline using the Unix pipe character "|". |
There was a problem hiding this comment.
Suggested change
| into a pipeline using the Unix pipe character "|". | |
| into a pipeline using the Unix pipe character "|>". |
Want to aspirationally make this change now on the assumption #5427 will go through?
BTW, I briefly paused on what to call |> since it's not a single character, but I see the Google paper still calls it " the pipe character '|>'" so it seems like we can just go with that (though I also think the Unix comparison is still totally worth keeping).
There was a problem hiding this comment.
using the pipe symbol "|>"
cmd/super/root/command.go
Outdated
| A query typically applies Boolean logic or keyword search to filter | ||
| the input and then transforms or analyzes the filtered stream. | ||
| Output is written to one or more files or to standard output. | ||
|
|
||
| A Zed query is comprised of one or more operators interconnected | ||
| A query is comprised of one or more operators interconnected | ||
| into a pipeline using the Unix pipe character "|". | ||
| See https://github.com/brimdata/super/tree/main/docs/language |
There was a problem hiding this comment.
Suggested change
| See https://github.com/brimdata/super/tree/main/docs/language | |
| See https://zed.brimdata.io/docs/language |
cmd/super/root/command.go
Outdated
| into a pipeline using the Unix pipe character "|". | ||
| See https://github.com/brimdata/super/tree/main/docs/language | ||
| for details. | ||
| for details. The "select" and "from" operators provide backward | ||
| compatible with SQL. In fact, you can use SQL exclusively and |
There was a problem hiding this comment.
Suggested change
| compatible with SQL. In fact, you can use SQL exclusively and | |
| compatibility with SQL. In fact, you can use SQL exclusively and |
cmd/super/root/command.go
Outdated
|
|
||
| Supported input formats include CSV, JSON, NDJSON, Parquet, | ||
| Supported file formats include Arrow, CSV, JSON, Parquet, | ||
| Super JSON, Super Binary, Super Columnar, and Zeek TSV. |
There was a problem hiding this comment.
Suggested change
| Super JSON, Super Binary, Super Columnar, and Zeek TSV. | |
| Super JSON, Super Binary, Super Columnar, and Zeek TSV. |
cmd/super/root/command.go
Outdated
| For most types of data, the input format is automatically detected. | ||
| If multiple files are specified, each file format is determined independently | ||
| so you can mix and match input types. If multiple files are concatenated | ||
| into a stream and presented as standard input, the files must all be of the | ||
| same type as the beginning of stream will determine the format. | ||
|
|
||
| If no input file is specified, the default of a single null value will be |
There was a problem hiding this comment.
Suggested change
| If no input file is specified, the default of a single null value will be | |
| If no input file is specified, the default of a single null input value will be |
cmd/super/root/command.go
Outdated
| For most types of data, the input format is automatically detected. | ||
| If multiple files are specified, each file format is determined independently | ||
| so you can mix and match input types. If multiple files are concatenated | ||
| into a stream and presented as standard input, the files must all be of the | ||
| same type as the beginning of stream will determine the format. | ||
|
|
||
| If no input file is specified, the default of a single null value will be | ||
| fed to the query. This is analogous to SQL's default input of a single |
There was a problem hiding this comment.
Suggested change
| fed to the query. This is analogous to SQL's default input of a single | |
| fed to the query. This is analogous to SQL's default input of a single |
cmd/super/root/command.go
Outdated
| convenient when a large, complex query spans multiple lines. In this case, | ||
| these source files are concatenated together along with the command-line query text | ||
| in the order appearing on the command line. | ||
| in the order appearing on the command line. Any error messages are properly | ||
| collated to the included file in which it occurred. |
There was a problem hiding this comment.
Suggested change
| collated to the included file in which it occurred. | |
| collated to the included file in which they occurred. |
cmd/super/root/command.go
Outdated
| "zq" must be run with at least one input. Input files can | ||
| be file system paths; "-" for standard input; or HTTP, HTTPS, or S3 URLs. | ||
| Input files may be file system paths; | ||
| "-" for standard input; or HTTP, HTTPS, or S3 URLs. | ||
| For most types of data, the input format is automatically detected. | ||
| If multiple files are specified, each file format is determined independently | ||
| so you can mix and match input types. If multiple files are concatenated | ||
| into a stream and presented as standard input, the files must all be of the | ||
| same type as the beginning of stream will determine the format. |
There was a problem hiding this comment.
Suggested change
| same type as the beginning of stream will determine the format. | |
| same type as the beginning of the stream will determine the format. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.