Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Do not merge until mid-Jan] Document blob, encode, decode in NRQL functions #15346

Closed
wants to merge 2 commits into from

Conversation

maddie-boisvert
Copy link
Contributor

Please follow conventional commit standards
in your commit messages and pull request title.

Give us some context

This documents the blob, encode, and decode functions.

  • What problems does this PR solve?
  • Add any context that will help us review your changes such as testing notes,
    links to related docs, screenshots, etc.
  • If your issue relates to an existing GitHub issue, please link to it.

Copy link

Hi @maddie-boisvert 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

Gatsby Cloud will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 20 to 30 minutes).

Copy link

gatsby-cloud bot commented Nov 29, 2023

✅ docs-website-develop deploy preview ready

@maddie-boisvert maddie-boisvert marked this pull request as ready for review November 29, 2023 16:00
@austin-schaefer austin-schaefer added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels Dec 1, 2023
@austin-schaefer
Copy link
Contributor

Thanks for the PR @maddie-boisvert ! Moving this to a draft column for now, but just reach out to the docs hero when you're ready to go!

@austin-schaefer austin-schaefer marked this pull request as draft December 1, 2023 22:45
@jeff-colucci jeff-colucci changed the title [DO NOT MERGE] Document blob, encode, decode in NRQL functions [Do not merge until mid-Jan] Document blob, encode, decode in NRQL functions Dec 13, 2023
id="func-decode"
title={<InlineCode>decode(input, encoding)</InlineCode>}
>
Use the `decode()` to perform base64 conversions on strings and blobs. The input value (the first argument) will be decoded using the base64 standard specified by the encoding (the second argument).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Use the decode() function" or "Use decode()". I think I'd hyphenate base-64 as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Also an evaluable)

id="func-encode"
title={<InlineCode>encode(input, encoding)</InlineCode>}
>
Use the `encode()` to perform base64 conversions on strings. The input value (the first argument) will be encoded using the base64 standard specified by the encoding (the second argument).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same, missing "function" or extra "the", depending.

@@ -1813,6 +1813,31 @@ SELECT histogram(duration, 10, 20) FROM PageView SINCE 1 week ago
Use the `average()` function to return the average value for an attribute. It takes a single attribute name as an argument. If a value of the attribute is not numeric, it will be ignored when aggregating. If data matching the query's conditions is not found, or there are no numeric values returned by the query, it will return a value of null.
</Collapser>

<Collapser
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

blob() should be in the evaluable section rather than the aggregator section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you move dimensions() and buckets() down as well? Round() and mod() have aggregator versions, but it might make more sense to have them in the evaluable section as well, what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch, thank you!! Yes, I think round() and mod() are more helpful to have in the evaluable section. I'll do some shuffling of all the aforementioned functions

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@jeff-colucci
Copy link
Contributor

Work handled in tickets mentioned above due to numerous branch conflicts in this PR. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants