Skip to content

Commit 6c63e45

Browse files
authored
Update 10-compatibility.md
1 parent 2af459f commit 6c63e45

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

docs/en/guides/10-deploy/02-upgrade/10-compatibility.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -114,26 +114,34 @@ History versions that are not included in the above chart:
114114

115115
<img src="/img/deploy/compatibility.excalidraw.png"/>
116116

117-
## Compatibility between databend-query
118-
119-
| Query version | Backward compatible with |
120-
|:-------------------|:--------------------------|
121-
| [-∞, 1.2.307) | [-∞, 1.2.311) |
122-
| [1.2.307, 1.2.311) | [-∞, 1.2.311) |
123-
| [1.2.311, +∞) | [1.2.307, +∞) |
124-
125-
Since 1.2.307, support deseriazlie Role info with pb and json but only support serialize Role info to json.
126-
127-
Since 1.2.311, only support seriazlie Role info to pb.
128-
129-
Prevents the query node that is not successfully upgraded from reading data due to operations on the role during rolling upgrade. You are advised to upgrade to 1.2.307 and then 1.2.311.
130-
131-
For example, Current Version is 1.2.306 upgrade to 1.2.312:
132-
133-
```
134-
1.2.307 -> 1.2.311 -> 1.2.312
135-
136-
```
117+
# Compatibility between databend-query
118+
119+
## Version Compatibility Matrix
120+
121+
| Query version | Backward compatible with | Key Changes |
122+
|:-------------------|:--------------------------|:------------|
123+
| [-∞, 1.2.307) | [-∞, 1.2.311) | Original format |
124+
| [1.2.307, 1.2.311) | [-∞, 1.2.311) | Added Role info with PB/JSON support |
125+
| [1.2.311, 1.2.709) | [1.2.307, +∞) | Role info serialized to PB only |
126+
| [1.2.709, +∞) | [1.2.709, +∞) | **Important**: Fuse storage path changed |
127+
128+
## Important Changes & Upgrade Instructions
129+
130+
### Version 1.2.307
131+
- Support deserialize Role info with PB and JSON
132+
- Only support serialize Role info to JSON
133+
- **Upgrade to this version first** if you're on an earlier version
134+
135+
### Version 1.2.311
136+
- Only support serialize Role info to PB
137+
- **Upgrade to this version next** after reaching 1.2.307
138+
- Example upgrade path: `1.2.306 -> 1.2.307 -> 1.2.311 -> 1.2.312`
139+
140+
### Version 1.2.709
141+
- **Important Change**: Fuse storage path modified
142+
- ⚠️ Versions before 1.2.709 may not be able to read some data from versions 1.2.709+
143+
- ⚠️ **Recommendation**: All nodes under the same tenant should be upgraded together
144+
- Avoid mixing nodes with versions before and after 1.2.709 to prevent potential data access issues
137145

138146
## Compatibility between databend-meta
139147

0 commit comments

Comments
 (0)