From b76dd342b4b427c57bb8e71265d562bc44813187 Mon Sep 17 00:00:00 2001 From: Mikita Hradovich Date: Thu, 13 Aug 2026 14:12:54 +0200 Subject: [PATCH] docs: point 3.x readers at the 4.x migration guide The 3.x tree tells a reader to consult its own upgrade guide for moving between 3.x versions, and says nothing about moving off 3.x altogether. Add that route in the two places a reader looks: the README, which is also the docs landing page (docs/source/index.md symlinks to it), and the top of the 3.x upgrade guide. The 3.x-to-4.x guide itself already exists as the 4.0.0 section of the upgrade guide on scylla-4.x, published at /stable/upgrade_guide/, so this links to it rather than restating it. What is worth stating here is the artifact rename, which is the first thing that stops a 3.x build from resolving. Note that this reaches readers of this branch on GitHub, not the documentation site: scylla-3.x is not a published doc version -- no branch's BRANCHES list contains it, and /scylla-3.x/ is a 404. The site-visible notice ships separately, from the publishing branch. Co-Authored-By: Claude Opus 5 (1M context) --- README.md | 13 +++++++++++++ upgrade_guide/README.md | 4 ++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index 5ea20557f82..344e4b86a1e 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,20 @@ big-endian systems, but _Scylla_ does not officially support these systems. If you are upgrading from a previous version of the driver, be sure to have a look at the [upgrade guide](/upgrade_guide/). +## Migrating to Java Driver 4.x +Java Driver 3.x is in maintenance mode and receives critical bug fixes only. New projects and +active development should use [Java Driver 4.x](https://github.com/scylladb/java-driver/tree/scylla-4.x). + +The [4.x migration guide](https://java-driver.docs.scylladb.com/stable/upgrade_guide/) covers the +API changes in detail. The first thing to change is the dependency: the artifacts are renamed, while +the `com.scylladb` group id stays the same. + +| Driver 3.x | Driver 4.x | +|---|---| +| `scylla-driver-core` | `java-driver-core`, plus `java-driver-query-builder` if you use the query builder | +| `scylla-driver-mapping` | `java-driver-mapper-runtime`, plus the `java-driver-mapper-processor` annotation processor | +| `scylla-driver-extras` | no counterpart; its codecs are either native to 4.x core or covered by its custom-codec support | ## License © DataStax, Inc. diff --git a/upgrade_guide/README.md b/upgrade_guide/README.md index 6a413a7f547..1adaabcf7b2 100644 --- a/upgrade_guide/README.md +++ b/upgrade_guide/README.md @@ -3,6 +3,10 @@ The purpose of this guide is to detail changes made by successive versions of the Java driver. +Note that Java Driver 3.x is in maintenance mode and receives critical bug fixes only. If you are +moving to Java Driver 4.x rather than between 3.x versions, see the +[4.x migration guide](https://java-driver.docs.scylladb.com/stable/upgrade_guide/) instead. + ### 3.6.0 1. `ConsistencyLevel.LOCAL_SERIAL.isDCLocal()` now returns true. In driver