GaussDB Rust Driver Documentation

📚 Documentation Index

Welcome to the GaussDB Rust driver documentation. This directory contains comprehensive guides and references for using the driver effectively.

📖 Available Documents

Compatibility Documentation

• 中文版兼容性文档 - GaussDB/OpenGauss 与 PostgreSQL 兼容性详细说明
• English Compatibility Guide - Detailed compatibility information between GaussDB/OpenGauss and PostgreSQL

🎯 Quick Navigation

For New Users

1. Start with the Compatibility Guide to understand the differences
2. Review the Migration Guidelines for best practices
3. Check the Compatibility Matrix for feature support

For Developers

1. Review Known Incompatibilities before coding
2. Follow Best Practices for writing compatible code
3. Use the Code Review Checklist before deployment

For Troubleshooting

1. Check Error Messages for common issues
2. Review Workarounds for unsupported features
3. Consult Support and Feedback for help

🔍 Document Status

Document	Language	Status	Last Updated
Compatibility Guide	English	✅ Complete	2025-05-31
兼容性文档	中文	✅ Complete	2025-05-31

📝 Contributing to Documentation

We welcome contributions to improve our documentation:

1. Report Issues: Found an error or missing information? Please open an issue.
2. Suggest Improvements: Have ideas for better explanations? We'd love to hear them.
3. Add Examples: More code examples are always helpful.
4. Translate: Help us provide documentation in more languages.

🚀 Getting Started

If you're new to the GaussDB Rust driver, we recommend:

1. Read the compatibility documentation to understand the differences from PostgreSQL
2. Set up your development environment with OpenGauss or GaussDB
3. Run the test suite to verify your setup
4. Start with simple examples before moving to complex use cases

📞 Support

• GitHub Issues: Report bugs or request features
• Discussions: Join community discussions
• Email: Contact maintainers directly for urgent issues

---

Documentation maintained by the GaussDB Rust Driver Team
Last updated: May 31, 2025