From 3495e672dc627b743c1e4d900b0c5ec5d01d6fac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Manciot?= Date: Thu, 3 Sep 2026 22:51:39 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20reference=20the=200.22.0=20train=20?= =?UTF-8?q?=E2=80=94=20core=200.22.0,=20drivers/sidecar=200.3.1,=20install?= =?UTF-8?q?er=20pin=20v0.22.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Post-release documentation sweep for the 0.22.0 train (core 0.22.0 · extensions 0.3.1 · arrow 0.3.1 · jdbc 0.3.1 · repl bundle 0.22.0 · helm chart 0.3.7 / appVersion 0.3.1). Companion sweep in softclient4es-web. EVERY version written here was verified published on JFrog BEFORE it was written, not after: the four per-ES jdbc/adbc/arrow-flight-sql jars at 0.3.1 (12 × 200), and softclient4es-jdbc-driver_2.13 / community-extensions_2.13 / arrow-extensions_2.13 at 0.3.1 + softclient4es8-java-client_2.13 at 0.22.0. A version with no artefact fails SILENTLY here — an installer falls back to the plain jar, which carries no arrow extensions and therefore no cross-index JOIN, so the docs would demonstrate the path that loses the headline feature. Swept: README (driver table + Maven/Gradle/sbt coordinates + the Scala dependency block), documentation/client/{jdbc,adbc_driver,arrow_flight_sql}.md (jar tables + coordinates), documentation/client/repl.md (install examples), documentation/client/download_analytics.md (the example artefact version), install.ps1 (help example), install.cmd (help example + the pinned installer). install.cmd: PS1_REF v0.21.0 -> v0.22.0 AND PS1_SHA256 recomputed together, per the RELEASE RITUAL comment above them — a bumped tag with a stale hash is a hard failure for every install.cmd-only user. The new hash (6a31198e6817...de0ae5c4) is the SHA-256 of install.ps1 AT TAG v0.22.0. The method was validated first by recomputing v0.21.0's hash, which reproduced the currently-pinned e1275bd2...03912ae exactly. The file is CRLF by .gitattributes (-text): edited in BINARY mode, and the CRLF count is 165 before and after with zero bare LF — a text-mode rewrite silently converts the whole file and shows up as a 165-line diff. NOT bumped, deliberately — these date a feature's availability, they do not track the current version. Bumping them would tell a 0.21.0 user they lack a feature they have: - scroll.md:51,147,319 — sliced PIT "(0.21.0+)" / "Default since 0.21.0" - common_principles.md:491,538 — "Paged row extraction … 0.21.0+" - repl.md:54 — Windows Java bootstrap "Since 0.20.4" Note the `X+` spelling does NOT match a /since|before/ guard; the guard has to catch the family, not one wording. The captured `--list-versions` block in repl.md GAINED a line rather than being renamed: the sweep's first pass rewrote "• 0.21.0" to "• 0.22.0", which would have told users 0.21.0 no longer exists and left "Total: 5" stale. It is now re-captured for real — `bash install.sh --list-versions --es-version 8`, ANSI stripped — and the committed block is byte-identical to the live output (0.20.1 … 0.21.0, 0.22.0; Total: 6). --- README.md | 22 +++++++++++----------- documentation/client/adbc_driver.md | 14 +++++++------- documentation/client/arrow_flight_sql.md | 10 +++++----- documentation/client/download_analytics.md | 2 +- documentation/client/jdbc.md | 14 +++++++------- documentation/client/repl.md | 13 +++++++------ install.cmd | 6 +++--- install.ps1 | 2 +- 8 files changed, 42 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index cb64c39e..782b31d3 100644 --- a/README.md +++ b/README.md @@ -217,10 +217,10 @@ Download the self-contained fat JAR for your Elasticsearch version: | Elasticsearch Version | Artifact | |-----------------------|----------------------------------------| -| ES 6.x | `softclient4es6-jdbc-driver-0.3.0.jar` | -| ES 7.x | `softclient4es7-jdbc-driver-0.3.0.jar` | -| ES 8.x | `softclient4es8-jdbc-driver-0.3.0.jar` | -| ES 9.x | `softclient4es9-jdbc-driver-0.3.0.jar` | +| ES 6.x | `softclient4es6-jdbc-driver-0.3.1.jar` | +| ES 7.x | `softclient4es7-jdbc-driver-0.3.1.jar` | +| ES 8.x | `softclient4es8-jdbc-driver-0.3.1.jar` | +| ES 9.x | `softclient4es9-jdbc-driver-0.3.1.jar` | > **Java 11+ recommended** (17+ for ES 9.x): **cross-index JOINs require Java 11+** — the embedded JOIN engine is built on Apache Arrow 18.x, which ships Java-11 bytecode. @@ -237,20 +237,20 @@ Driver class: app.softnetwork.elastic.jdbc.ElasticDriver app.softnetwork.elastic softclient4es8-jdbc-driver - 0.3.0 + 0.3.1 ``` **Gradle:** ```groovy -implementation 'app.softnetwork.elastic:softclient4es8-jdbc-driver:0.3.0' +implementation 'app.softnetwork.elastic:softclient4es8-jdbc-driver:0.3.1' ``` **sbt:** ```scala -libraryDependencies += "app.softnetwork.elastic" % "softclient4es8-jdbc-driver" % "0.3.0" +libraryDependencies += "app.softnetwork.elastic" % "softclient4es8-jdbc-driver" % "0.3.1" ``` The JDBC driver JARs are Scala-version-independent (no `_2.12` or `_2.13` suffix) and include all required dependencies. @@ -339,13 +339,13 @@ For programmatic access, add SoftClient4ES to your project. resolvers += "Softnetwork" at "https://softnetwork.jfrog.io/artifactory/releases/" // Choose your Elasticsearch version -libraryDependencies += "app.softnetwork.elastic" %% "softclient4es8-java-client" % "0.21.0" +libraryDependencies += "app.softnetwork.elastic" %% "softclient4es8-java-client" % "0.22.0" // Add the community extensions for materialized views (optional) -libraryDependencies += "app.softnetwork.elastic" %% "softclient4es-community-extensions" % "0.3.0" +libraryDependencies += "app.softnetwork.elastic" %% "softclient4es-community-extensions" % "0.3.1" // Add the arrow extensions for cross-index JOIN (required for JOINs; Java 11+) -libraryDependencies += "app.softnetwork.elastic" %% "softclient4es-arrow-extensions" % "0.3.0" +libraryDependencies += "app.softnetwork.elastic" %% "softclient4es-arrow-extensions" % "0.3.1" // Add the JDBC driver if you want to use it from Scala (optional) -libraryDependencies += "app.softnetwork.elastic" %% "softclient4es-jdbc-driver" % "0.3.0" +libraryDependencies += "app.softnetwork.elastic" %% "softclient4es-jdbc-driver" % "0.3.1" ``` ```scala diff --git a/documentation/client/adbc_driver.md b/documentation/client/adbc_driver.md index 7a6db0c0..3e3ec67a 100644 --- a/documentation/client/adbc_driver.md +++ b/documentation/client/adbc_driver.md @@ -23,10 +23,10 @@ Download the self-contained fat JAR for your Elasticsearch version: | Elasticsearch | Artifact | |----------------|-----------------------------------------------------| -| ES 6.x | `softclient4es6-adbc-driver-0.3.0.jar` | -| ES 7.x | `softclient4es7-adbc-driver-0.3.0.jar` | -| ES 8.x | `softclient4es8-adbc-driver-0.3.0.jar` | -| ES 9.x | `softclient4es9-adbc-driver-0.3.0.jar` | +| ES 6.x | `softclient4es6-adbc-driver-0.3.1.jar` | +| ES 7.x | `softclient4es7-adbc-driver-0.3.1.jar` | +| ES 8.x | `softclient4es8-adbc-driver-0.3.1.jar` | +| ES 9.x | `softclient4es9-adbc-driver-0.3.1.jar` | ### Maven / Gradle / sbt @@ -36,20 +36,20 @@ Download the self-contained fat JAR for your Elasticsearch version: app.softnetwork.elastic softclient4es8-adbc-driver - 0.3.0 + 0.3.1 ``` **Gradle:** ```groovy -implementation 'app.softnetwork.elastic:softclient4es8-adbc-driver:0.3.0' +implementation 'app.softnetwork.elastic:softclient4es8-adbc-driver:0.3.1' ``` **sbt:** ```scala -libraryDependencies += "app.softnetwork.elastic" % "softclient4es8-adbc-driver" % "0.3.0" +libraryDependencies += "app.softnetwork.elastic" % "softclient4es8-adbc-driver" % "0.3.1" ``` --- diff --git a/documentation/client/arrow_flight_sql.md b/documentation/client/arrow_flight_sql.md index 22eb922c..e1fcd6f8 100644 --- a/documentation/client/arrow_flight_sql.md +++ b/documentation/client/arrow_flight_sql.md @@ -49,15 +49,15 @@ Available images per ES version: ### Fat JAR ```bash -java -jar softclient4es8-arrow-flight-sql-0.3.0.jar +java -jar softclient4es8-arrow-flight-sql-0.3.1.jar ``` | Elasticsearch | Artifact | |---------------|----------| -| ES 6.x | `softclient4es6-arrow-flight-sql-0.3.0.jar` | -| ES 7.x | `softclient4es7-arrow-flight-sql-0.3.0.jar` | -| ES 8.x | `softclient4es8-arrow-flight-sql-0.3.0.jar` | -| ES 9.x | `softclient4es9-arrow-flight-sql-0.3.0.jar` | +| ES 6.x | `softclient4es6-arrow-flight-sql-0.3.1.jar` | +| ES 7.x | `softclient4es7-arrow-flight-sql-0.3.1.jar` | +| ES 8.x | `softclient4es8-arrow-flight-sql-0.3.1.jar` | +| ES 9.x | `softclient4es9-arrow-flight-sql-0.3.1.jar` | --- diff --git a/documentation/client/download_analytics.md b/documentation/client/download_analytics.md index 096f8bb9..ad2009db 100644 --- a/documentation/client/download_analytics.md +++ b/documentation/client/download_analytics.md @@ -15,7 +15,7 @@ beacon to a public endpoint with exactly these fields: |---------------|----------|-----------------------------------------------| | `source` | `portal` | Where the count came from (the docs button) | | `driver` | `jdbc` | Which driver family (`jdbc` or `adbc`) | -| `version` | `0.3.0` | The published artifact version | +| `version` | `0.3.1` | The published artifact version | | `count_delta` | `1` | One download | A timestamp is added on the server. That is the **entire** record. diff --git a/documentation/client/jdbc.md b/documentation/client/jdbc.md index 73ac44b2..ef7383ad 100644 --- a/documentation/client/jdbc.md +++ b/documentation/client/jdbc.md @@ -20,10 +20,10 @@ Download the self-contained fat JAR for your Elasticsearch version. The JARs are | Elasticsearch | Artifact | |---------------|----------| -| ES 6.x | `softclient4es6-jdbc-driver-0.3.0.jar` | -| ES 7.x | `softclient4es7-jdbc-driver-0.3.0.jar` | -| ES 8.x | `softclient4es8-jdbc-driver-0.3.0.jar` | -| ES 9.x | `softclient4es9-jdbc-driver-0.3.0.jar` | +| ES 6.x | `softclient4es6-jdbc-driver-0.3.1.jar` | +| ES 7.x | `softclient4es7-jdbc-driver-0.3.1.jar` | +| ES 8.x | `softclient4es8-jdbc-driver-0.3.1.jar` | +| ES 9.x | `softclient4es9-jdbc-driver-0.3.1.jar` | ### Build Tool Integration @@ -33,20 +33,20 @@ Download the self-contained fat JAR for your Elasticsearch version. The JARs are app.softnetwork.elastic softclient4es8-jdbc-driver - 0.3.0 + 0.3.1 ``` **Gradle:** ```groovy -implementation 'app.softnetwork.elastic:softclient4es8-jdbc-driver:0.3.0' +implementation 'app.softnetwork.elastic:softclient4es8-jdbc-driver:0.3.1' ``` **sbt:** ```scala -libraryDependencies += "app.softnetwork.elastic" % "softclient4es8-jdbc-driver" % "0.3.0" +libraryDependencies += "app.softnetwork.elastic" % "softclient4es8-jdbc-driver" % "0.3.1" ``` --- diff --git a/documentation/client/repl.md b/documentation/client/repl.md index 4b73d7ff..f1d0deb9 100644 --- a/documentation/client/repl.md +++ b/documentation/client/repl.md @@ -162,7 +162,7 @@ unchanged — there is no second implementation to drift: ```bat install.cmd -ListVersions -EsVersion 8 -install.cmd -Target "C:\tools\softclient4es" -EsVersion 8 -Version 0.21.0 +install.cmd -Target "C:\tools\softclient4es" -EsVersion 8 -Version 0.22.0 install.cmd -EsVersion 9 -NoExtensions install.cmd -Help ``` @@ -216,8 +216,9 @@ install.cmd -ListVersions -EsVersion 8 • 0.20.3 • 0.20.4 • 0.21.0 + • 0.22.0 - Total: 5 version(s) + Total: 6 version(s) To install a specific version: ./install.sh --es-version 8 --version @@ -245,7 +246,7 @@ install.cmd -ListVersions -EsVersion 8 ./install.sh --list-versions --es-version 8 # Install specific version -./install.sh --es-version 8 --version 0.21.0 +./install.sh --es-version 8 --version 0.22.0 # Install for Elasticsearch 9 (requires Java 17+) ./install.sh --es-version 9 @@ -254,7 +255,7 @@ install.cmd -ListVersions -EsVersion 8 ./install.sh --target /opt/softclient4es # Full custom installation -./install.sh --target ~/tools/softclient4es --es-version 7 --version 0.21.0 +./install.sh --target ~/tools/softclient4es --es-version 7 --version 0.22.0 ``` #### Windows @@ -267,7 +268,7 @@ install.cmd -ListVersions -EsVersion 8 .\install.ps1 -ListVersions -EsVersion 8 # Install specific version -.\install.ps1 -EsVersion 8 -Version 0.21.0 +.\install.ps1 -EsVersion 8 -Version 0.22.0 # Install for Elasticsearch 9 (requires Java 17+) .\install.ps1 -EsVersion 9 @@ -276,7 +277,7 @@ install.cmd -ListVersions -EsVersion 8 .\install.ps1 -Target "C:\tools\softclient4es" # Full custom installation -.\install.ps1 -Target "C:\tools\softclient4es" -EsVersion 7 -Version 0.21.0 +.\install.ps1 -Target "C:\tools\softclient4es" -EsVersion 7 -Version 0.22.0 ``` --- diff --git a/install.cmd b/install.cmd index 46dab175..05be14d5 100644 --- a/install.cmd +++ b/install.cmd @@ -19,7 +19,7 @@ rem rem install.cmd rem install.cmd -ListVersions -EsVersion 8 rem install.cmd -Target "C:\tools\softclient4es" -EsVersion 8 -Version 1.0.0 -rem install.cmd -EsVersion 7 -Version 0.21.0 -NoExtensions +rem install.cmd -EsVersion 7 -Version 0.22.0 -NoExtensions rem install.cmd -Help rem rem Caveat worth knowing: -ExecutionPolicy Bypass is overridden when the policy @@ -53,8 +53,8 @@ rem The pinned hash belongs to the pinned tag, so overriding the ref drops the rem integrity check unless SOFTCLIENT4ES_INSTALL_SHA256 supplies another one - rem and says so when it does not. rem --------------------------------------------------------------------------- -set "PS1_REF=v0.21.0" -set "PS1_SHA256=e1275bd269c8bb922d28827b6c74e965bbe7b5139b4e16138bacaac7c03912ae" +set "PS1_REF=v0.22.0" +set "PS1_SHA256=6a31198e68170eaca9fb05b6418713c6f7669d08f7bf46e9ed9cc622de0ae5c4" rem One `if` per line, never a parenthesised block: cmd expands every %VAR% in a rem block in ONE parse pass, before running any line in it. diff --git a/install.ps1 b/install.ps1 index 8a403f0f..4fcb786b 100644 --- a/install.ps1 +++ b/install.ps1 @@ -63,7 +63,7 @@ Examples: .\install.ps1 .\install.ps1 -ListVersions -EsVersion 8 .\install.ps1 -Target "C:\tools\softclient4es" -EsVersion 8 -Version 1.0.0 - .\install.ps1 -EsVersion 7 -Version 0.21.0 -NoExtensions + .\install.ps1 -EsVersion 7 -Version 0.22.0 -NoExtensions "@ exit 0