Skip to content

CHANGELOG.md

Latest commit

 

History

History
897 lines (685 loc) · 69.5 KB

CHANGELOG.md

File metadata and controls

897 lines (685 loc) · 69.5 KB

0.9.9

New Features

  • [jdbc-v2] Added cluster_name configuration property to specify a target cluster for statements like KILL QUERY that require an ON CLUSTER clause to execute across all nodes. (#2837)

Bug Fixes

  • [client-v2] Fixed inconsistent use of executionTimeout parameter in Client component. The timeout was previously set in milliseconds but mistakenly retrieved and used in seconds in some places. Now it correctly uses milliseconds consistently. (#2358)

0.9.8

Improvements

  • [client-v2] Added Records#getSchema() to expose table schema metadata even when query result is empty. (#2777)

Bug Fixes

  • [jdbc-v1, jdbc-v2] Fixed type mapping/conversion behavior for large unsigned integer values (issue #2779), including related test coverage updates. (#2779)

  • [jdbc-v2] Fixed off-by-one bug in ArrayResultSet#next() that could return true one extra time and then fail with SQLException: No current row. (#2790)

  • [jdbc-v2] Fixed handling of malformed SELECT-like queries (for example, SELECT a, FROM table): previously, the driver could fail to read returned data when query type was not inferred before execution; now it detects a returned result set at runtime from the server response and reads it correctly. (#2784)

Updated Dependencies

  • [repo] Upgraded at.yawk.lz4:lz4-java from 1.10.2 to 1.10.4 to pick up native performance fixes. (#2778)

  • [repo] Upgraded com.fasterxml.jackson.core:jackson-core from 2.17.2 to 2.18.6 in jdbc-v2. (#2767)

  • [repo] Upgraded com.fasterxml.jackson.core:jackson-core from 2.17.2 to 2.18.6 in examples/client-v2. (#2766)

0.9.7

Breaking Changes

  • [client-v2] Client.Builder#build() now throws ClientMisconfigurationException when an unknown configuration property is passed. Previously, unknown properties were silently ignored what caused unexpected behaviour and problems. To restore the old behavior, add ignore_unknown_config_key=true to the client properties. JDBC driver-only properties (e.g. ssl) are no longer forwarded to the underlying client. (#2658)

  • [client-v2] Date/Date32 columns are now decoded as LocalDate without any timezone adjustment. Previously, Date values could be returned as ZonedDateTime. Applications that need a ZonedDateTime must construct it from the returned LocalDate using their own timezone context. More read about it - https://clickhouse.com/docs/integrations/language-clients/java/jdbc_date_time_guide (#2727)

Improvements

  • [client-v2] Added option to send query parameters in the HTTP request body using multipart form encoding. Enabled via the new client.http.use_form_request_for_query configuration property (or Client.Builder#useHttpFormDataForQuery()). Useful when query parameters would exceed URL length limits. (#2324)

  • [client-v2] QueryResponse, InsertResponse, and CommandResponse now expose getServerDisplayName() to retrieve the value of the X-ClickHouse-Server-Display-Name HTTP response header. A full map of whitelisted response headers is accessible via getResponseHeaders(). (#2347)

  • [client-v2] Added getObjectArray() to ClickHouseBinaryFormatReader and GenericRecord to read Array(...) columns as Object[], including recursive support for nested arrays. getStringArray() now also handles Array(Enum*) by returning enum names. (#2738)

  • [jdbc-v2] Added support for reading and writing byte[] for String/FixedString columns. PreparedStatement#setBytes() encodes the value as a ClickHouse unhex() expression to preserve raw bytes; ResultSet#getBytes() returns the UTF-8 bytes of the string value. (#2734)

Date and Time Handling

  • [docs] Added a document that explains how driver handles different date/time values.

  • [client-v2, jdbc-v2] Fixed writing Date/Time/Timestamp values so that timezone conversions are performed explicitly. Previously, timezone-naïve encoding caused day-shift and precision bugs, especially when a Calendar or non-default JVM timezone was in use. (#2701, #2065, #2496, #1220, #1117, #1048, #2381, #1735, #2542, #2557)

  • [client-v2, jdbc-v2] Fixed reading Date/Time/DateTime values to be consistent and correct. Date/Date32 are now decoded as LocalDate (no timezone), while Time/Time64 are decoded as UTC-based LocalDateTime. New getLocalTime() API added to readers for LocalTime access. Reading date/time from Dynamic and Variant columns is also fixed. (#2727)

  • [jdbc-v2] DatabaseMetaDataImpl#getTypeInfo() now returns type information in deterministic alphabetical order, matching v1 driver behavior. (#2733)

SQL Parser (jdbc-v2)

  • [jdbc-v2] Fixed SQL parser failing to handle ClickHouse keywords used as table names or column aliases (e.g. AS value, FROM date). Both the ANTLR4 and JavaCC parsers now maintain a list of non-reserved keywords allowed in identifier positions. Also fixed parsing of DESCRIBE (SELECT ...), IN operator in SELECT, and bracketed array access in expressions. (#2718)

  • [jdbc-v2] Updated SQL parsers to recognise new ClickHouse keywords (ABI, ARGUMENTS, DRY, LANGUAGE, RETURNS, RUN) introduced in recent ClickHouse HEAD builds. Previously, queries using these keywords as identifiers would fail to parse. (#2761)

  • [jdbc-v2] Fixed SQL parser failing on statements containing the ^ (caret) operator, such as toJSONString(data.^header_index). A new CARET token is now recognised and allowed in dotted identifier chains. (#2768)

Array and Collection Handling

  • [jdbc-v2] Fixed DataTypeConverter causing NPE when converting nested arrays to strings (e.g. ResultSet#getString() on an Array(Array(...)) column). The converter is now re-entrancy-safe. Previously was throwing NullPointerException. (#2723)

  • [client-v2, jdbc-v2] Fixed conversion of multi-dimensional List/array values into Java arrays. Child array dimensions are now calculated correctly from the parent depth level. Previously, converting List<List<T>> or similar structures produced incorrect results. (#2741)

  • [client-v2] Fixed binary array decoding when the first element of an array is an empty Map or List. Previously, this caused a type mismatch error during array population. (#2499, #2657, #2703)

Bug Fixes

  • [jdbc-v2] Fixed DatabaseMetaDataImpl#getJDBCMajorVersion() and getJDBCMinorVersion() returning the ClickHouse driver version instead of the supported JDBC specification version. Now correctly returns 4 and 2 (JDBC 4.2). (#2736)

  • [jdbc-v2] Added mapping for all known ClickHouse table engines to JDBC table types. Added MATERIALIZED VIEW as a new table type. getTables() now correctly reports remote/external engine tables that were previously invisible. (#2664)

  • [jdbc-v2] Fixed NullPointerException in JDBC type metadata for columns of type Map, IPv4, IPv6, UUID, BFloat16, Decimal256, Geometry, all Interval* types, JSON, LowCardinality, Nullable, Variant, Dynamic, and others. Previously these types had no Java class mapping. (#2711)

  • [jdbc-v2] ClickHouse server error codes are now propagated to SQLException#getErrorCode(). Previously, SQLException was created without the vendor error code, making it impossible to distinguish error types programmatically. (#2717)

  • [client-v2] Fixed max_execution_time not being sent correctly to the server. Previously, it was treated as a client option and ignored by ClickHouse; it is now transmitted as a server setting. (#2750)

  • [client-v2] Fixed hasValue(columnName) throwing an exception when the column name does not exist. Previously, referencing an unknown column or an out-of-range index via hasValue() would throw; it now returns false. (#2755)

  • [jdbc-v2] Fixed PreparedStatement reporting missing parameters using 0-based indices in the error message. JDBC parameter positions are 1-based; the error message now reflects this correctly. (#2749)

  • [jdbc-v2] Ported legacy JDBC v1 connection properties (CUSTOM_HTTP_PARAMS, CUSTOM_SETTINGS, HTTP_CONNECTION_PROVIDER, REMEMBER_LAST_SET_ROLES, USE_SERVER_TIME_ZONE_FOR_DATES) to JDBC v2. Required for integrations that share JDBC v1/v2 configuration code. custom_http_params and custom_settings values are converted to server settings automatically. (#2757)

  • [client-v2, jdbc-v2] Fixed custom_-prefixed configuration properties not being forwarded to the server as custom settings when using the custom_ prefix. Also fixed driver-only properties (e.g. ssl) being incorrectly forwarded to the HTTP client. (#2658)

0.9.6

Release is aimed to address potential security risk in one of the dependencies (see below). We strongly recommend to upgrade.

Dependencies

New Features

  • [jdbc-v2] - support of dot notation for table names without quotes. (#2650)

0.9.5

New Features

  • [client-v2] Log durations in ISO-8601 duration format (#2660)
  • [jdbc-v2] Added support for getResultSet() method in Array data types. (#1545, #2683)
  • [jdbc-v2] Added handling for Time and Time64 data types in JDBC. (#2682)

Bug Fixes

  • [client-v2] Fixed reading columns of Array with component type Variant. For example, Array(Variant(String, Int32)). (#2602)
  • [jdbc-v2] Fixed backward compatibility for getPrimaryKeys() method. (#2654)
  • [jdbc-v2] Fixed array conversion issues with multidimensional arrays and nested arrays. (#2457)
  • [jdbc-v2] Fixed backward compatibility issues with older ClickHouse versions by replacing :: cast operator with CAST function in prepared statements. Fixed issue with reading database version on older versions. (#2654, #2227)
  • [jdbc-v2] Reviewed and fixed database metadata support flags and return values. (#2520, #778, #2519)
  • [jdbc-v2] Added verification tests for issues #1999, #1015, #2155 (#2659)

0.9.4

New Features

  • [client-v2] Added support for different compression algorithms when HTTP compression is enabled. (#2645)

Bug Fixes

  • [client-v1] Fixes issue linked to a enabled by default HTTP compression in ClickHouse 25.10. (#2636)

0.9.3

Important Changes

  • [jdbc-v2] SQL parser from v1 is ported to v2 to address multiple issues with SQL parsing. The ANTLR4-based parser is still an option and will be developed further. The main difference between parses is completeness of their grammar: JavaCC grabs only needed information and skips parsing of the rest (what makes it work for most cases) while ANTLR4 has more complete grammar and can detect type of some complex statements more accurate than JavaCC. To use it set com.clickhouse.jdbc.DriverProperties#SQL_PARSER to ANTLR4. (#2579). This fixes issue:

  • [repo] New artifact clickhouse-jdbc-all added to address issue when maven package qualifiers may not be used. This artifact should is a copy of clickhouse-jdbc:all but should be used only when required. (#2625)

Improvements

Bug Fixes

  • [jdbc-v2] Fixed issue with maxRows in Statement when additional settings were used to limit result set size. It caused problems with read-only users because such users may not change settings in most cases. Now when maxRows is set then ResultSet will skip extra rows. (#2582)
  • [jdbc-v2] Fixed issue with driver version. Previously version of a library was converted to minor and major version. But this approach doesn't work well with 0.9.x versions. Now major and minor versions are combined by shifting major. Patch version becomes a minor version. (#2410)
  • [jdbc-v2, client-v2] Fixed converting different data types to a string. For example, there was an issue with IP address when toString() was used and returned \0.0.0.0 instead of 0.0.0.0. (#2575)
  • [jdbc-v2] Fixed issues around spatial data (GEO types). (#2577)
  • [client-v2] Fixed issue with current user name. If user name is set then it will be used event after reading server context. (#2247)
  • [client-v2] Fixed issue with network timeout settings when default value failed to be cast to Long. (#2597)
  • [jdbc-v2] Fixed getting metadata for nullable columns. (#2586)
  • [jdbc-v2, client-v2] Fixed issues related to reading JSON data type. Fixed reading JSON columns with arrays. Previously was causing exceptions like com.clickhouse.client.api.ClientException: Unsupported data type with tag 101 at ... (#2598, #2593, #2613, #2102)
  • [client-v2] Fixed configuration parameter type for socket_linger to match documentation. (#2524)
  • [client-v2] Fixed handling exceptions in http client code. Now response object is always closed to prevent connection leaking. (#2615)
  • [jdbc-v2, client-v2] Fixed issue with duplicate column names in a result set. (#2459, #2336)
  • [jdbc-v2] Fixed ANTLR4 parse issue with filter clause along with aggregate function. (#2631)

0.9.2

Improvements

  • [jdbc-v2] ResultSetImpl.getObject() handles java.time.Instant

Improvements

  • [jdbc-v2] Classes com.clickhouse.jdbc.ClientInfoProperties and com.clickhouse.jdbc.DriverProperties moved to public API. (#2521)
  • [jdbc-v2] Implemented isBeforeFirst, isAfterLast, isFirst, isLast methods for ResultSet and ResultSetMetaData. Improved test coverage for ResultSetImpl. (#2530)
  • [jdbc-v2] Implemented createArray and createStruct methods for Connection interface. Method createStruct should be used to create Tuple values and createArray to create various arrays. (#2523)
  • [jdbc-v2] Implemented setNetworkTimeout of Connection interface. Used to fail fast when network operation fails. Related to stale connection problem. (#2522)
  • [client-v2] Added support for JSON with predefined paths. Previously columns with definition like JSON(a string, b.c Int32) were not supported. (#2531)

Bug Fixes

  • [jdbc-v2] Fixed issue creating array of tuples with createArray method of Connection interface. (#2360)
  • [jdbc-v2] Fixed issue with reading nested arrays. (#2539)
  • [jdbc-v2] Fixed issue with not shaded antlr4-runtime dependency. Potential problem for Apache Spark users. (#2553)
  • [jdbc-v2] Fixed issue with parsing CTE for prepared statement. (#2551)
  • [jdbc-v2] Fixed issue with parsing SQL containing view parameters. (#2547)
  • [jdbc-v2] Fixed issue with InsertSettings when two concurrent insert operations sharing same settings object may be insert wrong columns or to a wrong table. (#2550)
  • [jdbc-v2] Fixed issue with batch insert when it is not cleared after execution. Now batch is cleared after execution even on failure. (#2548)
  • [jdbc-v2] Fixed DatabaseMetadataImpl to return result set with defined by spec structure. Resolves issue for many database tools relying on metadata. (#2396)
  • [jdbc-v2] Fixed DatabaseMetadataImpl to return empty result set where appropriate. (#2517)
  • [jdbc-v2] Fixed issue with verbose logging. (#2148)
  • [client-v2] Fixed issue with reading JSON with predefined paths. (#2462)

0.9.1

New Features

  • [client-v2] Added option to set SNI for SSL connections. See com.clickhouse.client.api.Client.Builder.sslSocketSNI (#2467)
  • [client-v2, jdbc-v2] Added support for Time and Time64 data types. (#2487)
  • [client-v2] Added utility methods to format Instant to a DB DateTime format. See com.clickhouse.client.api.DataTypeUtils.formatInstant(java.time.Instant, com.clickhouse.data.ClickHouseDataType) (#2501, #2456)

Improvements

  • [client-v2] Improved exceptions and error handling. The com.clickhouse.client.api.ClickHouseException became a root for ServerException and ClientException. com.clickhouse.client.api.ClickHouseException.isRetryable is added to determine if exception caused in a retriable state. It means that catching such exception application may repeat operation to fix a problem. (#2453)
  • [client-v2] Improved configuration handling. (#2470)
  • [client-v2] Custom type hint for the client to make Reader and GenericRecord return specific types. For example, collection instead of Array. (#2476)
  • [client-v2] Added default port for HTTP and improved endpoint string validation - only one allowed. (#2489)
  • [client-v2] Improved handling error response. (#2511)

Bug Fixes

  • [client-v2] Fixed metrics to be parsed as Long to avoid integer overflow. Especially for elapsed time in nanos. (#2465)
  • [client-v2] Fixed a bug with passing some server settings from JDBC to the Client. (#2359)
  • [jdbc-v2] Fixed DatabaseMetadata to return correct column type. (#2475)
  • [jdbc-v2] Fixed problem with JDBC URL when Database names that include dash - were parsed wrong. (#2463)
  • [jdbc-v2] Fixed problem with nested arrays. Previously ArrayValue object was returned as element of a nested array. After the fix array values contain primitive types. (#2464, #2340)
  • [jdbc-v2] Fixed JDBC Connection's isValid method returning true all the time. (#2472)
  • [client-v2] Fixed problem with not closed response object when exception happens. That fixes connections leaking. (#1741)
  • [jdbc-v2] Fixed a set of issue in StatementImpl. (#2414)
  • [jdbc-v2] Fixed a set of issues in PreparedStatementImpl. (#2418)
  • [jdbc-v2] Fixed multiple issues linked to parsing statements in JDBC. (#2450, #2451, #2461, #2500, #2493, #2478)
  • [jdbc-v2] Fixed result set returning not a DB compliant date/time format. (#2408, #2448)

0.9.0

Important Changes

  • [repo] Artifacts clickhouse-jdbc:http, clickhouse-jdbc:shaded-all, clickhouse-jdbc:shaded are not published anymore. Use clickhouse-jdbc:all instead. It contains all required shaded libraries except org.slf4j:slf4j-api because it may not be shaded.
  • [repo] Artifacts jdbc-v2:all, jdbc-v2:http, jdbc-v2:shaded are not published anymore because jdbc-v2 is part of clickhouse-jdbc:all.

Bug Fixes

  • [jdbc-v2] Fixed parsing SQL with alias in FROM clause when alias name is a keyword (#2427)
  • [client-v2] Fixed the issue when parameters are not passed if timeout is set. (#2436, #2096)
  • [jdbc-v2] Fixed parser logging issue. Now parser uses same logger as the driver. (#2428)
  • [jdbc-v2] Fixed parsing CREATE USER statements. Now parser recognises it correctly. (#2398)
  • [jdbc-v2] Fixed parsing different CTEs statements. (#2431, #2391, #2443)
  • [jdbc-v2] Fixed parsing interval values. (#2429)
  • [repo] Fixed running unit/integration tests in the CI. (#2430)
  • [jdbc-v2] Fixed parsing parameters when function is in back quotes. (#2422)
  • [jdbc-v2] Fixed ResultSet#findColumn always returning 0. (#2375)

Misc

  • [client-v2] Move all default values to ClientConfigurationProperties enum. (#2269)

Docs

  • [client-v2] Updated documentation of the configuration parameters and how to set server settings and custom HTTP headers.

0.8.6

Improvements

  • [jdbc-v2] Now using Antlr4 to parse SQL statements to get meta information about it. Invalid SQL still possible to execute if logic able to get all required information. (#2351)
  • [jdbc-v2] Now possible to use RowBinaryWriter if enabled by property com.clickhouse.jdbc.internal.DriverProperties.BETA_ROW_BINARY_WRITER. This works well for batches. Single statements may get no benefits. (#2316)

Bug Fixes

  • [jdbc-v2] Fixed parsing prepared statement arguments. (#2348)
  • [jdbc-v2] Fixed parsing role name when it contains -. (#2325)
  • [jdbc-v2] Fixed failure when INSERT doesn't contain VALUES. (#2283)
  • [jdbc-v2] Fixed parsing INSERT statement when VALUES is in lower case. (#2354)
  • [client-v2] Fixed NPE when async operation is request while client was built without an executor. In this case default JVM executor will be used. (#2355)
  • [client-v2, jdbc-v2] Fixed conversion of IP addresses. When IPv4 stored as IPv6 it is correctly converted to Inet6Address. Similar problem fixed for JDBC. (#2342)
  • [jdbc-v2] Fixed changing DB schema (DB name) on connection when USE statement executed. (#2137)
  • [client-v2] Fixed serializing POJO with primitive boolean fields. (#2248)

0.8.5

Improvements

  • [jdbc-v2] Added debug output for final SQL. (#2249)

Bug Fixes

  • [client-v2] Fixed creating TableSchema for materialized views. It resolves issues with POJO serde. (#2118, #2025)
  • [client-v2, jdbc-v2] Fixed handling Nullable inside SimpleAggregateFunction columns. (#2110)
  • [jdbc-v2] Fixed problem with server info request. It is fetched now when timezone of the server is set. (#2191)
  • [jdbc-v2] Fixed null response for getIndexInfo(). Empty Result Set is returned. (#2286)
  • [jdbc-v2] Fixed wrong false response in DataBaseMetadata.supportsBatchUpdates(). Returns true now. Please note that no update is supported for result sets.
  • [jdbc-v2] Fixed handling UUID data type in PreparedStatement. (#2327)
  • [jdbc-v2] Fixed unsigned integer type matching. UInt8, UInt16, UInt32, UInt64, UInt128, UInt256 are presented as short, int, long, BigInteger, BigInteger, BigInteger correspondingly. SQLType for them is OTHER because JDBC (as well as Java) doesn't provide good mapping for unsigned integers. (#2333)
  • [jdbc-v2] Disallowed to call method from Statement interface on PreparedStatement instance according to the JDBC spec. (#2339)

0.8.4

Examples

  • [jdbc-v2] - JPA example added. (#2301)

Bug Fixes

  • [jdbc-v2] Added implementation of ResultSetMetaData.getColumnClassName() to return information about class name of the value stored in a result. (#2112)
  • [client-v2] Fixed NPE when Client.queryAll used with INSERT statement because internally columns variable was accessed and was null. (#2150)
  • [jdbc-v2] Fixed NPE when ssl=true was passed via an connection URL. (#2206)
  • [jdbc-v2] Fixed sending correct driver version. Problem occurs because context classloader had no access to a resource file with versions. (#2245)
  • [jdbc-v2] Fixed incorrect flag for Array values when reading result set. (#2266)
  • [jdbc-v2] Fixed parsing parameters in PreparedStatement for cases when '?' is within quotes or similar. (#2290)
  • [jdbc-v2] Added implementation for com.clickhouse.jdbc.PreparedStatementImpl#getMetaData. Complete metadata is returned only after statement execution. Partial metadata is returned before execution of the statement. (#2292)
  • [jdbc-v2] Fixed clearParameters in PreparedStatementImpl to correctly reset parameters array. (#2299)
  • [jdbc-v2] Fixed logging. (#2303)
  • [jdbc-v2] Fixed metadata field DATA_TYPE being String (#2240)

0.8.3

Improvements

  • [client-v2] Support for native LZ4 compression (#2274)

Bug Fixes

  • [jdbc-v2] Fixed several issues with reading database metadata in JDBC driver. (#2282)
  • [jdbc-v2] Fixed settings client name in JDBC. (#2233)
  • [client-v2] Fixed reading data from columns defined as Nullable(FixedString(N)). (#2218)
  • [jdbc-v2] Fixed SQL parser failure to parse SQL statement with comments (#2217)
  • [client-v2] Fixed issue with excessive logging (#2201)
  • [jdbc-v2] Fixed handling IP addresses (#2140)
  • [jdbc] - Fixed missing LZ4 dependency in shaded package (#2275)

0.8.2

Bug Fixes

  • [jdbc-v2] - Significantly improved performance of JDBC inserts. (#2165)
  • [client-v1] - Removed unnecessary object creation and added executor pool configuration (#2164)

Miscellaneous

  • [client-v1] - Deprecated the old client, though it is still available. We've not yet set a date for its removal, this more serves as a head's up.

0.8.1

New Features

  • [client-v2] - Added support for Variant Data Type for RowBinary format. Can be read into a POJO or using a reader. Writing is supported only for POJO. (#2130)
  • [client-v2] - Added support for Dynamic Data Type for RowBinary format. Can be read into a POJO or using a reader. Writing is supported only for POJO. (#2130)
  • [client-v2] - Added support for JSON Data Type for RowBinary format. Can be read into a POJO or using a reader. Writing is supported only for POJO. (#2130)
  • [client-v2] - Added support for ZonedDateTime in POJO serde. (#2117)
  • [client-v2] - Added suport for micrometer metrics for Apache HTTP client connection pool. It is now possible to get metrics registered in micrometer registry by calling com.clickhouse.client.api.Client.Builder.registerClientMetrics(registry, groupName). (#1901)

Bug Fixes

  • [client-v2] - Fixed getTableSchema(tableName, databaseName) now it doesn't ignore database name. (#2139)
  • [client-v2] - Fixed returnGeneratedValues to not throw an exception. Keep in mind that ClickHouse doesn't support returning anything in response for INSERT statements. This change was done just to make client usable with certain frameworks. (#2121)
  • [jdbc-v2] - Fixed changing database by USE statement. (#2137)
  • [jbdc-v2] - Fixed ResultSetMetadata.getColumnClassName() to return null instead of throwing exception. This change is done only to allow certain frameworks work with the client. (#2112)
  • [jdbc-v2] - Fixed using statements with WITH in JDBC v2. Previously was causing NPE. (#2132)
  • [repo] - Fixed failing Test in Windows when attempting to locate files with reserved characters in the file path. (#2114)

0.8.0

Highlights

  • We've updated ClickHouseDriver and ClickHouseDataSource to default to using the new (jdbc-v2) implementation of the JDBC driver. Setting clickhouse.jdbc.v1=true will revert this change.

JDBC Changes

  • jdbc-v2 - Removed support for Transaction Support. Early versions of the driver only simulated transaction support, which could have unexpected results.
  • jdbc-v2 - Removed support for Response Column Renaming. ResultSet was mutable - for efficiency sake they're now read-only
  • jdbc-v2 - Removed support for Multi-Statement SQL. Multi-statement support was only simulated, now it strictly follows 1:1
  • jdbc-v2 - Removed support for Named Parameters. Not part of the JDBC spec
  • jdbc-v2 - Removed support for Stream-based PreparedStatement. Early version of the driver allowed for non-jdbc usage of PreparedStatement - if you desire such options, we recommend looking at client-v2.

New Features

  • [client-v2, jdbc-v2] - Added support for Bearer token authentication like JWT. Now it is possible to specify encoded token while creating a client and change while runtime using com.clickhouse.client.api.Client.updateBearerToken. (#1834, #1988)
  • [client-v2] - Exposed connection pool metrics through Micrometer. It allows to monitor internal connection pool for number of active and leased connections. (#1901)

Bug Fixes

  • [client-v2] - Fixed construction of User-Agent header. Prev. implementation uses class.getPackage().getImplementationVersion() what returns incorrect title and version when library is shaded. New implementation uses build time information from resource files generated while build. (#2007)
  • [client-v2] - Fixed multiple issues with handling connectivity disruption. Socket timeout is unlimited by default. Added retry on timeout. Added more information to exception message. Please read the issue for more details. (#1994)
  • [client-v2] - Client doesn't close provided executor anymore letting application close it instead. (#1956)
  • [client-v2] - Removed unnecessary initialization to make startup time shorter. (#2032)

0.7.2

New Components

  • jdbc-v2 - pre-release version of upcoming clickhouse-jdbc replacement. Supports basic functionality, works only with client-v2. More information will be available after its release

Highlights

  • [repo] Added shaded packages with requires a set of dependencies. Use all classified for client-v2 full package. Use shaded-all for old jdbc driver.
  • [client-v2] New Data Writer API was added. It allows to gain a control over writing data to low-level output stream. This API makes it possible to write compressed data directly to server. See com.clickhouse.client.api.Client#insert(java.lang.String, com.clickhouse.client.api.DataStreamWriter, com.clickhouse.data.ClickHouseFormat, com.clickhouse.client.api.insert.InsertSettings) (#2034)

New Features

  • [client-v2] Added ability to specify client name. It means User-Agent will be filled with proper information (#1948)
  • [client-v2] Implemented statement parameters for queryAll and queryRecords API methods. (#1979)
  • [client-v2] Implemented string to number conversion. (#2014)
  • [client-v1] Added basic auth support for proxies. Now you can specify username/password when connecting via a proxy that requires it with HttpURLConnection and Apache HttpClient.
  • [client-v2] Enum columns can be read as string and number. Previously only as number. Now number matching string constant is returned when get as string. (#2028)
  • [client-v2] Client will load some server context (timezone, user) right after build. (#2029)

Bug Fixes

  • [jdbc] Fixed default value for result_overflow_mode setting. (#1932)
  • [client-v2] Fixed reading float/double values. Previously was prevented by incorrect overflow check. (#1954)
  • [client-v2] Fixed issue with enabling client compression. Previously flag was ignore in some cases. (#1958)
  • [client-v2] Fixed issue with reading Array(UInt64) because of incorrect class used to create internal array. (#1990)
  • [client-v2] Fixed ClickHouseLZ4OutputStream issue of sending empty frame when no data left in uncompressed buffer. (#1993)
  • [client-v2] Fix handling ConnectTimeoutException in retry and wrapping logic. (#2015)

0.7.1-patch1

Bug Fixes

  • [JDBC] Fixed java.lang.NoClassDefFoundError: com/clickhouse/client/internal/apache/hc/core5/http2/HttpVersionPolicy (#1912)
  • [client-v2] Fixed multiple issues with error message handling. (#1906)
  • [client-v2] Fixed primitive types conversion. Now client correctly handles numbers to boolean and vice-versa. (#1908)

0.7.1

New Features

  • [client-v2] Implemented more friendly number conversion. Now it is possible to convert smaller type to bigger one. It is also possible to convert bigger into smaller if value fits into the range. (#1852)
  • [client-v2] Ported a feature that allows to remember DB roles for a client instance. See com.clickhouse.client.api.Client#setDBRoles for details. (#1832)
  • [client-v2] Ported a feature that allows adding comments to a query. See com.clickhouse.client.api.insert.InsertSettings#logComment and com.clickhouse.client.api.query.QuerySettings#logComment for details. (#1836)
  • [client-v2] Added support for SSL Authentication with client certificates. (#1837)
  • [client-v2] Implemented a way to define a custom matching between a column name and a field in a POJO in Client#register method. (#1866)
  • [client-v1, client-v2] Implemented HTTP Basic authentication and made it a default auth method for HTTP interface. It was done to address problem with passwords contianing special and UTF8 characters. New configuration option com.clickhouse.client.http.config.ClickHouseHttpOption.USE_BASIC_AUTHENTICATION for client v1 is added. For client v2 use com.clickhouse.client.api.Client.Builder#useHTTPBasicAuth method. (#1305)

Dependency Updates

  • [client] Bumped org.apache.avro:avro version to 1.11.4 (#1855)

Documentation

  • [client] Added links to javadoc for all classes in the README.md (#1878)

Bug Fixes

  • [client-v2] Fixed deserializing nullable columns of Nested type (#1858)
  • [client-v2] Fixed dependencies needed for compression to work out of the box (#1805)
  • [client-v2] Fixed dependency on SNAPSHOT component (#1853)
  • [client-v2] Fixed using scale from a column definition when deserializing DateTime64 values (#1851)
  • [client-v2] Fixed applying database from insert settings (#1868)
  • [client-v2] Fixed error handling from server (#1874)
  • [client-v2] Fixed SerDe for SimpleAggregateFunction columns (#1876)
  • [client] Fixed handling error from server in response with 200 OK status. Happens when send_progress_in_http_headers is requested and query runs for a long time. (#1821)
  • [jdbc] Fixed incorrect error logging (#1827)
  • [client-v2] Fixed handling tuples in arrays (#1882)
  • [client-v2] Fixed passing insert_duplication_token through InsertSettings. (#1877)

0.7.0

Deprecations

  • Following deprecated components are removed:
    • clickhouse-cli-client
    • clickhouse-grpc-client

Important Changes

  • [client-v2] New transport layer implementation is used by default. It is still possible to switch back using old implementation by setting com.clickhouse.client.api.Client.Builder#useNewImplementation to false. (#1847)

New Features

  • [client-v2] Now there is an easy way to set custom HTTP headers globally for client and per operation. See com.clickhouse.client.api.Client.Builder.httpHeader(java.lang.String, java.lang.String) for details. (#1782)
  • [client-v2] Now there is a way to set any server settings globally for client and per operation. See com.clickhouse.client.api.Client.Builder.serverSetting(java.lang.String, java.lang.String) for details. (#1782)
  • [client-v2] Added support for writing AggregateFunction values (bitmap serialization). !! Reading is not supported but will be added in the next release. (#1814)
  • [r2dbc] Defer connection creation. This allows pool to create a new instance on every subscription, instead of always returning the same one. (#1810)

Performance Improvements

  • [client-v2] Improved reading fixed length data like numbers. It is possible to configure readers to use pre-allocated buffers to avoid memory allocation for each data row/block. Significantly reduces GC pressure. See com.clickhouse.client.api.Client.Builder.allowBinaryReaderToReuseBuffers for details. (#1816)
  • [client-v2] New API method introduced to read data directly to a POJO. Deserializers for POJO classes are compiled into bytecode (with help of https://asm.ow2.io/ library) and optimized for each schema. It is great performance boost because data is read without copying it into temporary structures. Code can be optimized by JVM while runtime as SerDe code is implemented without reflection using JVM bytecode. Using bytecode makes handling primitive types without values boxing. (#1794, #1826)
  • [client-v2] Optimized reading columns - internally data is read into map of column-values. It is done to allow reading same column more than once. Previously map was cleared each row what caused a lot internal objects creation. Now values are overridden because schema doesn't change between rows. (#1795)

Documentation

  • [client-v2] Added example for Kotlin (#1793)
  • [doc] Main documentation on official ClickHouse website is updated. Each client has its own page with detailed information now. Added documentation for the Client V2. See https://clickhouse.com/docs/en/integrations/java.

Bug Fixes

  • [client-v2] Fix for cases when missing operation metrics were causing NPE. (#1846)
  • [client-v2] Fix for handling empty result by BinaryFormat readers. (#1845)
  • [jdbc] Content of an artifact 'clickhouse-jdbc-{version}-all.jar' is fixed and contains all required classes from clickhouse-client and clickhouse-data. (#1842)
  • [client-v1, jdbc] Endpoints definition parsing fixed to grub properties correctly. Now even properties with key-value pairs are supported. (#1841, #1665)

0.6.5

Deprecations

  • Following components will be deprecated and removed in 0.7.0 release:
    • clickhouse-cli-client
    • clickhouse-grpc-client
  • Projects cli-client and grpc-client are excluded from release and build.
  • No more builds for non-lts Java versions - no more Java 9 release builds.

Performance Improvements

  • [client-v2] queryAll() optimized to use less memory (#1779)
  • [client-v2] Client.Builder#setClientNetworkBufferSize introduced to allow increasing a buffer that is used to transfer data from socket buffer to application memory. When set to >= of send/receive socket buffer size it significantly reduces number of system calls and improves performance. (#1784)

New Features

  • [client-v2] Client will retry on NoHttpResponseException when using Apache HTTP client. It is useful when close/stale connection is leased from connection pool. No client will retry one more time instead of failing. Client.Builder#retryOnFailures and Client.Builder#setMaxRetries were introduced to configure client behavior. (#1768)

Bug Fixes

  • [client-v2] Correct timezone used when reading DateTime values. Affects how date/datetime values are read when session_timezone is used (#1780)
  • [client-v2] Fix reading big integers. Previously was causing incorrect values (#1786) (#1776)
  • [client-v2] Fix server compressions when using a client instance concurrently (#1791)
  • [client-v2] Fix reading arrays as list. Also affected reading nested arrays (#1800)
  • [client-v1] Fix handling summary metadata for write operations. Previously was causing empty metadata

0.6.4

Deprecations

  • Following components will be deprecated and archived in next release:
    • clickhouse-cli-client
    • clickhouse-grpc-client
  • No more builds for non-lts Java versions - no more Java 9 release builds.
  • Lowest supported Java version will be 11.
    • Java 11 support will be ended before the end of 2023.
    • It is recommended to use Java 21.

Important Changes

  • [Client-V1] Fix for handling DateTime without timezone when session_timezone is set. Now server timezone is parsed from server response when present (#1464)

New Features

  • [Client-V1/Apache HTTP] More configuration parameters for connection management. Useful for tuning performance. (#1771)
    • com.clickhouse.client.config.ClickHouseClientOption#CONNECTION_TTL - to configure connection time-to-live
    • com.clickhouse.client.http.config.ClickHouseHttpOption#KEEP_ALIVE_TIMEOUT - to configure keep-alive timeout
    • com.clickhouse.client.http.config.ClickHouseHttpOption#CONNECTION_REUSE_STRATEGY - defines how connection pool behaves. If FIFO is selected then connections are reused in the order they were created. It results in even distribution of connections. If LIFO is selected then connections are reused as soon they are returned to the pool. Note: only for APACHE_HTTP_CLIENT connection provider.
    • Additionally switched to using LAX connection pool for Apache Connection Manager to improve performance for concurrent requests.
  • [Client-V2] Connection pool configuration #1766
    • com.clickhouse.client.api.Client.Builder.setConnectionRequestTimeout - to configure connection request timeout. Important when there are no connections available in the pool to fail fast.
    • com.clickhouse.client.api.Client.Builder.setMaxConnections - configures how soft limit of connections per host. Note: Total number of connections is unlimited because in most cases there is one host.
    • com.clickhouse.client.api.Client.Builder.setConnectionTTL - to limit connection live ignoring keep-alive from server.
    • com.clickhouse.client.api.Client.Builder.setConnectionReuseStrategy - to configure how connections are used. Select FIFO to reuse connections evenly or LIFO (default) to reuse the most recently active connections.
  • [Client-V2] All operations are now executed in calling thread to avoid extra threads creation. Async operations can be enabled by com.clickhouse.client.api.Client.Builder.useAsyncRequests (#1767)
  • [Client-V2] Content and HTTP native compression is supported now Currently only LZ4 is available. (#1761)
  • [Client-V2] HTTPS support added. Required to communicate with ClickHouse Cloud Services. Client certificates are supported, too. (#1753)
  • [Client-V2] Added support for HTTP proxy (#1748)

Documentation

  • [Client-V2] Spring Demo Service as usage example (#1765)
  • [Client-V2] Examples for using text based formats (#1752)

Bug Fixes

  • [Client-V2] Data is read fully from a stream. Important for Cloud instances (#1759)
  • [Client-V2] Timezone from a server response is now used to parse DateTime values (#1763)
  • [Client-V1] Timezone from a server response is now used to parse DateTime values (#1464)

0.6.3

Important Changes

  • [Client-V1] Changed how User-Agent string is generated. Now ClickHouse-JavaClient portion is appended in all cases. It is still possible to set custom product name that will be the first part in User-Agent value. (#1698)

New Features

  • [Client-V1/Apache HTTP] Retry on NoHttpResponseException in Apache HTTP client. Should be used with causes because it is not always possible to resend request body. Behaviour is controlled by com.clickhouse.client.http.config.ClickHouseHttpOption#AHC_RETRY_ON_FAILURE. Works only for Apache HTTP client because based on its specific behavior(#1721)
  • [Client-V1/Apache HTTP] Connection validation before sending request. Behaviour is controlled by com.clickhouse.client.http.config.ClickHouseHttpOption#AHC_VALIDATE_AFTER_INACTIVITY. By default, connection is validated after being in the pool for 5 seconds. (#1722)

Bug Fixes

  • [Client-V2] Fix parsing endpoint URL to detect HTTPs (#1718)
  • [Client-V2] Fix handling asynchronous operations. Less extra threads created now. (#1691)
  • [Client-V2] Fix way of how settings are validated to let unsupported options to be added (#1691)
  • [Client-V1] Fix getting localhost effective IP address (#1729)
  • [Client-V2] Make client instance closeable to free underlying resource (#1733)

0.6.2

New Features

  • Describe non-executed SELECT queries in prepared statements to provide metadata (#1430)
  • Command execution in the client API (#1693)
  • Added com.clickhouse.client.ClickHouseResponseSummary#getQueryId() (#1636)
  • Added support for SSL for the Client V2
  • Added proxy support for Client V2 (#1694)
  • Added more examples for Client V2 (#1709)

0.6.1

New Features

Bug Fixes

  • Fix proper handling of ClickHouseResult to release DB connection (#1538
  • Fix getting response input stream for binary formats.
  • Exception context remove from a message. Server information not present anymore but available thru com.clickhouse.client.ClickHouseException#getServer (#1677)

0.6.0-patch5

Bug Fixes

  • Roles (memorized by client) can be reset with 'SET ROLE NONE' query (#1647)
  • MaxBufferSize can be greater than internal MAX value now
  • Updated example project to use the latest version of the client

0.6.0-patch4

New Features

  • Added possibility to set client ID in Referer HTTP Header (#1572)
  • [HTTP] Persistence of a role after it is set by SET ROLE <role>

Bug Fixes

  • Change RowBinaryWithDefaults settings. Output is changed from true to false
  • Fix fail over for Apache HTTP client. Connect timeout error is not detected correctly
  • Fix password logging in DEBUG (#1571)
  • Fix handling "NoHttpResponseException" in Apache HTTP client
  • Fix param error in ByteUtils#equals in java9

0.6.0-patch3

Bug Fixes

  • Not detecting correctly ClickHouse error code
  • Fix JDBC read error - Multidimensional empty errors raise a java.lang.ArrayStoreException

0.6.0-patch2

Dependency Updates

  • org.apache.commons:commons-compress from 1.23.0 to 1.26.1
  • org.postgresql:postgresql from 42.6.0 to 42.6.1

0.6.0-patch1

Bug Fixes

  • Fix buffering issue caused by decompress flag not to work when working with HTTP Client.

0.6.0

WARNING -- ClickHouse CLI Client deprecation

clickhouse-cli-client package is deprecated from version 0.6.0 and it's going to be removed in 0.7.0. We recommend using clickhouse-client instead.

WARNING -- ClickHouse GRPC Client deprecation

clickhouse-grpc-client package is deprecated from version 0.6.0 and it's going to be removed in 0.7.0. We recommend using HTTP protocol instead.

Breaking Changes

  • Remove WEB_CONTEXT support - #1512

New Features

  • Add support in RowBinaryWithDefaults #1508

Bug Fixes

  • Fix faulty node detection in ClickHouseNodes - #1595
  • Fix while getting addBatch with an exception drop the all batch #1373
  • Fix buffering issue caused by decompress flag not to work #1500

0.5.0

Breaking Changes

  • ClickHouseByteBuffer can no longer be extended
  • rename ClickHouseByteUtils methods by removing LE suffix
  • change default databaseTerm from schema to catalog
  • remove deprecated API load, dump and connect
  • remove use_no_proxy settings

New Features

  • Adding new proxy support #1338
  • Add support for customer socket factory #1391
  • use VarHandle in JDK 9+ to read/write numbers
  • Establish secured connection with custom Trust Store file
  • Change default HTTP Client to Apache HTTP client #1421

Bug Fixes

  • Java client threw confusing error when query is invalid.
  • JDBC Driver correctly processes AggregateFunction(Nested(...)) columns
  • Incorrect parameter position
  • Fix testing framework to support secured clickhouse server

0.4.6, 2023-05-02

New Features

  • ClickHouseStatement.setMirroredOutput() for dumping ResultSet.
  • ClickHouseResponse.records(Class<?>) for object mapping.
  • Two new options(use_compilation & max_mapper_cache) reserved for future usage.

Bug Fixes

  • Too many socket fds generated by Apache HttpClient.
  • NoClassDefFoundError with clickhouse-apache-http-client-jdbc. #1319
  • Nested array in tuple array is incorrectly deserialized. #1324
  • client certificate password exposure in exception. #1331

0.4.5, 2023-04-25

Breaking Changes

  • refactor data processors and response classes to ensure input stream remain intact before first read:
    • move ClickHouseSimpleRecord to com.clickhouse.data
    • stop reading input stream when instantiating ClickHouseDataProcessor
    • remove createRecord() method in ClickHouseDataProcessor along with some duplicated code

New Features

  • disable SQL rewrite for DELETE statement in ClickHouse 23.3+

Bug Fixes

  • Slow when using Apache Http Client. #1320
  • ClickHouseResponse.getInputStream may return closed input stream.
  • ConcurrentModificationException may occure during deserialization. #1327
  • ClickHouseSslContextProvider is not customizable. #1329

0.4.4, 2023-04-17

Bug Fixes

  • flatten plugin 1.4.1 generated non-sense dependencies.

0.4.3, 2023-04-17

New Features

  • replace JavaCC21 with CongoCC

Bug Fixes

  • unable to convert empty string to default value when using text-based data format.
  • r2dbc driver does not support most client options. #1299
  • incorrect content from Lz4InputStream when using text-based data format #48446

0.4.2, 2023-03-21

Breaking Changes

  • ClickHouseSqlStatement and *ParserHandler in JDBC driver were refactored to support compression and infile in insert statement.

New Features

  • centralized configuration for JDBC driver using custom server setting custom_jdbc_config.
  • support BEGIN TRANSACTION, COMMIT, and ROLLBACK in JDBC driver. #975
  • new options for JDBC driver
    • databaseTerm(catalog or schema, defaults to schema) #1273
    • externalDatabase(true or false, defaults to true) #1245
    • localFile(true of false, defaults to false) - whether to use local file for INFILE and OUTFILE or not

Bug Fixes

  • error while converting Nested values to Java maps.
  • incorrect algorithm extracted from PEM. #1274
  • transaction failure introduced 0.4.0.
  • respect node-specific credentials. #1114
  • USE statement does nothing. #1160
  • executeBatch does not support on cluster anymore. #1261

0.4.1, 2023-02-19

Breaking Changes

  • changed option names - #1203
    • compress_alogrithm -> compress_algorithm
    • decompress_alogrithm -> decompress_algorithm

New Features

  • added source in shaded jar for IDE friendly. #1217
  • iterable ClickHouseInputStream, which slightly improved performance of piping. #1238
  • ClickHouseOutputStream.transferBytes() is deprecated and it will be removed in 0.5.
  • read() and write() methods in ClickHouseClient - connect() is deprecated and it will be removed in 0.5.
  • make all dependencies of JDBC driver optional, along with configuration for building native binary. #1247

Bug Fixes

  • incorrect nested array value. #1221
  • incorrect nested array values. #1223
  • potential endless loop when handling batch update error. #1233
  • exception when deserializing Array(FixedString(2)) from RowBinary. #1235
  • deserialization failure of Nested data type. #1240 broken serde for Nested, which also impacted JSON. #1242
  • fix 64bit bitmap serialization issue. #641, #874, #1141
  • gRPC client may complete execution before closing response stream
  • throw StreamCorruptedException instead of generic IOException when deserialization failed (mostly due to server error)

0.4.0, 2023-01-19

Breaking Changes

  • refactored JdbcTypeMapping to make it extensible. #1075
  • removed legacy driver ru.yandex.*.#1089
  • removed most deprecated methods and class members
  • refactored data processor(for serialization and deserialization) and added new classes for unsigned types. #1124
  • refactored ClickHouseRequest/ClickHouseInputStream/ClickHouseOutputStream to better support compression. #1174, #1189
  • extracted clickhouse-data from clickhouse-client along with new packages. #1197 
    com.clickhouse.config  // generic configuration
com.clickhouse.data    // data processing utilities
com.clickhouse.logging // generic logging utility
  • added jdk17 in pom and changed build instructions 
    mvn -Dj8 clean install # for jdk8, it was 'mvn clean install'
mvn clean install # for jdk17, it was 'mvn -Drelease clean install'

New Features

  • added R2DBC driver. #914
  • enhanced ClickHouseClient for importing and exporting compressed file. #1004
  • added new option custom_settings. #1059
  • enhanced ClickHouseRequestManager to support query/session ID customization. #1074
  • added Apache HTTP Client 5 to support socket options. #1146
  • enhanced clickhouse-grpc-client to support request chunking and compression
    • decompress_alogrithm(request compression): BROTLI[-1,11], BZ2, DEFLATE[0,9], GZIP[-1,9], LZ4[0,18], XZ[0,9], ZSTD[0,22]
    • compress_alogrithm(response decompression): DEFLATE, LZ4, ZSTD Note: typo will be fixed in v0.4.1.
  • enhanced clickhouse-http-client to support zstd compression for both request and response
    • decompress_alogrithm(request compression): LZ4[0,18], ZSTD[0,22]
    • compress_alogrithm(response decompression): BROTLI, BZ2, DEFLATE, GZIP, LZ4, XZ, ZSTD Note: typo will be fixed in v0.4.1.
  • added stream-based prepared statement. #1163
  • browser-like client name (select distinct http_user_agent from system.query_log). #1182
  • enhanced ClickHouseRequest by treating input stream and ClickHouseWriter equally. #1200

Bug Fixes

  • not able to cancel query when there's session_id. #1035
  • overflow error when handling BigInteger and BigDecimal in ClickHouseLongValue. #1040
  • not handling SimpleAggregateFunction properly. #1054
  • DELETE FROM was rewritten to ALTER TABLE DELETE even when lightweight deletion was enabled. #1063
  • forced headless format for inserting. #1073
  • missing the verb "be" in error messages. #1137
  • write time field data loss precision. #1127
  • fixed a few copy-paste error causing problem handling Geo types