Skip to content

docs: add PostgreSQL COPY TO STDOUT docs for nightly and v1.0#2463

Merged
fengjiachun merged 3 commits into
mainfrom
copilot/update-docs-postgres-copy-stdout
May 11, 2026
Merged

docs: add PostgreSQL COPY TO STDOUT docs for nightly and v1.0#2463
fengjiachun merged 3 commits into
mainfrom
copilot/update-docs-postgres-copy-stdout

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 9, 2026

What's Changed in this PR

This updates the SQL COPY reference for the PostgreSQL COPY (<QUERY>) TO STDOUT feature added in GreptimeDB. The docs are revised for nightly and v1.0 in both English and Chinese.

  • SQL COPY reference

    • Document COPY (<QUERY>) TO STDOUT for PostgreSQL protocol usage
    • Clarify that output is streamed to the PostgreSQL client rather than written on the GreptimeDB server
    • Note that the feature applies to query-result copy-out only
  • Protocol-compatible syntax

    • Document supported formats: default text, csv, and binary
    • Clarify that PostgreSQL-compatible option forms are accepted with both WITH (...) and bare (...)
  • Client usage example

    • Add a psql \copy example showing how to save streamed output to a local client file
COPY (SELECT * FROM tbl WHERE host = 'host1') TO STDOUT WITH (FORMAT csv);

\copy (SELECT * FROM tbl WHERE host = 'host1') TO '/tmp/file.csv' WITH (FORMAT csv)

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • accounts.google.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=14974 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-QgIOau --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6908067759359494768,3456000686271184130,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)
  • cdn.jsdelivr.net
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=14974 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-QgIOau --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6908067759359494768,3456000686271184130,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)
  • clients2.google.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=14974 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-QgIOau --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6908067759359494768,3456000686271184130,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)
  • greptime.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=14974 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-QgIOau --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6908067759359494768,3456000686271184130,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)
  • srgb68y6cw-dsn.algolia.net
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=14974 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-QgIOau --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6908067759359494768,3456000686271184130,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)
  • www.google-analytics.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=14974 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-QgIOau --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6908067759359494768,3456000686271184130,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)
  • www.googletagmanager.com
    • Triggering command: /proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=network --no-sandbox --disable-dev-shm-usage --use-angle=swiftshader-webgl --mute-audio --crashpad-handler-pid=14974 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/puppeteer_dev_chrome_profile-QgIOau --change-stack-guard-on-fork=enable --shared-files=network_parent_dirs_pipe:100,v8_context_snapshot_data:101 --field-trial-handle=3,i,6908067759359494768,3456000686271184130,262144 --enable-features=PdfOopif --disable-features=AcceptCHFrame,IsolateSandboxedIframes,MediaRouter,OptimizationHints,PaintHolding,ProcessPerSiteUpToMainFrameThreshold,Translate --variations-seed-version git (dns block)
    • Triggering command: /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome /home/REDACTED/.cache/puppeteer/chrome/linux-137.0.7151.119/chrome-linux64/chrome --allow-pre-commit-input --disable-REDACTED-networking --disable-REDACTED-timer-throttling --disable-REDACTEDing-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-REDACTED-pages --disable-crash-reporter --disable-default-apps --disable-dev-shm-usage --disable-hang-monitor --disable-infobars --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-REDACTEDing --disable-search-engine-choice-screen --disable-sync --enable-automation (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Agent-Logs-Url: https://github.com/GreptimeTeam/docs/sessions/a1888b7c-3d59-44eb-8600-9777b2bc7b12

Co-authored-by: killme2008 <14142+killme2008@users.noreply.github.com>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 9, 2026

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 17a132a
Status: ✅  Deploy successful!
Preview URL: https://8e4c5d48.greptime-docs.pages.dev
Branch Preview URL: https://copilot-update-docs-postgres.greptime-docs.pages.dev

View logs

@killme2008 killme2008 requested a review from sunng87 May 9, 2026 09:39
@killme2008
Copy link
Copy Markdown
Member

@sunng87 Please take a look

Agent-Logs-Url: https://github.com/GreptimeTeam/docs/sessions/a1888b7c-3d59-44eb-8600-9777b2bc7b12

Co-authored-by: killme2008 <14142+killme2008@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for implement postgres copy to stdout docs: add PostgreSQL COPY TO STDOUT docs for nightly and v1.0 May 9, 2026
Copilot AI requested a review from killme2008 May 9, 2026 09:40
@killme2008 killme2008 marked this pull request as ready for review May 11, 2026 03:51
@killme2008 killme2008 requested a review from fengjiachun as a code owner May 11, 2026 03:51
Copy link
Copy Markdown
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

@fengjiachun fengjiachun merged commit f81d30f into main May 11, 2026
7 checks passed
@fengjiachun fengjiachun deleted the copilot/update-docs-postgres-copy-stdout branch May 11, 2026 04: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.

Update docs for feat: implement postgres copy to stdout

4 participants