Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ streaming, forward-only result sets over ClickHouse SQL.
> [Arrow Java getting-started guide](chdb-arrow/README.md#getting-started) for examples
> and [What works today](#what-works-today) for the JDBC release status.

The [1.1.0 release notes and Central installation guide](docs/releases/1.1.0.md) describe the
planned stable coordinates. They do not mean Portal publication has completed; the RC
instructions below remain available while the stable release is being prepared.

```java
try (Connection connection = DriverManager.getConnection("jdbc:chdb::memory:");
PreparedStatement statement = connection.prepareStatement(
Expand Down
4 changes: 4 additions & 0 deletions chdb-arrow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ This module README is the Java binding's Arrow entry point. See the [core owners

## Getting started

For the planned stable `1.1.0` version, see the
[Maven Central installation guide](../docs/releases/1.1.0.md#optional-arrow-support).
Those coordinates require completed Central publication; the existing RC instructions follow.

`chdb-arrow` is published as `1.1.0-rc.1` at `https://maven.chdb.io`. The older
`1.0.0-rc.2` native packages cannot run this Arrow module: keep all binding
artifacts on the same version. Add the public repository (no credentials required):
Expand Down
52 changes: 41 additions & 11 deletions docs/release-readiness.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,53 @@ Java 11 on macOS ARM64 resolved the published coordinates and returned JDBC
contained no Arrow dependency. These are technical consumption checks, not reports from
two independent external projects or a long-running concurrent soak.

The local release-preparation branch changes the reactor version to `1.1.0`; this does not
mean that version is tagged, uploaded, approved or published. The engine, JNI ABI and Java
API version properties are unchanged. Before a stable tag or upload:

- Obtain the written engine-redistribution decision required by step 5 below.
- Complete the two-external-project gate and a current-engine concurrent soak, or record an
explicit release-owner decision about those gates. The historical 75-minute soak on the
old `feat/concurrent-soak` branch used an older engine and is not evidence for this release.
PR #47 merged the reactor version `1.1.0` at `30e3bd5ca53ff5f530346983dbfedd5b94cba8dd`.
The source-branch build `44410639227` passed, but merged-commit build `44414628416` passed
13 of 14 jobs: Linux x86_64 failed before compilation while resolving
`org.junit:junit-bom:5.10.2` from Central. An independent GET of that exact POM now returns
HTTP 200; the original runner-side failure cause remains unconfirmed. The owner confirmed a
failed-job rerun, and attempt 2 is in progress on the same commit. Its Java compilation has
passed the previous failure point; the complete result is still required.

The version change does not mean `1.1.0` is tagged, uploaded or published. The engine,
JNI ABI and Java API version properties are unchanged. Before a stable tag or upload:

- The release owner provided the project redistribution authorization recorded below.
Preserve the required licenses and notices; this is not a claim of legal review.
- The release owner explicitly waived the two-external-project acceptance gate and the
current-engine concurrent-soak gate for `1.1.0` on 2026-11-19. These are waived, not passed.
The historical 75-minute soak on the old `feat/concurrent-soak` branch used an older engine
and is not evidence for this release.
- Protect `v*` against update and deletion. The repository currently exposes only the active
branch ruleset `Need PR`; no active tag ruleset was found.
- Recheck the ClickHouse workspace's current Usage Center. The browser session is signed
out, so the earlier `888/1000` file-count observation is not a fresh quota check.
- Finish release notes and stable installation documentation, then obtain successful
four-platform CI for the exact release commit before creating its matching tag.
- [Release notes and stable installation instructions](releases/1.1.0.md) are prepared.
Obtain successful four-platform CI for the exact final release commit before creating
its matching tag; successful CI on an earlier commit does not satisfy that check.

The existing one-week RC-window waiver and deferral of environment reviewers/admin-bypass
settings remain unchanged. No additional gate was waived by this preparation.
settings remain unchanged. Apart from the two acceptance-gate waivers recorded above, no
additional gate was waived. Internal project redistribution authorization is now confirmed,
not waived. Stable-tag push, Central upload and Portal Publish still require separate
per-operation confirmation.

### Release-owner redistribution authorization — 2026-11-19

Shawn Chen explicitly confirmed the following scope for this release:

> 我作为 chDB 项目的授权负责人,批准 chdb-java `1.1.0` 捆绑并再分发官方 chdb-core
> `26.11.1` 的四平台引擎,通过 ClickHouse Central 组织发布到 `com.clickhouse.chdb`,
> 并保留应随包提供的许可证和 notices。

This is project-owner authorization, not a legal-opinion or legal-review claim. Inspection
of all four downloaded snapshot native JARs found `META-INF/licenses/README.txt`,
`LICENSE-chdb-java.txt`, `engine-third-party.tsv`, and `META-INF/sbom/bom.json`.
All four bundled inventories match the committed `26.11.1` inventory SHA-256
`8183a651f5e7f454b5048f99e9cca4ae487594cebbc181c94ac8c432496973ce`.
These checks establish presence and consistency, not an independent legal determination
that every third-party obligation has been discharged. Preserve and recheck these materials
in the actual stable artifacts rather than inferring their presence from the snapshot alone.

Local preparation validation passed all 12 release-tooling tests, 178 JDBC unit tests,
one Arrow unit test, and standalone `1.1.0` consumer-POM checks for all six modules on
Expand Down
110 changes: 110 additions & 0 deletions docs/releases/1.1.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# chdb-java 1.1.0

Release notes and Maven Central installation instructions for the first stable Java binding
release. Publication status and verification evidence are tracked in
[release readiness](../release-readiness.md); this document is not a publication receipt.
The `1.1.0` examples below require that version to have completed Central Portal publication.

## Release contents

- Binding version: `1.1.0`.
- Bundled engine: official chDB Core `26.11.1`, pinned by checksum.
- JNI ABI version: `5`; Java API version property: `1`.
- Java 11 or later; Java 11, 17, 21 and 25 are covered by the four-platform build matrix.
Java 26 is a forward-compatibility check, not an additional full platform matrix.
- JDBC provides row-oriented `ResultSet` access. The optional `chdb-arrow` module provides
Arrow batch input, typed results and bulk insertion; it remains experimental and does not
become a standard Java ADBC driver merely by being included in this release.

Six library coordinates are published under `com.clickhouse.chdb`: `chdb-jdbc`, `chdb-arrow`,
and the four native packages below. Consumer POMs are standalone; the internal parent and
BOM are not published to Central. Use one version property rather than importing a chDB BOM.
Keep the driver, optional Arrow module and native packages on the same binding version.

| Runtime platform | Native artifact ID |
| --- | --- |
| Linux x86_64, glibc | `chdb-native-linux-x86_64-gnu` |
| Linux aarch64, glibc | `chdb-native-linux-aarch64-gnu` |
| macOS x86_64 | `chdb-native-macos-x86_64` |
| macOS arm64 | `chdb-native-macos-aarch64` |

## Install from Maven Central

Declare the package for the platform running the JVM. It brings in `chdb-jdbc` transitively.
For example, on Linux x86_64:

```xml
<properties>
<chdb.version>1.1.0</chdb.version>
</properties>

<dependencies>
<dependency>
<groupId>com.clickhouse.chdb</groupId>
<artifactId>chdb-native-linux-x86_64-gnu</artifactId>
<version>${chdb.version}</version>
</dependency>
</dependencies>
```

Maven Central is Maven's default repository. Do not add `maven.chdb.io` or the Central
snapshot repository for this stable version. Native packages contain the engine, so their
downloads are large; no engine download is performed by the driver at runtime.

After resolving the dependency, a JDBC smoke test is:

```java
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;

try (Connection connection = DriverManager.getConnection("jdbc:chdb::memory:");
Statement statement = connection.createStatement();
ResultSet rows = statement.executeQuery(
"SELECT count(), sum(number) FROM numbers(1000)")) {
if (!rows.next() || rows.getLong(1) != 1000 || rows.getLong(2) != 499500) {
throw new AssertionError("Unexpected JDBC result");
}
System.out.println(connection.getMetaData().getDatabaseProductVersion());
}
```

The engine version should be `26.11.1`. The same test must be repeated against actual stable
Central downloads after publication; a successful source build or snapshot test is not that
post-publication check.

## Optional Arrow support

Keep the matching native dependency above and add:

```xml
<dependency>
<groupId>com.clickhouse.chdb</groupId>
<artifactId>chdb-arrow</artifactId>
<version>${chdb.version}</version>
</dependency>
```

For Arrow Java 19.0.0, run the JVM with
`--add-opens=java.base/java.nio=ALL-UNNAMED`. See the
[Arrow guide](../../chdb-arrow/README.md) for `ArrowSession`, batch ownership and close order.
JDBC-only consumers do not need the Arrow module or its dependencies.

## Compatibility and limitations

- A JVM may use multiple connections to one storage path, but not different storage paths
at the same time. Use separate JVMs when independent engine storage paths are needed.
- A connection executes one statement at a time; result sets are forward-only and read-only.
- Transactions, savepoints and unsupported JDBC operations are not emulated. Unsupported
operations throw `SQLFeatureNotSupportedException`; see [the JDBC scope](../unsupported.md).
- Windows, musl/Alpine Linux, 32-bit platforms, Android and GraalVM Native Image are not
supported. See the [support matrix](../../README.md#support-matrix) for OS and JVM details.
- Engine/driver compatibility checks remain enabled. Do not mix an older RC native package
with `1.1.0` Java modules or disable those checks as part of ordinary installation.

Native packages retain license information, the engine component inventory and a CycloneDX
SBOM in `META-INF/licenses/` and `META-INF/sbom/`. The release-owner redistribution decision
and the expressly waived RC-window, external-project acceptance and concurrent-soak gates
are recorded in [release readiness](../release-readiness.md). A waived gate is not a passed
test, and neither this document nor CI success is a legal-review claim.
Loading