Skip to content

Conversation

@d-bytebase
Copy link
Contributor

@d-bytebase d-bytebase commented Aug 13, 2025

Summary

  • Restructured user privilege requirements into four clear options with SQL examples
  • Simplified database setup instructions
  • Updated connection string documentation with reference to official PostgreSQL docs

Changes

  • Clarified four distinct user privilege options:
    1. SUPERUSER - with note about cloud database limitations
    2. Database Owner (ALTER DATABASE)
    3. CREATE privilege on public schema
    4. Database Owner Role (GRANT db_owner)
  • Added SQL command examples for each privilege configuration
  • Simplified database creation instructions to be more direct
  • Updated connection string example with clearer placeholder values
  • Added reference to official PostgreSQL URI documentation
  • Removed redundant privilege list that was causing confusion

Test plan

  • Documentation builds correctly
  • All SQL examples are syntactically valid
  • Links to external documentation are working

🤖 Generated with Claude Code

- Clarify three distinct user privilege options (superuser, database owner, schema create)
- Add SQL examples for each privilege configuration
- Note cloud database limitations for superuser option
- Simplify database creation instructions
- Update connection string example with clearer placeholders
- Add reference to official PostgreSQL URI documentation

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copilot AI review requested due to automatic review settings August 13, 2025 08:01
@vercel
Copy link

vercel bot commented Aug 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Preview Comment Aug 13, 2025 8:08am

Copy link
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

This PR improves the documentation for configuring external PostgreSQL databases with Bytebase by reorganizing user privilege requirements into clear, actionable options. The changes simplify the setup process by providing three distinct privilege configurations with concrete SQL examples and streamline the overall documentation structure.

  • Restructured user privilege requirements into three clear options with SQL command examples
  • Simplified database creation instructions to be more direct and actionable
  • Updated connection string documentation with reference to official PostgreSQL documentation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions
Copy link

github-actions bot commented Aug 13, 2025

📝 Broken Links Check Report

Note: Entries under /api-reference/ are likely false positives and can be ignored.

The following is the output from the broken links check:

found 16 broken links in 9 files

integrations/api/audit-log.mdx
 ⎿  /api-reference/auditlogservice/post-v1auditlogs:search

integrations/api/authentication.mdx
 ⎿  /api-reference/authservice/post-v1authlogin

integrations/api/data-classification.mdx
 ⎿  /api-reference/settingservice/patch-v1settings
 ⎿  /api-reference/databaseservice/patch-v1instances-databases

integrations/api/issue.mdx
 ⎿  /api-reference/issueservice/post-v1projects-issues

integrations/api/permission.mdx
 ⎿  /api-reference/workspaceservice/get-v1workspaces-:getIamPolicy
 ⎿  /api-reference/projectservice/get-v1projects-:getIamPolicy
 ⎿  /api-reference/roleservice/get-v1roles
 ⎿  /api-reference/userservice/get-v1users
 ⎿  /api-reference/groupservice/get-v1groups

integrations/api/plan.mdx
 ⎿  /api-reference/planservice/post-v1projects-plans
 ⎿  /api-reference/sheetservice/post-v1projects-sheets

integrations/api/release.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases

integrations/api/rollout.mdx
 ⎿  /api-reference/rolloutservice/post-v1projects-rollouts

integrations/api/sql-review.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases:check
 ⎿  /api-reference/sqlservice/post-v1sqlcheck

- Add Option 4 for granting db_owner role to bytebase user
- Provides an alternative method for database ownership privileges

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link
Member

@h3n4l h3n4l left a comment

Choose a reason for hiding this comment

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

LGTM

@h3n4l h3n4l merged commit 2bd4506 into main Aug 13, 2025
5 checks passed
@h3n4l h3n4l deleted the update-external-postgres-docs branch August 13, 2025 08: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.

4 participants