Skip to content

docs: sandbox SQL local filesystem access - #2677

Open
fengjiachun with Copilot wants to merge 3 commits into
mainfrom
copilot/update-docs-sandbox-sql-access
Open

docs: sandbox SQL local filesystem access#2677
fengjiachun with Copilot wants to merge 3 commits into
mainfrom
copilot/update-docs-sandbox-sql-access

Conversation

Copilot AI commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Documents the sandboxed local filesystem access for SQL introduced in GreptimeTeam/greptimedb#8708. Standalone deployments now restrict COPY and external-table local paths to a configurable sandbox directory; distributed deployments reject local paths entirely.

What changed

  • New migration guide (docs/user-guide/deployments-administration/migrate-local-sql-file-access.md): explains the sandbox default (<data_home>/copy), the new storage.copy_root option, and three migration paths (move files, set copy_root, or switch to object storage). Covers both standalone and distributed deployment cases.
  • Configuration reference (configuration.md): adds copy_root to the storage options table with default, behavior, and link to the migration guide.
  • COPY SQL reference (reference/sql/copy.md): adds a note that local paths are sandboxed in standalone and disabled in distributed deployments.
  • Query external data (query-external-data.md): adds a note that external-table local locations are subject to the same sandbox restrictions.
  • Sidebar (sidebars.ts): adds the migration guide to the Deployments & Administration navigation.
  • All changes applied to both English (docs/) and Chinese (i18n/zh/.../current/) nightly docs.

Scope

  • Documentation versions: Nightly
  • Languages: English, Chinese

Verification

  • Built English docs with pnpm build — no broken-link or build errors.

Checklist

  • I verified the content against the applicable GreptimeDB version.
  • I updated the relevant documentation versions and languages, or explained why not.
  • I checked changed links and anchors.
  • I updated navigation when the document structure changed.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 78abf73
Status: ✅  Deploy successful!
Preview URL: https://f705f5a3.greptime-docs.pages.dev
Branch Preview URL: https://copilot-update-docs-sandbox.greptime-docs.pages.dev

View logs

Copilot AI changed the title [WIP] Update docs for sandbox SQL local filesystem access fix docs: sandbox SQL local filesystem access Jul 31, 2026
Copilot AI requested a review from fengjiachun July 31, 2026 09:29
- Revert pnpm-lock.yaml to main (docs-only PRs must not touch lockfiles)
- Use root-relative links in configuration.md per CONTRIBUTING.md
- Update query-external-data examples to download files into the
  copy_root sandbox and use sandbox-relative locations
@fengjiachun
fengjiachun force-pushed the copilot/update-docs-sandbox-sql-access branch from 754822d to ff6328b Compare July 31, 2026 12:06
@fengjiachun
fengjiachun marked this pull request as ready for review July 31, 2026 14:14
@fengjiachun
fengjiachun requested a review from killme2008 as a code owner July 31, 2026 14:14
@fengjiachun
fengjiachun requested a review from sunng87 July 31, 2026 14:14
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.

Update docs for fix: sandbox SQL local filesystem access

2 participants