Skip to content

Commit 63f5f45

Browse files
committed
Reorder and polish change log for 1.0.0 release
Signed-off-by: Boxuan Li <liboxuan@connect.hku.hk>
1 parent ff60577 commit 63f5f45

File tree

1 file changed

+47
-53
lines changed

1 file changed

+47
-53
lines changed

docs/changelog.md

Lines changed: 47 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -114,17 +114,59 @@ See [this](https://tinkerpop.apache.org/docs/current/upgrade/#_creation_of_new_g
114114
GraphSON serializers are renamed, e.g. from `org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV3d0` to `org.apache.tinkerpop.gremlin.util.ser.GraphSONMessageSerializerV3`.
115115
See [this](https://tinkerpop.apache.org/docs/current/upgrade/#_serializer_renaming) for more detail.
116116

117-
##### String vertex ID support
117+
##### String vertex ID support (breaking change)
118118

119119
Users now can use custom string vertex ids. See [Custom Vertex ID](advanced-topics/custom-vertex-id.md) documentation. Prior
120120
to this change, JanusGraph automatically casts IDs of string type to long type if possible. Now this
121121
auto conversion is disabled. If you have a vertex with ID 1234, `g.V("1234")` would no longer help you
122122
find the vertex - you would have to do `g.V(1234)` now.
123123

124+
This feature brings about a breaking change to GraphBinary serializer. As such, users who use [GraphBinary](https://tinkerpop.apache.org/docs/3.7.0/dev/io/#graphbinary)
125+
serialization format must update JanusGraph server and all clients at once, since the change is backward
126+
incompatible.
127+
128+
!!! warning
129+
Even if you don't enable string vertex id feature, you are still impacted as long as you
130+
use GraphBinary serializer.
131+
132+
##### Upgrade of log4j to version 2
133+
134+
This change requires a new log4j configuration. You can find an example configuration in `conf/log4j2-server.xml`. As a result of the changed configuration format,
135+
we clean up all configurations. This could lead to unexpected new log lines. Please open an issue, if you see any unwanted log line.
136+
137+
!!! note
138+
Log4j is only used for standalone server deployments and JanusGraph testing.
139+
140+
##### Removal of cassandra-all dependency
141+
142+
JanusGraph had a dependency on cassandra-all only for some Hadoop-related classes. We moved these few classes into
143+
a new module cassandra-hadoop-util to reduce the dependencies of JanusGraph. If you are running embedded JanusGraph with
144+
Cassandra, you have to exclude the `cassandra-hadoop-util` from `janusgraph-cql`.
145+
146+
##### Drop support for HBase 1
147+
148+
We are dropping support for HBase 1.
149+
150+
##### Drop support for Solr 7
151+
152+
We are dropping support for Solr 7.
153+
154+
##### Drop support for Gryo MessageSerializer
155+
156+
Support for Gryo MessageSerializer [has been dropped in TinkerPop 3.6.0](https://tinkerpop.apache.org/docs/3.6.1/upgrade/#_removed_gryo_messageserializers)
157+
and we therefore also no longer support it in JanusGraph.
158+
GraphBinary is now used as the default MessageSerializer.
159+
160+
##### Remove support for old serialization format of JanusGraph predicates
161+
162+
We are dropping support for old serialization format of JanusGraph predicates. The old predicates serialization format is only used by client older than 0.6.
163+
The change only affects GraphSON.
164+
124165
##### New index management
125166

126167
The index management has received an overhaul which enables proper index removal.
127-
The schema action `REMOVE_INDEX` is no longer available and has been replaced by `DISCARD_INDEX`.
168+
The schema action `REMOVE_INDEX` is no longer available and has been replaced by `DISCARD_INDEX`. See
169+
[Index Lifecycle](schema/index-management/index-lifecycle.md) documentation for more details.
128170

129171
##### `totals` for direct index queries now applies provided offset and limit
130172

@@ -161,34 +203,6 @@ JanusGraph now officially supports Java 11 in addition to Java 8. We encourage e
161203
!!! note
162204
The pre-packaged distribution now requires Java 11.
163205

164-
##### Upgrade of log4j to version 2
165-
166-
This change requires a new log4j configuration. You can find an example configuration in `conf/log4j2-server.xml`. As a result of the changed configuration format,
167-
we clean up all configurations. This could lead to unexpected new log lines. Please open an issue, if you see any unwanted log line.
168-
169-
!!! note
170-
Log4j is only used for standalone server deployments and JanusGraph testing.
171-
172-
##### Removal of cassandra-all dependency
173-
174-
JanusGraph had a dependency on cassandra-all only for some Hadoop-related classes. We moved these few classes into
175-
a new module cassandra-hadoop-util to reduce the dependencies of JanusGraph. If you are running JanusGraph with
176-
an embeded Cassandra, you have to exclude the `cassandra-hadoop-util` from `janusgraph-cql`.
177-
178-
##### Drop support for HBase 1
179-
180-
We are dropping support for HBase 1.
181-
182-
##### Drop support for Solr 7
183-
184-
We are dropping support for Solr 7.
185-
186-
##### Drop support for Gryo MessageSerializer
187-
188-
Support for Gryo MessageSerializer [has been dropped in TinkerPop 3.6.0](https://tinkerpop.apache.org/docs/3.6.1/upgrade/#_removed_gryo_messageserializers)
189-
and we therefore also no longer support it in JanusGraph.
190-
GraphBinary is now used as the default MessageSerializer.hb
191-
192206
##### Batch Processing enabled by default. Configuration changes.
193207

194208
`query.batch` is now a configuration namespace. Thus, previous `query.batch` configuration is replaced by `query.batch.enabled`.
@@ -251,22 +265,7 @@ deep, it could result for some vertices to be re-fetched again which would mean
251265
In such situations `closest_repeat_parent` mode might be more preferable than `all_repeat_parents`.
252266
With `closest_repeat_parent` mode vertices for batch registration will be received from the start of the closest
253267
`repeat` step as well as the end of the closest `repeat` step (for the next iteration). Any other parent `repeat` steps
254-
will be ignored.
255-
256-
##### Breaking change for Geoshape GraphBinary serialization
257-
258-
Support for the [GraphBinary](http://tinkerpop.apache.org/docs/3.6.1/dev/io/#graphbinary) serialization format was
259-
added in JanusGraph 0.6.0. This also included support to serialize Geoshapes via GraphBinary. The implementation of the
260-
Geoshape serializer was unfortunately closely tied to the Java library `Spatial4j` that we are using to implement
261-
Geoshapes in Java. This made it very complicated to add support for GraphBinary in other languages than Java. To make
262-
it easier to support GraphBinary in non-Java environments like .NET, we have completely reimplemented the GraphBinary
263-
serialization of Geoshapes in this version.
264-
265-
This is a breaking change for users who have already adopted GraphBinary and who are using Geoshapes. It is necessary
266-
to update JanusGraph Server and all (Java) clients that use GraphBinary at the same time since JanusGraph Server with
267-
an older version will not be able to read a Geoshape created by a client that is already on version 1.0.0 and vice
268-
versa.
269-
Users who do not use GraphBinary yet or who are not using Geoshapes are not affected by this change.
268+
will be ignored.
270269

271270
##### ConfiguredGraphFactory now creates separate indices per graph in Elasticsearch
272271

@@ -279,11 +278,6 @@ CQL keyspace name for example.
279278
Users who don't want to use this feature can simply continue providing the index name via `index.[X].index-name` in the
280279
template configuration.
281280

282-
##### Remove support for old serialization format of JanusGraph predicates
283-
284-
We are dropping support for old serialization format of JanusGraph predicates. The old predicates serialization format is only used by client older than 0.6.
285-
The change only affects GraphSON.
286-
287281
##### Mixed index aggregation optimization
288282

289283
A new optimization has been added to compute aggregations (min, max, sum and avg) using mixed index engine (if the aggregation function follows an indexed query).
@@ -397,7 +391,7 @@ See additional properties to control grouping configurations under the namespace
397391
* RemovableRelationIterator class
398392
* ImmutableConfiguration class
399393

400-
### Version 0.6.4 (Release Date: ???)
394+
### Version 0.6.4 (Release Date: October 14, 2023)
401395

402396
```xml tab='Maven'
403397
<dependency>
@@ -419,7 +413,7 @@ compile "org.janusgraph:janusgraph-core:0.6.4"
419413
* Elasticsearch 6.0.1, 6.6.0, 7.14.0
420414
* Apache Lucene 8.9.0
421415
* Apache Solr 7.7.2, 8.11.0
422-
* Apache TinkerPop 3.5.5
416+
* Apache TinkerPop 3.5.7
423417
* Java 1.8
424418

425419
#### Changes

0 commit comments

Comments
 (0)