Conversation
Update documentation to reflect the new external database option for plan generation: - .env.example: Add PGSCHEMA_PLAN_* environment variables with usage examples and explanations - CLAUDE.md: Document the external database feature in architecture, environment variables, and key patterns sections The external database feature allows users to provide their own PostgreSQL database instead of using embedded postgres, which is useful for environments where embedded postgres has limitations (e.g., ARM architectures, containerized environments). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Create detailed documentation for the external plan database feature covering: - Overview and when to use external database vs embedded - Configuration options (CLI flags and environment variables) - Real-world examples: - Docker Compose setup - GitHub Actions CI/CD pipeline - Kubernetes deployment - Version compatibility requirements - Database permissions needed - Best practices (dedicated database, cleanup, monitoring, pooling) - Troubleshooting common issues - Comparison table: embedded vs external database The documentation provides production-ready examples for containerized environments, CI/CD pipelines, and Kubernetes deployments where the external database feature is most valuable. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
….mdx - Add "Common Use Cases" section with practical examples for: - Using PostgreSQL extensions (issue #121) - Handling cross-schema foreign keys (issue #122) - Update plan.mdx to reference external plan database feature: - Add explanation to Overview section - Add "Plan Database Options" section with link - Add example showing external database usage - Streamline plan-db.mdx by focusing on main use cases - Update docs.json navigation to include plan-db page 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the External Plan Database feature, which allows users to specify an external PostgreSQL database instead of using the embedded PostgreSQL instance when generating migration plans. This is useful for schemas requiring PostgreSQL extensions or cross-schema foreign key references.
Key changes:
- New documentation page explaining the External Plan Database feature with usage examples and configuration options
- Updated plan command documentation to reference the new external database option
- Added environment variable documentation for plan database configuration
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs.json | Added cli/plan-db to the Configuration group in navigation |
| docs/cli/plan.mdx | Updated overview to mention external database option and added reference section |
| docs/cli/plan-db.mdx | New comprehensive documentation for External Plan Database feature |
| CLAUDE.md | Updated architecture documentation to explain external database support |
| .env.example | Added plan database environment variable examples with explanatory comments |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.