Skip to content

Add detailed usage docs for writing queries and exporting results#65

Open
muk2 wants to merge 1 commit intomainfrom
feature/issue-58-usage-docs
Open

Add detailed usage docs for writing queries and exporting results#65
muk2 wants to merge 1 commit intomainfrom
feature/issue-58-usage-docs

Conversation

@muk2
Copy link
Owner

@muk2 muk2 commented Feb 21, 2026

Summary

  • Added a "Writing and Running Queries" section to README.md explaining query execution, multi-statement editing, cursor-based execution, and semicolon splitting behavior
  • Clarified that pgrsql uses standard PostgreSQL SQL syntax with no special formatting or spacing requirements — addresses confusion reported in Query editor misinterprets valid SQL syntax #57 and Query formatting rules unclear and inconsistent #60
  • Added a dedicated "Exporting Results" section documenting all 5 export formats (CSV, JSON, SQL INSERT, TSV, clipboard) and the export workflow

What Changed

  • README.md: Added two new documentation sections between the existing "Query History" and "Examples" sections

Test Plan

  • Read through the new sections for clarity and accuracy
  • Verify the documented keyboard shortcuts match actual behavior (F5, Ctrl+S, 1-5 quick export)
  • Verify the documented export file naming convention (pgrsql_export_YYYYMMDD_HHMMSS.<ext>) matches the code

Closes #58
Related: #57, #60

🤖 Generated with Claude Code

Documents how query execution works (F5/Ctrl+Enter, cursor-based
multi-statement execution, semicolon splitting), clarifies that
standard PostgreSQL SQL syntax is fully supported with no special
formatting requirements, and adds a dedicated Exporting Results
section explaining all export formats and workflow.

Closes #58

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

Missing documentation on how to run queries and export results

1 participant