fix: align doc with code (by LLM) #679
Conversation
There was a problem hiding this comment.
@wcy-fdu please help go over the doc
There was a problem hiding this comment.
@wcy-fdu please help go over the doc
There was a problem hiding this comment.
@chenzl25 please help go over the doc
There was a problem hiding this comment.
@xxhZs please help go over the doc
There was a problem hiding this comment.
@xxhZs please help go over the doc
There was a problem hiding this comment.
@xxhZs please help go over the doc
There was a problem hiding this comment.
@wcy-fdu please help go over the doc
There was a problem hiding this comment.
@wcy-fdu please help go over the doc
| ### Common Issues and Solutions | ||
|
|
||
| 1. **CDC not enabled**: Ensure CDC is enabled at both database and table levels | ||
| 2. **SQL Server Agent not running**: CDC requires SQL Server Agent to be running | ||
| 3. **Permission errors**: Grant proper SELECT permissions on CDC tables | ||
| 4. **LSN gaps**: Monitor for LSN gaps that might indicate data loss | ||
| 5. **Cleanup job issues**: Ensure cleanup jobs are running to prevent CDC table bloat | ||
| 6. **Network connectivity**: Verify firewall rules and SQL Server port access | ||
| 7. **Authentication issues**: Check SQL Server authentication mode and user permissions | ||
|
|
||
| ### Performance Considerations | ||
|
|
||
| - **Change table cleanup**: Ensure cleanup jobs are running regularly | ||
| - **Index maintenance**: Maintain indexes on source tables for better CDC performance | ||
| - **Monitoring**: Monitor CDC table sizes and cleanup job execution | ||
| - **Resource allocation**: Allocate sufficient resources for capture jobs | ||
|
|
||
| ## Limitations | ||
|
|
||
| - **System tables**: CDC cannot be enabled on system tables | ||
| - **Memory-optimized tables**: CDC is not supported on memory-optimized tables | ||
| - **Filestream columns**: Limited support for FILESTREAM columns | ||
| - **Computed columns**: CDC captures computed column values, not the computation logic | ||
| - **Encrypted columns**: Encrypted columns may require additional configuration | ||
| - **Multiple capture instances**: RisingWave randomly selects one if multiple exist |
There was a problem hiding this comment.
Personally I think such bullet list generated by LLM is of really poor quality and should not go into the documentation of a serious data infra product. Phrases like "limited support", "may require" offer almost nothing helpful but only lead to confusion for users.
There was a problem hiding this comment.
You are absolutely right! :doge:
We need to ensure that common issues are accompanied by specific, actionable examples. If we cannot provide clear guidance or examples, this section may not need to exist.
|
|
||
| #### Option 1: Native PostgreSQL Connector (Recommended for PostgreSQL-specific features) | ||
|
|
||
| Use the native PostgreSQL connector for better performance and PostgreSQL-specific features: |
There was a problem hiding this comment.
| Use the native PostgreSQL connector for better performance and PostgreSQL-specific features: | |
| Use the native PostgreSQL connector for PostgreSQL-specific features: |
Performance for JDBC and PG native sink is actually comparable. I think we need to rewrite this in a way that highlights we are sunsetting JDBC sink (in a backwards-compatible way). You can remove the changes to this file first, and assign another documentation issue to me to update it.
There was a problem hiding this comment.
I think we need to rewrite this in a way that highlights we are sunsetting JDBC sink (in a backwards-compatible way).
Oh really? Then we need dedicated connectors for each jdbc compatible downstream?
3 participants
Description
[ Please provide a brief summary of the documentation changes and purpose. ]
I let LLM check the latest code for each connector, and automatically update doc
Related code PR
[ Link to the related code pull request (if any). ]
Related doc issue
[ Link to the related documentation issue or task (if any). ]
Fix [ Provide the link to the doc issue here. ]
Checklist
mint.jsonto include the page in the table of contents.