Skip to content

Document EXPLAIN (OPT, ENV) URL output #5776

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

Merged
merged 1 commit into from
Nov 5, 2019

Conversation

rmloveland
Copy link
Contributor

Fixes #5191.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@cockroach-teamcity
Copy link
Member

Copy link
Member

@RaduBerinde RaduBerinde left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @RaduBerinde and @rmloveland)


v19.2/explain.md, line 298 at r1 (raw file):

<span class="version-tag">New in v19.1:</span> The output of `EXPLAIN (OPT,ENV)` is now a URL with the data encoded in the fragment portion. Opening the URL shows a page with the decoded data. This change makes it easier to share debugging information across different systems without encountering formatting issues.

Note that the data is processed in the local browser session and is never sent out over the network.

Maybe we should add a caveat here that one needs to be careful about browser extensions which could in principle harvest that data.

@rmloveland rmloveland force-pushed the 20191104-use-url-for-explain-opt-env branch from 4b405c6 to a2a6ea7 Compare November 5, 2019 16:47
Copy link
Contributor Author

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

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

Thanks for the review Radu!

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (and 1 stale) (waiting on @RaduBerinde)


v19.2/explain.md, line 298 at r1 (raw file):

Previously, RaduBerinde wrote…

Maybe we should add a caveat here that one needs to be careful about browser extensions which could in principle harvest that data.

Good point! Added a sentence mentioning that.

@cockroach-teamcity
Copy link
Member

@rmloveland rmloveland merged commit b716fb7 into master Nov 5, 2019
@rmloveland rmloveland deleted the 20191104-use-url-for-explain-opt-env branch November 5, 2019 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

opt: use URL for EXPLAIN (OPT,ENV)
3 participants