update docs on super command for SQL/OLAP audience #5481
Merged
Conversation
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
philrz
reviewed
Nov 15, 2024
docs/commands/super.md
Outdated
| super -f arrows file1.json file2.parquet file3.csv > file-combined.arrows | ||
| ``` | ||
| When `super` is run with a query that has no "from" operator and no input arguments, | ||
| the SuperSQL query is fed a single `null` value analagous to SQL's default |
Contributor
There was a problem hiding this comment.
Suggested change
| the SuperSQL query is fed a single `null` value analagous to SQL's default | |
| the SuperSQL query is fed a single `null` value analogous to SQL's default |
docs/commands/super.md
Outdated
| select value 1+1 | ||
| ``` | ||
| To learn more about shortcuts, refer to the SuperSQL | ||
| [documenation on shortcuts](../language/pipeline-model.md#implied-operators). |
Contributor
There was a problem hiding this comment.
Suggested change
| [documenation on shortcuts](../language/pipeline-model.md#implied-operators). | |
| [documentation on shortcuts](../language/pipeline-model.md#implied-operators). |
docs/commands/super.md
Outdated
| `super` supports a number of [input](#input-formats) and [output](#output-formats) formats, but the super formats | ||
| ([Super Binary](../formats/bsup.md), | ||
| [Super Columnar](../formats/csup.md), | ||
| and [Super JSON](../formats/jsup.md)) tend to the most versatile and |
Contributor
There was a problem hiding this comment.
Suggested change
| and [Super JSON](../formats/jsup.md)) tend to the most versatile and | |
| and [Super JSON](../formats/jsup.md)) tend to be the most versatile and |
docs/commands/super.md
Outdated
| ... | ||
| wget https://data.gharchive.org/2023-02-08-23.json.gz | ||
| ``` | ||
| We downloadied these files into a directory called `gharchive_gz` |
Contributor
There was a problem hiding this comment.
Suggested change
| We downloadied these files into a directory called `gharchive_gz` | |
| We downloaded these files into a directory called `gharchive_gz` |
docs/commands/super.md
Outdated
| `super` with Super Binary is substantially faster than the relational systems for | ||
| the search use cases and performs on par with the others for traditional OLAP queries, | ||
| except for the union query, where the super-structured data model trounces the relational | ||
| model (by over 100X!) for stiching together disparate data types for analysis in an aggregation. |
Contributor
There was a problem hiding this comment.
Suggested change
| model (by over 100X!) for stiching together disparate data types for analysis in an aggregation. | |
| model (by over 100X!) for stitching together disparate data types for analysis in an aggregation. |
docs/commands/super.md
Outdated
| ## Appendix 1: Preparing the Test Data | ||
|
|
||
| We used the Bash `time` command to measure elapsed time. | ||
| For our tests, We diverged a bit from the methodology in the DuckDB blog and wanted |
Contributor
There was a problem hiding this comment.
Suggested change
| For our tests, We diverged a bit from the methodology in the DuckDB blog and wanted | |
| For our tests, we diverged a bit from the methodology in the DuckDB blog and wanted |
docs/commands/super.md
Outdated
| ``` | ||
| duckdb gha.db -c "CREATE TABLE gha AS FROM read_json('gharchive_gz/*.json.gz', union_by_name=true)" | ||
| ``` | ||
| We now have the `duckdb` database file for out GitHub Archive data called `gha.db` |
Contributor
There was a problem hiding this comment.
Suggested change
| We now have the `duckdb` database file for out GitHub Archive data called `gha.db` | |
| We now have the `duckdb` database file for our GitHub Archive data called `gha.db` |
philrz
approved these changes
Nov 15, 2024
Contributor
philrz
left a comment
philrz
left a comment
There was a problem hiding this comment.
I put up suggestions to fix some obvious typos and such. There's more changes I'd propose but I'm fine with seeing this merged and I could put up my proposals in a follow-on PR.
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.