feat(stdlib): add experimental.preview function #4725
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
sanderson
requested changes
May 9, 2022
Comment on lines
1256
to
1259
| // preview limits the number of rows and tables in the stream. | ||
| // The group keys that are included are not deterministic and depends on the order | ||
| // that the engine sends them. |
Contributor
There was a problem hiding this comment.
Suggested change
| // preview limits the number of rows and tables in the stream. | |
| // The group keys that are included are not deterministic and depends on the order | |
| // that the engine sends them. | |
| // preview limits the number of rows and tables in the stream. | |
| // | |
| // Included groups keys are not deterministic and depend on the order | |
| // that the engine sends them. |
| // that the engine sends them. | ||
| // | ||
| // ## Parameters | ||
| // - nrows: Maximum number of rows in each table. |
Contributor
There was a problem hiding this comment.
Suggested change
| // - nrows: Maximum number of rows in each table. | |
| // - nrows: Maximum number of rows per table to return. |
Contributor
There was a problem hiding this comment.
Does this parameter have a default value? The example below suggests that it does.
| // ## Parameters | ||
| // - nrows: Maximum number of rows in each table. | ||
| // | ||
| // - ntables: Maximum number of tables returned by the transformation. |
Contributor
There was a problem hiding this comment.
Suggested change
| // - ntables: Maximum number of tables returned by the transformation. | |
| // - ntables: Maximum number of tables to return. |
Contributor
There was a problem hiding this comment.
Does this parameter have a default value? The example below suggests that it does.
Comment on lines
1270
to
1275
| // ``` | ||
| // import "experimental" | ||
| // import "sampledata" | ||
| // | ||
| // sampledata.init() | ||
| // |> experimental.preview() |
Contributor
There was a problem hiding this comment.
Suggested change
| // ``` | |
| // import "experimental" | |
| // import "sampledata" | |
| // | |
| // sampledata.init() | |
| // |> experimental.preview() | |
| // ``` | |
| // import "experimental" | |
| // import "sampledata" | |
| // | |
| // sampledata.int() | |
| // |> experimental.preview() | |
| // ``` |
| // |> experimental.preview() | ||
| // | ||
| // ## Metadata | ||
| // introduced: next |
Contributor
There was a problem hiding this comment.
@nathanielc Does case matter here? Does this need to be NEXT?
Contributor
Author
There was a problem hiding this comment.
It looks like it's supposed to be NEXT. Fixed.
d75e074 to
818f27a
Compare
818f27a to
41449da
Compare
sanderson
reviewed
May 10, 2022
Comment on lines
+1258
to
+1259
| // Included group keys are not deterministic and depends on the order | ||
| // that the engine sends them. |
Contributor
There was a problem hiding this comment.
Suggested change
| // Included group keys are not deterministic and depends on the order | |
| // that the engine sends them. | |
| // The function is designed to quickly provide a data preview by not | |
| // returning the entire result set. | |
| // Included group keys are not deterministic and depend on the order | |
| // that the engine sends them. |
Comment on lines
1276
to
1277
| // sampledata.init() | ||
| // |> experimental.preview() |
Contributor
There was a problem hiding this comment.
- Change
sampledata.init()tosampledata.int() - Passing parameters in the example will show exactly how the input tables are modified.
- Add input (
<) and output (>) identifiers to generate the input and output examples.
Suggested change
| // sampledata.init() | |
| // |> experimental.preview() | |
| // < sampledata.int() | |
| // > |> experimental.preview(nrows: 3, ntables: 1) |
41449da to
334dbeb
Compare
The preview function will limit the number of rows and the number of tables that can be returned by a transformation. It will discard any remaining tables/rows.
334dbeb to
d5ea073
Compare
sanderson
approved these changes
May 10, 2022
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.
The preview function will limit the number of rows and the number of
tables that can be returned by a transformation. It will discard any
remaining tables/rows.
Fixes #4719.
Done checklist