From 385828ea31acbd9a6dc4d2734f2e85c56dbfcfc0 Mon Sep 17 00:00:00 2001 From: Sergey Chernov Date: Tue, 7 Apr 2026 14:31:01 -0700 Subject: [PATCH 1/6] Added some example code for work with Apache Arrow --- .../experimental/apache-arrow/.gitattributes | 12 + examples/experimental/apache-arrow/.gitignore | 5 + .../apache-arrow/build.gradle.kts | 50 ++++ .../apache-arrow/gradle.properties | 5 + .../apache-arrow/gradle/libs.versions.toml | 20 ++ .../gradle/wrapper/gradle-wrapper.properties | 7 + examples/experimental/apache-arrow/gradlew | 248 ++++++++++++++++++ .../experimental/apache-arrow/gradlew.bat | 93 +++++++ .../apache-arrow/settings.gradle.kts | 14 + .../clickhouse/adbc/ClickHouseAdbcDriver.java | 15 ++ .../com/clickhouse/adbc/ConnectionImpl.java | 24 ++ .../com/clickhouse/adbc/StatementImpl.java | 26 ++ .../example/arrow_server/AppArrowServer.java | 50 ++++ .../arrow_server/ServerDataProducer.java | 44 ++++ .../arrow_server/AppArrowServerTest.java | 14 + 15 files changed, 627 insertions(+) create mode 100644 examples/experimental/apache-arrow/.gitattributes create mode 100644 examples/experimental/apache-arrow/.gitignore create mode 100644 examples/experimental/apache-arrow/build.gradle.kts create mode 100644 examples/experimental/apache-arrow/gradle.properties create mode 100644 examples/experimental/apache-arrow/gradle/libs.versions.toml create mode 100644 examples/experimental/apache-arrow/gradle/wrapper/gradle-wrapper.properties create mode 100755 examples/experimental/apache-arrow/gradlew create mode 100644 examples/experimental/apache-arrow/gradlew.bat create mode 100644 examples/experimental/apache-arrow/settings.gradle.kts create mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ClickHouseAdbcDriver.java create mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ConnectionImpl.java create mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/StatementImpl.java create mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/AppArrowServer.java create mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/ServerDataProducer.java create mode 100644 examples/experimental/apache-arrow/src/test/java/com/clickhouse/example/arrow_server/AppArrowServerTest.java diff --git a/examples/experimental/apache-arrow/.gitattributes b/examples/experimental/apache-arrow/.gitattributes new file mode 100644 index 000000000..f91f64602 --- /dev/null +++ b/examples/experimental/apache-arrow/.gitattributes @@ -0,0 +1,12 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + +# Binary files should be left untouched +*.jar binary + diff --git a/examples/experimental/apache-arrow/.gitignore b/examples/experimental/apache-arrow/.gitignore new file mode 100644 index 000000000..1b6985c00 --- /dev/null +++ b/examples/experimental/apache-arrow/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/examples/experimental/apache-arrow/build.gradle.kts b/examples/experimental/apache-arrow/build.gradle.kts new file mode 100644 index 000000000..162250e25 --- /dev/null +++ b/examples/experimental/apache-arrow/build.gradle.kts @@ -0,0 +1,50 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * This generated file contains a sample Java application project to get you started. + * For more details on building Java & JVM projects, please refer to https://docs.gradle.org/9.2.1/userguide/building_java_projects.html in the Gradle documentation. + */ + +plugins { + // Apply the application plugin to add support for building a CLI application in Java. + application +} + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() +} + +dependencies { + // Use TestNG framework, also requires calling test.useTestNG() below + testImplementation(libs.testng) + + // This dependency is used by the application. + // Source: https://mvnrepository.com/artifact/org.apache.arrow/arrow-bom + implementation(platform(libs.arrowBom)) + implementation(libs.arrowVector) + implementation(libs.arrowMemory) + implementation(libs.flightCore) + implementation(libs.slf4jSimple) + implementation(libs.slf4jApi) + implementation(libs.adbcCore) + + implementation(libs.guava) +} + +// Apply a specific Java toolchain to ease working on different environments. +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +application { + // Define the main class for the application. + mainClass = "org.example.App" +} + +tasks.named("test") { + // Use TestNG for unit tests. + useTestNG() +} diff --git a/examples/experimental/apache-arrow/gradle.properties b/examples/experimental/apache-arrow/gradle.properties new file mode 100644 index 000000000..377538c99 --- /dev/null +++ b/examples/experimental/apache-arrow/gradle.properties @@ -0,0 +1,5 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties + +org.gradle.configuration-cache=true + diff --git a/examples/experimental/apache-arrow/gradle/libs.versions.toml b/examples/experimental/apache-arrow/gradle/libs.versions.toml new file mode 100644 index 000000000..f5a0e51a5 --- /dev/null +++ b/examples/experimental/apache-arrow/gradle/libs.versions.toml @@ -0,0 +1,20 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format + +[versions] +guava = "33.4.6-jre" +testng = "7.5.1" +arrowBom = "19.0.0" +adbc = "0.22.0" +slf4j = "2.0.17" + +[libraries] +guava = { module = "com.google.guava:guava", version.ref = "guava" } +testng = { module = "org.testng:testng", version.ref = "testng" } +arrowBom = {module = "org.apache.arrow:arrow-bom", version.ref = "arrowBom"} +arrowVector = {module = "org.apache.arrow:arrow-vector"} +arrowMemory = {module = "org.apache.arrow:arrow-memory-netty"} +flightCore = {module = "org.apache.arrow:flight-core"} +slf4jSimple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4j"} +slf4jApi = { module = "org.slf4j:slf4j-api", version.ref = "slf4j"} +adbcCore = { module = "org.apache.arrow.adbc:adbc-core", version.ref = "adbc"} \ No newline at end of file diff --git a/examples/experimental/apache-arrow/gradle/wrapper/gradle-wrapper.properties b/examples/experimental/apache-arrow/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..23449a2b5 --- /dev/null +++ b/examples/experimental/apache-arrow/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/experimental/apache-arrow/gradlew b/examples/experimental/apache-arrow/gradlew new file mode 100755 index 000000000..adff685a0 --- /dev/null +++ b/examples/experimental/apache-arrow/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/experimental/apache-arrow/gradlew.bat b/examples/experimental/apache-arrow/gradlew.bat new file mode 100644 index 000000000..c4bdd3ab8 --- /dev/null +++ b/examples/experimental/apache-arrow/gradlew.bat @@ -0,0 +1,93 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/experimental/apache-arrow/settings.gradle.kts b/examples/experimental/apache-arrow/settings.gradle.kts new file mode 100644 index 000000000..ab40df1d3 --- /dev/null +++ b/examples/experimental/apache-arrow/settings.gradle.kts @@ -0,0 +1,14 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * For more detailed information on multi-project builds, please refer to https://docs.gradle.org/9.2.1/userguide/multi_project_builds.html in the Gradle documentation. + */ + +plugins { + // Apply the foojay-resolver plugin to allow automatic download of JDKs + id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0" +} + +rootProject.name = "ch-java-apache-arrow" + diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ClickHouseAdbcDriver.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ClickHouseAdbcDriver.java new file mode 100644 index 000000000..26fef6ebf --- /dev/null +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ClickHouseAdbcDriver.java @@ -0,0 +1,15 @@ +package com.clickhouse.adbc; + +import org.apache.arrow.adbc.core.AdbcDatabase; +import org.apache.arrow.adbc.core.AdbcDriver; +import org.apache.arrow.adbc.core.AdbcException; + +import java.util.Map; + +public class ClickHouseAdbcDriver implements AdbcDriver { + + @Override + public AdbcDatabase open(Map map) throws AdbcException { + return null; + } +} diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ConnectionImpl.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ConnectionImpl.java new file mode 100644 index 000000000..db2ce499c --- /dev/null +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ConnectionImpl.java @@ -0,0 +1,24 @@ +package com.clickhouse.adbc; + +import org.apache.arrow.adbc.core.AdbcConnection; +import org.apache.arrow.adbc.core.AdbcException; +import org.apache.arrow.adbc.core.AdbcStatement; +import org.apache.arrow.vector.ipc.ArrowReader; +import org.checkerframework.checker.nullness.qual.Nullable; + +public class ConnectionImpl implements AdbcConnection { + @Override + public AdbcStatement createStatement() throws AdbcException { + return null; + } + + @Override + public ArrowReader getInfo(int @Nullable [] ints) throws AdbcException { + return null; + } + + @Override + public void close() throws Exception { + + } +} diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/StatementImpl.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/StatementImpl.java new file mode 100644 index 000000000..a74f821c2 --- /dev/null +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/StatementImpl.java @@ -0,0 +1,26 @@ +package com.clickhouse.adbc; + +import org.apache.arrow.adbc.core.AdbcException; +import org.apache.arrow.adbc.core.AdbcStatement; + +public class StatementImpl implements AdbcStatement { + @Override + public QueryResult executeQuery() throws AdbcException { + return null; + } + + @Override + public UpdateResult executeUpdate() throws AdbcException { + return null; + } + + @Override + public void prepare() throws AdbcException { + + } + + @Override + public void close() throws Exception { + + } +} diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/AppArrowServer.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/AppArrowServer.java new file mode 100644 index 000000000..f3203bc56 --- /dev/null +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/AppArrowServer.java @@ -0,0 +1,50 @@ +/* + * This source file was generated by the Gradle 'init' task + */ +package com.clickhouse.example.arrow_server; + +import org.apache.arrow.flight.FlightServer; +import org.apache.arrow.flight.Location; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class AppArrowServer { + + private static final Logger LOG = LoggerFactory.getLogger(AppArrowServer.class); + + final FlightServer flightServer; + final Location location; + + + AppArrowServer() { + + location = Location.forGrpcInsecure("0.0.0.0", 33333); + flightServer = FlightServer.builder() + .location(location) + .build(); + } + + + void start() { + try { + flightServer.start(); + } catch (Exception e) { + LOG.error("failed to start flight server at location " + location, e); + } + + LOG.info("Flight server started at {}", location); + + try { + flightServer.awaitTermination(); + } catch (InterruptedException e) { + LOG.info("Process was interrupted"); + } + } + + public static void main(String[] args) { + AppArrowServer appServer = new AppArrowServer(); + + + appServer.start(); + } +} diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/ServerDataProducer.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/ServerDataProducer.java new file mode 100644 index 000000000..6e4d8b39c --- /dev/null +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/ServerDataProducer.java @@ -0,0 +1,44 @@ +package com.clickhouse.example.arrow_server; + +import org.apache.arrow.flight.Action; +import org.apache.arrow.flight.ActionType; +import org.apache.arrow.flight.Criteria; +import org.apache.arrow.flight.FlightDescriptor; +import org.apache.arrow.flight.FlightInfo; +import org.apache.arrow.flight.FlightProducer; +import org.apache.arrow.flight.FlightStream; +import org.apache.arrow.flight.PutResult; +import org.apache.arrow.flight.Result; +import org.apache.arrow.flight.Ticket; + +public class ServerDataProducer implements FlightProducer { + @Override + public void getStream(CallContext context, Ticket ticket, ServerStreamListener listener) { + + } + + @Override + public void listFlights(CallContext context, Criteria criteria, StreamListener listener) { + + } + + @Override + public FlightInfo getFlightInfo(CallContext context, FlightDescriptor descriptor) { + return null; + } + + @Override + public Runnable acceptPut(CallContext context, FlightStream flightStream, StreamListener ackStream) { + return null; + } + + @Override + public void doAction(CallContext context, Action action, StreamListener listener) { + + } + + @Override + public void listActions(CallContext context, StreamListener listener) { + + } +} diff --git a/examples/experimental/apache-arrow/src/test/java/com/clickhouse/example/arrow_server/AppArrowServerTest.java b/examples/experimental/apache-arrow/src/test/java/com/clickhouse/example/arrow_server/AppArrowServerTest.java new file mode 100644 index 000000000..58aa75a87 --- /dev/null +++ b/examples/experimental/apache-arrow/src/test/java/com/clickhouse/example/arrow_server/AppArrowServerTest.java @@ -0,0 +1,14 @@ +/* + * This source file was generated by the Gradle 'init' task + */ +package com.clickhouse.example.arrow_server; + +import org.testng.annotations.*; +import static org.testng.Assert.*; + +public class AppArrowServerTest { + @Test public void appHasAGreeting() { + AppArrowServer classUnderTest = new AppArrowServer(); + assertNotNull(classUnderTest.getGreeting(), "app should have a greeting"); + } +} From eb55478f8a4feb9293d9f2c64e7945752f97d46a Mon Sep 17 00:00:00 2001 From: Sergey Chernov Date: Tue, 7 Apr 2026 18:50:38 -0700 Subject: [PATCH 2/6] removed ADBC part as out of scope --- .../clickhouse/adbc/ClickHouseAdbcDriver.java | 15 ----------- .../com/clickhouse/adbc/ConnectionImpl.java | 24 ----------------- .../com/clickhouse/adbc/StatementImpl.java | 26 ------------------- 3 files changed, 65 deletions(-) delete mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ClickHouseAdbcDriver.java delete mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ConnectionImpl.java delete mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/StatementImpl.java diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ClickHouseAdbcDriver.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ClickHouseAdbcDriver.java deleted file mode 100644 index 26fef6ebf..000000000 --- a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ClickHouseAdbcDriver.java +++ /dev/null @@ -1,15 +0,0 @@ -package com.clickhouse.adbc; - -import org.apache.arrow.adbc.core.AdbcDatabase; -import org.apache.arrow.adbc.core.AdbcDriver; -import org.apache.arrow.adbc.core.AdbcException; - -import java.util.Map; - -public class ClickHouseAdbcDriver implements AdbcDriver { - - @Override - public AdbcDatabase open(Map map) throws AdbcException { - return null; - } -} diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ConnectionImpl.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ConnectionImpl.java deleted file mode 100644 index db2ce499c..000000000 --- a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/ConnectionImpl.java +++ /dev/null @@ -1,24 +0,0 @@ -package com.clickhouse.adbc; - -import org.apache.arrow.adbc.core.AdbcConnection; -import org.apache.arrow.adbc.core.AdbcException; -import org.apache.arrow.adbc.core.AdbcStatement; -import org.apache.arrow.vector.ipc.ArrowReader; -import org.checkerframework.checker.nullness.qual.Nullable; - -public class ConnectionImpl implements AdbcConnection { - @Override - public AdbcStatement createStatement() throws AdbcException { - return null; - } - - @Override - public ArrowReader getInfo(int @Nullable [] ints) throws AdbcException { - return null; - } - - @Override - public void close() throws Exception { - - } -} diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/StatementImpl.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/StatementImpl.java deleted file mode 100644 index a74f821c2..000000000 --- a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/adbc/StatementImpl.java +++ /dev/null @@ -1,26 +0,0 @@ -package com.clickhouse.adbc; - -import org.apache.arrow.adbc.core.AdbcException; -import org.apache.arrow.adbc.core.AdbcStatement; - -public class StatementImpl implements AdbcStatement { - @Override - public QueryResult executeQuery() throws AdbcException { - return null; - } - - @Override - public UpdateResult executeUpdate() throws AdbcException { - return null; - } - - @Override - public void prepare() throws AdbcException { - - } - - @Override - public void close() throws Exception { - - } -} From 735f7b97b3a614e6cae0f562cb8e3b5665297a84 Mon Sep 17 00:00:00 2001 From: Sergey Chernov Date: Tue, 7 Apr 2026 18:51:58 -0700 Subject: [PATCH 3/6] renamed package --- .../{example => examples}/arrow_server/AppArrowServer.java | 2 +- .../{example => examples}/arrow_server/ServerDataProducer.java | 2 +- .../{example => examples}/arrow_server/AppArrowServerTest.java | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename examples/experimental/apache-arrow/src/main/java/com/clickhouse/{example => examples}/arrow_server/AppArrowServer.java (96%) rename examples/experimental/apache-arrow/src/main/java/com/clickhouse/{example => examples}/arrow_server/ServerDataProducer.java (96%) rename examples/experimental/apache-arrow/src/test/java/com/clickhouse/{example => examples}/arrow_server/AppArrowServerTest.java (88%) diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/AppArrowServer.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/AppArrowServer.java similarity index 96% rename from examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/AppArrowServer.java rename to examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/AppArrowServer.java index f3203bc56..7b077a62a 100644 --- a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/AppArrowServer.java +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/AppArrowServer.java @@ -1,7 +1,7 @@ /* * This source file was generated by the Gradle 'init' task */ -package com.clickhouse.example.arrow_server; +package com.clickhouse.examples.arrow_server; import org.apache.arrow.flight.FlightServer; import org.apache.arrow.flight.Location; diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/ServerDataProducer.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/ServerDataProducer.java similarity index 96% rename from examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/ServerDataProducer.java rename to examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/ServerDataProducer.java index 6e4d8b39c..67b7d934d 100644 --- a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/example/arrow_server/ServerDataProducer.java +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/ServerDataProducer.java @@ -1,4 +1,4 @@ -package com.clickhouse.example.arrow_server; +package com.clickhouse.examples.arrow_server; import org.apache.arrow.flight.Action; import org.apache.arrow.flight.ActionType; diff --git a/examples/experimental/apache-arrow/src/test/java/com/clickhouse/example/arrow_server/AppArrowServerTest.java b/examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java similarity index 88% rename from examples/experimental/apache-arrow/src/test/java/com/clickhouse/example/arrow_server/AppArrowServerTest.java rename to examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java index 58aa75a87..c386a0d7a 100644 --- a/examples/experimental/apache-arrow/src/test/java/com/clickhouse/example/arrow_server/AppArrowServerTest.java +++ b/examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java @@ -1,7 +1,7 @@ /* * This source file was generated by the Gradle 'init' task */ -package com.clickhouse.example.arrow_server; +package com.clickhouse.examples.arrow_server; import org.testng.annotations.*; import static org.testng.Assert.*; From 713184167bfd2751e9302d66c8a145322b954fd5 Mon Sep 17 00:00:00 2001 From: Sergey Chernov Date: Wed, 8 Apr 2026 10:24:37 -0700 Subject: [PATCH 4/6] Imlemented read/write copy example for arrow --- .../apache-arrow/build.gradle.kts | 7 +- .../apache-arrow/gradle/libs.versions.toml | 14 +- .../examples/arrow_format/ReadWriteArrow.java | 223 ++++++++++++++++++ .../arrow_server/AppArrowServerTest.java | 1 - 4 files changed, 238 insertions(+), 7 deletions(-) create mode 100644 examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java diff --git a/examples/experimental/apache-arrow/build.gradle.kts b/examples/experimental/apache-arrow/build.gradle.kts index 162250e25..1af8e3f09 100644 --- a/examples/experimental/apache-arrow/build.gradle.kts +++ b/examples/experimental/apache-arrow/build.gradle.kts @@ -13,21 +13,22 @@ plugins { repositories { // Use Maven Central for resolving dependencies. mavenCentral() + mavenLocal() } dependencies { // Use TestNG framework, also requires calling test.useTestNG() below testImplementation(libs.testng) - // This dependency is used by the application. - // Source: https://mvnrepository.com/artifact/org.apache.arrow/arrow-bom + implementation(libs.clickhouseClient) + implementation(platform(libs.arrowBom)) implementation(libs.arrowVector) implementation(libs.arrowMemory) + implementation(libs.arrowCompression) implementation(libs.flightCore) implementation(libs.slf4jSimple) implementation(libs.slf4jApi) - implementation(libs.adbcCore) implementation(libs.guava) } diff --git a/examples/experimental/apache-arrow/gradle/libs.versions.toml b/examples/experimental/apache-arrow/gradle/libs.versions.toml index f5a0e51a5..956fb240a 100644 --- a/examples/experimental/apache-arrow/gradle/libs.versions.toml +++ b/examples/experimental/apache-arrow/gradle/libs.versions.toml @@ -7,14 +7,22 @@ testng = "7.5.1" arrowBom = "19.0.0" adbc = "0.22.0" slf4j = "2.0.17" +clickhouseClient = "0.9.8-SNAPSHOT" [libraries] guava = { module = "com.google.guava:guava", version.ref = "guava" } testng = { module = "org.testng:testng", version.ref = "testng" } +clickhouseClient = { module = "com.clickhouse:client-v2", version.ref = "clickhouseClient" } + +# Arrow support arrowBom = {module = "org.apache.arrow:arrow-bom", version.ref = "arrowBom"} -arrowVector = {module = "org.apache.arrow:arrow-vector"} -arrowMemory = {module = "org.apache.arrow:arrow-memory-netty"} +arrowVector = {module = "org.apache.arrow:arrow-vector" } +arrowMemory = {module = "org.apache.arrow:arrow-memory-netty" } +arrowCompression = { module = "org.apache.arrow:arrow-compression" } + +# Flight Server flightCore = {module = "org.apache.arrow:flight-core"} + +# Logging slf4jSimple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4j"} slf4jApi = { module = "org.slf4j:slf4j-api", version.ref = "slf4j"} -adbcCore = { module = "org.apache.arrow.adbc:adbc-core", version.ref = "adbc"} \ No newline at end of file diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java new file mode 100644 index 000000000..523917f3c --- /dev/null +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java @@ -0,0 +1,223 @@ +package com.clickhouse.examples.arrow_format; + +import com.clickhouse.client.api.Client; +import com.clickhouse.client.api.command.CommandResponse; +import com.clickhouse.client.api.insert.InsertResponse; +import com.clickhouse.client.api.insert.InsertSettings; +import com.clickhouse.client.api.internal.ServerSettings; +import com.clickhouse.client.api.query.QueryResponse; +import com.clickhouse.data.ClickHouseFormat; +import org.apache.arrow.memory.RootAllocator; +import org.apache.arrow.vector.Decimal256Vector; +import org.apache.arrow.vector.FieldVector; +import org.apache.arrow.vector.TimeStampMilliVector; +import org.apache.arrow.vector.TimeStampVector; +import org.apache.arrow.vector.VectorSchemaRoot; +import org.apache.arrow.vector.ipc.ArrowReader; +import org.apache.arrow.vector.ipc.ArrowStreamReader; +import org.apache.arrow.vector.ipc.ArrowStreamWriter; +import org.apache.arrow.vector.ipc.ArrowWriter; +import org.apache.commons.io.output.ByteArrayOutputStream; +import org.apache.hc.core5.http.ContentType; +import org.apache.hc.core5.http.HttpHeaders; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.lang.reflect.Field; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.nio.channels.Channels; +import java.util.Random; +import java.util.stream.IntStream; + +public class ReadWriteArrow { + + private static final Logger LOG = LoggerFactory.getLogger(ReadWriteArrow.class); + + private static final int ROOT_ALLOCATOR_LIMIT = 10 * 1024 * 1024; + + RootAllocator rootAllocator = new RootAllocator(ROOT_ALLOCATOR_LIMIT); + + ReadWriteArrow() { + + } + + private void loadData(Client client) { + LOG.info("Loading data to table using arrow"); + + // memory allocator to store values on local machine. Read more https://arrow.apache.org/java/current/memory.html + + + // Create value holders. Each column is Vector. In current example we want to send measures along with timestamps + // We allocate all needed space just for simplicity. + final int numValuesInBatch = 1; + TimeStampVector tsVector = new TimeStampMilliVector("ts", rootAllocator); + + Decimal256Vector val1Vector = new Decimal256Vector("val1", rootAllocator, 76, 39); + + VectorSchemaRoot vectorSchemaRoot = VectorSchemaRoot.of(tsVector, val1Vector); + + final String table = "arrow_example"; + executeUpdate("CREATE TABLE IF NOT EXISTS " + table + "(val1 Decimal) Engine = MergeTree Order By()", client); + + LOG.info("Generating data"); + final long startTimestamp = System.currentTimeMillis(); + + + IntStream.range(0, numValuesInBatch) + .forEachOrdered(index -> { + try { + tsVector.setSafe(index, startTimestamp + index); + val1Vector.setSafe(index, randomBigDecimal(76, 39)); + } catch (Exception e) { + LOG.error("Failed at " + index, e); + throw new RuntimeException(e); + } + }); + + tsVector.setValueCount(numValuesInBatch); + val1Vector.setValueCount(numValuesInBatch); + + try (ByteArrayOutputStream out = new ByteArrayOutputStream(); + ArrowWriter arrowWriter = new ArrowStreamWriter(vectorSchemaRoot, /* provider = */ null, Channels.newChannel(out))) { + + + + arrowWriter.start(); + + arrowWriter.writeBatch(); + + + LOG.info("ArrowWriter.bytesWritten {}, ByteArray.bytes {}", arrowWriter.bytesWritten(), out.size()); + InsertSettings insertSettings = new InsertSettings(); + insertSettings.serverSetting(ServerSettings.WAIT_ASYNC_INSERT, "1"); + insertSettings.serverSetting(ServerSettings.ASYNC_INSERT, "0"); + insertSettings.compressClientRequest(false); + insertSettings.useHttpCompression(false); + insertSettings.httpHeader(HttpHeaders.CONTENT_TYPE, ContentType.APPLICATION_OCTET_STREAM.getMimeType()); + insertSettings.compressClientRequest(false); + try (InsertResponse response = client.insert(table, out.toInputStream(), ClickHouseFormat.ArrowStream, insertSettings).get()) { + LOG.info("Data inserted {}", response.getWrittenRows()); + } + + } catch (Exception e) { + LOG.info("Failed to write data to DB", e); + } + } + + + private void readData(Client client) { + + + // Prepare data + final String table = "arrow_read_example"; + final String tableCopy = table + "_copy"; + executeUpdate("CREATE TABLE IF NOT EXISTS " + table + "(ts DateTime(3), val1 Decimal(76,62)) Engine = MergeTree Order By()", client); + executeUpdate("CREATE TABLE IF NOT EXISTS " + tableCopy + "(ts DateTime(3), val1 Decimal(76,62)) Engine = MergeTree Order By()", client); + executeUpdate("TRUNCATE " + table, client); + executeUpdate("TRUNCATE " + tableCopy, client); + + long tsStart = System.currentTimeMillis(); + int nRows = 10; + + StringBuilder sqlBuilder = new StringBuilder("INSERT INTO "); + sqlBuilder.append(table).append(" VALUES "); + IntStream.range(0, nRows) + .forEachOrdered(index -> { + sqlBuilder.append('(') + .append(tsStart + index) + .append(',') + .append(randomBigDecimal(76, 62)) + .append(')').append(','); + }); + + sqlBuilder.setLength(sqlBuilder.length() - 1); + executeUpdate(sqlBuilder.toString(), client); + + + // Init Arrow Vectors + // memory allocator to store values on local machine. Read more https://arrow.apache.org/java/current/memory.html + +// TimeStampVector tsVector = new TimeStampMilliVector("ts", rootAllocator); +// Decimal256Vector val1Vector = new Decimal256Vector("val1", rootAllocator, 76, 39); +// VectorSchemaRoot vectorSchemaRoot = VectorSchemaRoot.of(tsVector, val1Vector); + + try (QueryResponse resp = client.query("SELECT * FROM " + table + " LIMIT " +nRows +" FORMAT ArrowStream").get()) { + + try (ArrowReader arrowReader = new ArrowStreamReader(resp.getInputStream(), rootAllocator)) { + VectorSchemaRoot vectorSchemaRoot = arrowReader.getVectorSchemaRoot(); + FieldVector tsVector = vectorSchemaRoot.getVector("ts"); + FieldVector val1Vector = vectorSchemaRoot.getVector("val1"); + + while (arrowReader.loadNextBatch()) { + LOG.info("tsVector[{}], val1Vector[{}]", tsVector.getValueCount(), val1Vector.getValueCount()); + // We assume both vectors have same number of values + + // Copy data to another table using ArrowStream input format + InsertSettings insertSettings = new InsertSettings(); + try (InsertResponse insert = client.insert(tableCopy, outputStream -> { + try (ArrowWriter writer = new ArrowStreamWriter(vectorSchemaRoot, null, outputStream)) { + writer.start(); + writer.writeBatch(); + writer.end(); + } + + }, ClickHouseFormat.ArrowStream, insertSettings).get()) { + LOG.info("Inserted in {} ns", insert.getServerTime()); + } + } + + } + } catch (Exception e) { + LOG.error("Failed to query", e); + } + + } + + private static final Random RND = new Random(); + + + private static void executeUpdate(String sql, Client client) { + try (CommandResponse r = client.execute(sql).get()) {} catch ( + Exception e) { + throw new RuntimeException(e); + } + } + + public static BigDecimal randomBigDecimal(int precision, int scale) { + if (precision <= 0) throw new IllegalArgumentException("precision must be > 0"); + if (scale < 0 || scale > precision) throw new IllegalArgumentException("scale must be in [0, precision]"); + // first digit 1..9 so precision is exact + StringBuilder digits = new StringBuilder(); + digits.append(1 + RND.nextInt(9)); + for (int i = 1; i < precision; i++) { + digits.append(RND.nextInt(10)); + } + BigInteger unscaled = new BigInteger(digits.toString()); + return new BigDecimal(unscaled, scale); + } + + + + public static void main(String ...args) { + final String endpoint = System.getProperty("chEndpoint", "http://localhost:8123"); + final String user = System.getProperty("chUser", "default"); + final String password = System.getProperty("chPassword", ""); + final String database = System.getProperty("chDatabase", "default"); + + + + ReadWriteArrow app = new ReadWriteArrow(); + try (Client client = new Client.Builder() + .addEndpoint(endpoint) + .setUsername(user) + .setPassword(password) + .setDefaultDatabase(database) + .build()) { + +// app.loadData(client); + app.readData(client); + + } + } +} diff --git a/examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java b/examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java index c386a0d7a..7b9a5155b 100644 --- a/examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java +++ b/examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java @@ -9,6 +9,5 @@ public class AppArrowServerTest { @Test public void appHasAGreeting() { AppArrowServer classUnderTest = new AppArrowServer(); - assertNotNull(classUnderTest.getGreeting(), "app should have a greeting"); } } From 9d653bb18bbd984e527209950ff874a7bc38f170 Mon Sep 17 00:00:00 2001 From: Sergey Chernov Date: Wed, 8 Apr 2026 10:38:38 -0700 Subject: [PATCH 5/6] Complete write / read example --- .../examples/arrow_format/ReadWriteArrow.java | 73 ++++++++----------- 1 file changed, 32 insertions(+), 41 deletions(-) diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java index 523917f3c..180458ec0 100644 --- a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java +++ b/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java @@ -4,7 +4,6 @@ import com.clickhouse.client.api.command.CommandResponse; import com.clickhouse.client.api.insert.InsertResponse; import com.clickhouse.client.api.insert.InsertSettings; -import com.clickhouse.client.api.internal.ServerSettings; import com.clickhouse.client.api.query.QueryResponse; import com.clickhouse.data.ClickHouseFormat; import org.apache.arrow.memory.RootAllocator; @@ -17,19 +16,25 @@ import org.apache.arrow.vector.ipc.ArrowStreamReader; import org.apache.arrow.vector.ipc.ArrowStreamWriter; import org.apache.arrow.vector.ipc.ArrowWriter; -import org.apache.commons.io.output.ByteArrayOutputStream; -import org.apache.hc.core5.http.ContentType; -import org.apache.hc.core5.http.HttpHeaders; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.lang.reflect.Field; import java.math.BigDecimal; import java.math.BigInteger; -import java.nio.channels.Channels; import java.util.Random; import java.util.stream.IntStream; +/** + * + * Arrow requires access to direct memory and "unsafe" JDK API. Next JVM parameters should be set to allow this. + * For more info read Apache Arrow manual. + * {@code + * --add-opens=java.base/java.nio=ALL-UNNAMED + * --add-opens=java.base/sun.nio.ch=ALL-UNNAMED + * --add-opens=java.base/jdk.internal.misc=ALL-UNNAMED + * } + * + */ public class ReadWriteArrow { private static final Logger LOG = LoggerFactory.getLogger(ReadWriteArrow.class); @@ -50,7 +55,7 @@ private void loadData(Client client) { // Create value holders. Each column is Vector. In current example we want to send measures along with timestamps // We allocate all needed space just for simplicity. - final int numValuesInBatch = 1; + final int numValuesInBatch = 10_000; TimeStampVector tsVector = new TimeStampMilliVector("ts", rootAllocator); Decimal256Vector val1Vector = new Decimal256Vector("val1", rootAllocator, 76, 39); @@ -58,7 +63,8 @@ private void loadData(Client client) { VectorSchemaRoot vectorSchemaRoot = VectorSchemaRoot.of(tsVector, val1Vector); final String table = "arrow_example"; - executeUpdate("CREATE TABLE IF NOT EXISTS " + table + "(val1 Decimal) Engine = MergeTree Order By()", client); + executeUpdate("CREATE TABLE IF NOT EXISTS " + table + "(ts DateTime64, val1 Decimal(76,39)) Engine = MergeTree Order By()", client); + executeUpdate("TRUNCATE " + table, client); LOG.info("Generating data"); final long startTimestamp = System.currentTimeMillis(); @@ -78,34 +84,29 @@ private void loadData(Client client) { tsVector.setValueCount(numValuesInBatch); val1Vector.setValueCount(numValuesInBatch); - try (ByteArrayOutputStream out = new ByteArrayOutputStream(); - ArrowWriter arrowWriter = new ArrowStreamWriter(vectorSchemaRoot, /* provider = */ null, Channels.newChannel(out))) { - - - - arrowWriter.start(); - - arrowWriter.writeBatch(); - - - LOG.info("ArrowWriter.bytesWritten {}, ByteArray.bytes {}", arrowWriter.bytesWritten(), out.size()); - InsertSettings insertSettings = new InsertSettings(); - insertSettings.serverSetting(ServerSettings.WAIT_ASYNC_INSERT, "1"); - insertSettings.serverSetting(ServerSettings.ASYNC_INSERT, "0"); - insertSettings.compressClientRequest(false); - insertSettings.useHttpCompression(false); - insertSettings.httpHeader(HttpHeaders.CONTENT_TYPE, ContentType.APPLICATION_OCTET_STREAM.getMimeType()); - insertSettings.compressClientRequest(false); - try (InsertResponse response = client.insert(table, out.toInputStream(), ClickHouseFormat.ArrowStream, insertSettings).get()) { - LOG.info("Data inserted {}", response.getWrittenRows()); + // If you see Because of Code: 33. DB::Exception: Error while reading batch of Arrow data: IOError: Array length did not match record batch length: While executing ArrowBlockInputFormat. + // May be missing `vectorSchemaRoot.setRowCount` + vectorSchemaRoot.setRowCount(numValuesInBatch); + + InsertSettings insertSettings = new InsertSettings(); + insertSettings.compressClientRequest(true); + try (InsertResponse response = client.insert(table, out -> { + // use DataWriter to avoid tmp storage. + try (ArrowWriter arrowWriter = new ArrowStreamWriter(vectorSchemaRoot, /* provider = */ null, out)) { + arrowWriter.start(); + arrowWriter.writeBatch(); + arrowWriter.end(); + + } catch (Exception e) { + LOG.info("Failed writing data to output stream", e); } - + }, ClickHouseFormat.ArrowStream, insertSettings).get()) { + LOG.info("Data inserted {}", response.getWrittenRows()); } catch (Exception e) { LOG.info("Failed to write data to DB", e); } } - private void readData(Client client) { @@ -137,11 +138,6 @@ private void readData(Client client) { // Init Arrow Vectors // memory allocator to store values on local machine. Read more https://arrow.apache.org/java/current/memory.html - -// TimeStampVector tsVector = new TimeStampMilliVector("ts", rootAllocator); -// Decimal256Vector val1Vector = new Decimal256Vector("val1", rootAllocator, 76, 39); -// VectorSchemaRoot vectorSchemaRoot = VectorSchemaRoot.of(tsVector, val1Vector); - try (QueryResponse resp = client.query("SELECT * FROM " + table + " LIMIT " +nRows +" FORMAT ArrowStream").get()) { try (ArrowReader arrowReader = new ArrowStreamReader(resp.getInputStream(), rootAllocator)) { @@ -171,12 +167,10 @@ private void readData(Client client) { } catch (Exception e) { LOG.error("Failed to query", e); } - } private static final Random RND = new Random(); - private static void executeUpdate(String sql, Client client) { try (CommandResponse r = client.execute(sql).get()) {} catch ( Exception e) { @@ -205,8 +199,6 @@ public static void main(String ...args) { final String password = System.getProperty("chPassword", ""); final String database = System.getProperty("chDatabase", "default"); - - ReadWriteArrow app = new ReadWriteArrow(); try (Client client = new Client.Builder() .addEndpoint(endpoint) @@ -215,9 +207,8 @@ public static void main(String ...args) { .setDefaultDatabase(database) .build()) { -// app.loadData(client); + app.loadData(client); app.readData(client); - } } } From ec817029a46d1b0c5b7538e5634dc026d3700699 Mon Sep 17 00:00:00 2001 From: Sergey Chernov Date: Wed, 8 Apr 2026 11:41:40 -0700 Subject: [PATCH 6/6] Implemented Apache Arrow example --- .../apache-arrow => client-v2-apache-arrow}/.gitattributes | 0 .../apache-arrow => client-v2-apache-arrow}/.gitignore | 0 .../apache-arrow => client-v2-apache-arrow}/build.gradle.kts | 0 .../apache-arrow => client-v2-apache-arrow}/gradle.properties | 0 .../gradle/libs.versions.toml | 0 .../gradle/wrapper/gradle-wrapper.properties | 0 .../{experimental/apache-arrow => client-v2-apache-arrow}/gradlew | 0 .../apache-arrow => client-v2-apache-arrow}/gradlew.bat | 0 .../apache-arrow => client-v2-apache-arrow}/settings.gradle.kts | 0 .../java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java | 0 .../java/com/clickhouse/examples/arrow_server/AppArrowServer.java | 0 .../com/clickhouse/examples/arrow_server/ServerDataProducer.java | 0 .../com/clickhouse/examples/arrow_server/AppArrowServerTest.java | 0 13 files changed, 0 insertions(+), 0 deletions(-) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/.gitattributes (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/.gitignore (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/build.gradle.kts (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/gradle.properties (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/gradle/libs.versions.toml (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/gradle/wrapper/gradle-wrapper.properties (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/gradlew (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/gradlew.bat (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/settings.gradle.kts (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/src/main/java/com/clickhouse/examples/arrow_server/AppArrowServer.java (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/src/main/java/com/clickhouse/examples/arrow_server/ServerDataProducer.java (100%) rename examples/{experimental/apache-arrow => client-v2-apache-arrow}/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java (100%) diff --git a/examples/experimental/apache-arrow/.gitattributes b/examples/client-v2-apache-arrow/.gitattributes similarity index 100% rename from examples/experimental/apache-arrow/.gitattributes rename to examples/client-v2-apache-arrow/.gitattributes diff --git a/examples/experimental/apache-arrow/.gitignore b/examples/client-v2-apache-arrow/.gitignore similarity index 100% rename from examples/experimental/apache-arrow/.gitignore rename to examples/client-v2-apache-arrow/.gitignore diff --git a/examples/experimental/apache-arrow/build.gradle.kts b/examples/client-v2-apache-arrow/build.gradle.kts similarity index 100% rename from examples/experimental/apache-arrow/build.gradle.kts rename to examples/client-v2-apache-arrow/build.gradle.kts diff --git a/examples/experimental/apache-arrow/gradle.properties b/examples/client-v2-apache-arrow/gradle.properties similarity index 100% rename from examples/experimental/apache-arrow/gradle.properties rename to examples/client-v2-apache-arrow/gradle.properties diff --git a/examples/experimental/apache-arrow/gradle/libs.versions.toml b/examples/client-v2-apache-arrow/gradle/libs.versions.toml similarity index 100% rename from examples/experimental/apache-arrow/gradle/libs.versions.toml rename to examples/client-v2-apache-arrow/gradle/libs.versions.toml diff --git a/examples/experimental/apache-arrow/gradle/wrapper/gradle-wrapper.properties b/examples/client-v2-apache-arrow/gradle/wrapper/gradle-wrapper.properties similarity index 100% rename from examples/experimental/apache-arrow/gradle/wrapper/gradle-wrapper.properties rename to examples/client-v2-apache-arrow/gradle/wrapper/gradle-wrapper.properties diff --git a/examples/experimental/apache-arrow/gradlew b/examples/client-v2-apache-arrow/gradlew similarity index 100% rename from examples/experimental/apache-arrow/gradlew rename to examples/client-v2-apache-arrow/gradlew diff --git a/examples/experimental/apache-arrow/gradlew.bat b/examples/client-v2-apache-arrow/gradlew.bat similarity index 100% rename from examples/experimental/apache-arrow/gradlew.bat rename to examples/client-v2-apache-arrow/gradlew.bat diff --git a/examples/experimental/apache-arrow/settings.gradle.kts b/examples/client-v2-apache-arrow/settings.gradle.kts similarity index 100% rename from examples/experimental/apache-arrow/settings.gradle.kts rename to examples/client-v2-apache-arrow/settings.gradle.kts diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java b/examples/client-v2-apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java similarity index 100% rename from examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java rename to examples/client-v2-apache-arrow/src/main/java/com/clickhouse/examples/arrow_format/ReadWriteArrow.java diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/AppArrowServer.java b/examples/client-v2-apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/AppArrowServer.java similarity index 100% rename from examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/AppArrowServer.java rename to examples/client-v2-apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/AppArrowServer.java diff --git a/examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/ServerDataProducer.java b/examples/client-v2-apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/ServerDataProducer.java similarity index 100% rename from examples/experimental/apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/ServerDataProducer.java rename to examples/client-v2-apache-arrow/src/main/java/com/clickhouse/examples/arrow_server/ServerDataProducer.java diff --git a/examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java b/examples/client-v2-apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java similarity index 100% rename from examples/experimental/apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java rename to examples/client-v2-apache-arrow/src/test/java/com/clickhouse/examples/arrow_server/AppArrowServerTest.java