Skip to content

docs: clarify SQL Editor Export re-executes the query#1089

Merged
adela-bytebase merged 3 commits intomainfrom
docs/sql-editor-export-reexecution
Apr 22, 2026
Merged

docs: clarify SQL Editor Export re-executes the query#1089
adela-bytebase merged 3 commits intomainfrom
docs/sql-editor-export-reexecution

Conversation

@adela-bytebase
Copy link
Copy Markdown
Contributor

Summary

  • A customer reported that Export feels like it should download the result set currently on screen, but it actually re-runs the SQL statement. A first-time user has no way to know — no doc says so, no UI warning.
  • Ground truth confirmed from source: sql_service.go:839-890 calls doExportqueryRetry → fresh statement execution; frontend at ResultViewV1.vue:315-355 sends the statement, not the fetched rows.
  • Added a behavior callout to docs/sql-editor/run-queries.mdx (the page users land on when asking "how does Export work?") and converted the near-duplicate paragraph in docs/security/database-permission/export.mdx into a pointer link so the explanation has a single home.

Test plan

  • Preview builds on Mintlify without broken anchor /sql-editor/run-queries#export-data
  • Masking-policy link still resolves

🤖 Generated with Claude Code

The Export button re-runs the SQL statement against the database
instead of dumping the rows currently shown in the result panel —
a reasonable first-time user assumption that the docs did not
correct. Add a behavior note on run-queries.mdx and point the
security page at it so the explanation lives in one place.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 21, 2026 20:11
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
bytebase-com Ready Ready Preview, Comment Apr 22, 2026 7:27am

Request Review

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 21, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
bytebase-doc 🟢 Ready View Preview Apr 21, 2026, 8:13 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Clarifies the SQL Editor Export behavior (it re-executes the SQL statement rather than downloading the currently displayed result set) and consolidates the explanation so there’s a single canonical documentation location.

Changes:

  • Added an explicit callout in run-queries.mdx explaining that Export re-runs the SQL statement and may reflect newer database state.
  • Replaced the near-duplicate explanation in the database permission export doc with a link to the canonical section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/sql-editor/run-queries.mdx Adds an Export behavior callout under “Export data” and reiterates masking/limits context.
docs/security/database-permission/export.mdx Replaces duplicated Export explanation with a pointer link to the SQL Editor docs section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/sql-editor/run-queries.mdx Outdated
Comment thread docs/security/database-permission/export.mdx Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@adela-bytebase adela-bytebase merged commit 3356769 into main Apr 22, 2026
5 checks passed
@adela-bytebase adela-bytebase deleted the docs/sql-editor-export-reexecution branch April 22, 2026 07:27
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.

3 participants