feat(http): add support for nm=true query parameter in text export (/exp) to exclude metadata#4639
Merged
bluestreak01 merged 1 commit intomasterfrom Jun 14, 2024
Merged
Conversation
…(/exp) to exclude metadata Add "nm=true" as a query parameter to exclude headers in CSV exports. This is useful for scripting data-based monitoring tasks. Example, return ingestion lag in milliseconds: ``` $ curl -G "http://localhost:9000/exp" --data-urlencode "query=SELECT (now () - max(timestamp)) / 1000 from trades;" --data-urlencode "nm=true" 210 ``` This returns only the query result, omitting any metadata, which allows monitoring without requiring additional post-processing. Additionally, the 'nm' parameter was already supported in the JSON (/exec) endpoint, and this PR enhances the consistency of the QuestDB REST interface. Fixes #4629
jerrinot
added
Enhancement
jerrinot
changed the title
nm=true query parameter in text export (/exp) to exclude metadata
Contributor
Author
|
docs PR will follow |
Contributor
Author
|
a failure due to a completely unrelated #4374 :( |
Collaborator
[PR Coverage check]😍 pass : 9 / 9 (100.00%) file detail
|
nwoolmer
approved these changes
Jun 12, 2024
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
4 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.
Add
nm=trueas a query parameter to exclude headers in CSV exports. This is useful for scripting data-based monitoring tasks.Example, return ingestion lag in milliseconds:
This returns only the query result, omitting any metadata, which allows monitoring without requiring additional post-processing.
Additionally, the
nmparameter was already supported in the JSON (/exec) endpoint, and this PR improves the consistency of the QuestDB REST interface.Fixes #4629