Skip to content

Commit

Permalink
Update java_object_graph_guide.md (#987)
Browse files Browse the repository at this point in the history
  • Loading branch information
chaokunyang committed Oct 7, 2023
1 parent 7843c67 commit c1d0a11
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/guide/java_object_graph_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,8 +345,12 @@ if(JavaSerializer.serializedByJDK(bytes)){

### Upgrade fury
Currently binary compatibility is ensured for minor versions only. For example, if you are using fury`v0.2.0`, binary compatibility will
be provided if you upgrade to fury `v0.2.1`. But if upgrade to fury `v0.3.0`, no binary compatibility are ensured. In order to not
break binary compatibility, you need to write fury version as header to serialized data using following code:
be provided if you upgrade to fury `v0.2.1`. But if upgrade to fury `v0.3.0`, no binary compatibility are ensured.
Most of the time there is no need to upgrade fury to newer major version, the current version is fast and compact enough,
and we provide some minor fix for recent older versions.

But if you do want to upgrade fury for better performance and smaller size, you need to write fury version as header to serialized data
using code like following to keep binary compatibility:
```java
MemoryBuffer buffer = xxx;
buffer.writeVarInt(2);
Expand Down

0 comments on commit c1d0a11

Please sign in to comment.