Rollback gzip compression, only keep the setting

slabko · slabko · commit 12ed3ab995ac · 2025-11-02T20:19:52.000+01:00
Rename `Compress` setting to `Compression`
diff --git a/README.md b/README.md
@@ -111,7 +111,7 @@ The list of DSN parameters recognized by the driver is as follows:
 |     `DriverLogFile`     |               `\temp\clickhouse-odbc-driver.log`  on Windows, `/tmp/clickhouse-odbc-driver.log` otherwise                | Path to the extended driver log file (used when `DriverLog` is `on`)                                                                                                                                                                                                                                                                                                                                                         |
 |     `AutoSessionId`     |                                                          `off`                                                           | Auto generate session_id required to use some features of CH (e.g. TEMPORARY TABLE)                                                                                                                                                                                                                                                                                                                                          |
 |      `ClientName`       |                                                          empty                                                           | Sets additional information about the calling application. This string will be used as a prefix for the User-Agent header.                                                                                                                                                                                                                                                                                                   |
-|       `Compress`        |                                                          `off`                                                           | Pass enable_http_compression=1 parameter to server                                                                                                                                                                                                                                                                                                                                                                           |
+|      `Compression`      |                                                          `off`                                                           | Enables compression for data sent from ClickHouse to the driver                                                                                                                                                                                                                                                                                                                                                              |
 
 
 ### URL query string
diff --git a/driver/config/config.cpp b/driver/config/config.cpp
@@ -254,8 +254,7 @@ key_value_map_t readDSNInfo(const std::string & dsn_utf8) {
             INI_DRIVERLOGFILE,
             INI_AUTO_SESSION_ID,
             INI_CLIENT_NAME,
-            INI_COMPRESS,
-            INI_USE_COMPRESSION
+            INI_COMPRESSION
         }
     ) {
         if (
diff --git a/driver/config/ini_defines.h b/driver/config/ini_defines.h
@@ -33,8 +33,7 @@
 #define INI_DRIVERLOGFILE   "DriverLogFile"
 #define INI_AUTO_SESSION_ID "AutoSessionId"
 #define INI_CLIENT_NAME     "ClientName"
-#define INI_COMPRESS        "Compress"
-#define INI_USE_COMPRESSION "UseCompression"
+#define INI_COMPRESSION     "Compression"
 
 #if defined(UNICODE)
 #   define INI_DSN_DEFAULT          DSN_DEFAULT_UNICODE
@@ -56,8 +55,7 @@
 #define INI_STRINGMAXLENGTH_DEFAULT "1048575"
 #define INI_AUTO_SESSION_ID_DEFAULT "off"
 #define INI_CLIENT_NAME_DEFAULT     ""
-#define INI_COMPRESS_DEFAULT        "0"
-#define INI_USE_COMPRESSION_DEFAULT "0"
+#define INI_COMPRESSION_DEFAULT     "0"
 
 #ifdef NDEBUG
 #    define INI_DRIVERLOG_DEFAULT "off"
diff --git a/driver/connection.cpp b/driver/connection.cpp
@@ -105,6 +105,9 @@ Poco::URI Connection::getUri() const {
         else if (Poco::UTF8::icompare(parameter.first, "session_id") == 0 && !parameter.second.empty()) {
             session_id_set = true;
         }
+        else if (Poco::UTF8::icompare(parameter.first, "enable_http_compression") == 0 && !parameter.second.empty()) {
+            enable_http_compression_set = true;
+        }
     }
 
     if (!default_format_set)
@@ -119,6 +122,7 @@ Poco::URI Connection::getUri() const {
         uri.addQueryParameter("session_id", session_id);
     }
 
+    // Add http compression parameter, but only if the parameter is not already defined in the URI
     if (enable_http_compression && !enable_http_compression_set) {
         uri.addQueryParameter("enable_http_compression", enable_http_compression ? "1" : "0");
     }
@@ -414,7 +418,7 @@ void Connection::setConfiguration(const key_value_map_t & cs_fields, const key_v
                 client_name = value;
             }
         }
-        else if (Poco::UTF8::icompare(key, INI_COMPRESS) == 0 || Poco::UTF8::icompare(key, INI_USE_COMPRESSION) == 0) {
+        else if (Poco::UTF8::icompare(key, INI_COMPRESSION) == 0) {
             recognized_key = true;
             unsigned int typed_value = 0;
             valid_value =
@@ -445,8 +449,6 @@ void Connection::setConfiguration(const key_value_map_t & cs_fields, const key_v
             const auto & recognized_key = std::get<0>(res);
             const auto & valid_value = std::get<1>(res);
 
-            // LOG("DSN: known attribute '" << key << "', valid value, '" << valid_value << "'");
-
             if (recognized_key) {
                 if (!valid_value)
                     throw std::runtime_error("DSN: bad value '" + value + "' for attribute '" + key + "'");
diff --git a/driver/format/ODBCDriver2.cpp b/driver/format/ODBCDriver2.cpp
@@ -263,15 +263,6 @@ ODBCDriver2ResultReader::ODBCDriver2ResultReader(
     result_set = std::make_unique<ODBCDriver2ResultSet>(timezone, stream, releaseMutator());
 }
 
-ODBCDriver2ResultReader::ODBCDriver2ResultReader(const std::string & timezone_, std::istream & raw_stream, std::unique_ptr<ResultMutator> && mutator, std::unique_ptr<std::istream> && inflating_input_stream)
-  : ResultReader(timezone_, raw_stream, std::move(mutator), std::move(inflating_input_stream))
-{
-    if (stream.eof())
-        return;
-
-    result_set = std::make_unique<ODBCDriver2ResultSet>(timezone, stream, releaseMutator());
-}
-
 bool ODBCDriver2ResultReader::advanceToNextResultSet() {
     // ODBCDriver2 format doesn't support multiple result sets in the response,
     // so only a basic cleanup is done here.
diff --git a/driver/format/ODBCDriver2.h b/driver/format/ODBCDriver2.h
@@ -1,5 +1,6 @@
 #pragma once
 
+#include "driver/platform/platform.h"
 #include "driver/result_set.h"
 
 #include <Poco/Net/HTTPClientSession.h>
diff --git a/driver/format/RowBinaryWithNamesAndTypes.cpp b/driver/format/RowBinaryWithNamesAndTypes.cpp
@@ -319,16 +319,6 @@ RowBinaryWithNamesAndTypesResultReader::RowBinaryWithNamesAndTypesResultReader(
     result_set = std::make_unique<RowBinaryWithNamesAndTypesResultSet>(timezone, stream, releaseMutator());
 }
 
-RowBinaryWithNamesAndTypesResultReader::RowBinaryWithNamesAndTypesResultReader(const std::string & timezone_, std::istream & raw_stream, std::unique_ptr<ResultMutator> && mutator, std::unique_ptr<std::istream> && inflating_input_stream)
-  : ResultReader(timezone_, raw_stream, std::move(mutator), std::move(inflating_input_stream))
-{
-    if (stream.eof())
-        return;
-
-    result_set = std::make_unique<RowBinaryWithNamesAndTypesResultSet>(timezone, stream, releaseMutator());
-
-}
-
 bool RowBinaryWithNamesAndTypesResultReader::advanceToNextResultSet() {
     // RowBinaryWithNamesAndTypes format doesn't support multiple result sets in the response,
     // so only a basic cleanup is done here.
diff --git a/driver/result_set.cpp b/driver/result_set.cpp
@@ -1,5 +1,4 @@
 #include "driver/result_set.h"
-#include "driver/driver.h"
 #include "driver/format/ODBCDriver2.h"
 #include "driver/format/RowBinaryWithNamesAndTypes.h"
 
@@ -314,13 +313,6 @@ ResultReader::ResultReader(
 {
 }
 
-ResultReader::ResultReader(const std::string & timezone_, std::istream & raw_stream, std::unique_ptr<ResultMutator> && mutator, std::unique_ptr<std::istream> && inflating_input_stream_)
-    : timezone(timezone_)
-    , stream(raw_stream, std::move(inflating_input_stream_))
-    , result_mutator(std::move(mutator))
-{
-}
-
 bool ResultReader::hasResultSet() const {
     return static_cast<bool>(result_set);
 }
diff --git a/driver/result_set.h b/driver/result_set.h
@@ -169,8 +169,7 @@ std::unique_ptr<ResultReader> make_result_reader(
 );
 
 template <typename ConversionContext>
-SQLRETURN Field::extract(BindingInfo & binding_info, ConversionContext && context) const
-{
+SQLRETURN Field::extract(BindingInfo & binding_info, ConversionContext && context) const {
     return std::visit([&binding_info, &context] (auto & value) {
         if constexpr (std::is_same_v<DataSourceType<DataSourceTypeId::Nothing>, std::decay_t<decltype(value)>>) {
             return fillOutputNULL(binding_info.value, binding_info.value_max_size, binding_info.indicator);
diff --git a/driver/statement.cpp b/driver/statement.cpp
@@ -134,7 +134,6 @@ void Statement::requestNextPackOfResultSets(std::unique_ptr<ResultMutator> && mu
     request.setHost(uri.getHost());
     request.setURI(uri.getPathEtc());
     request.set("User-Agent", connection.buildUserAgentString());
-    request.set("Accept-Encoding", "gzip, deflate");
 
     LOG(request.getMethod() << " " << request.getHost() << request.getURI() << " body=" << prepared_query
                             << " UA=" << request.get("User-Agent"));
diff --git a/driver/test/misc_it.cpp b/driver/test/misc_it.cpp
@@ -264,14 +264,7 @@ INSTANTIATE_TEST_SUITE_P(
 
         std::make_tuple("AllGood_ClientName_Empty", "ClientName=",   FailOn::Never),
         std::make_tuple("AllGood_ClientName_Plain",  "ClientName=TestApp/0.1 (TestOS)",   FailOn::Never),
-        std::make_tuple("AllGood_ClientName_Wrapped", "ClientName={TestApp/0.1; (TestOS)}",  FailOn::Never),
-
-        std::make_tuple("AllGood_Compress_Empty", "Compress=",   FailOn::Never),
-        std::make_tuple("AllGood_Compress_On",  "Compress=on",   FailOn::Never),
-        std::make_tuple("AllGood_Compress_Off", "Compress=off",  FailOn::Never),
-        std::make_tuple("AllGood_UseCompression_Empty", "UseCompression=",   FailOn::Never),
-        std::make_tuple("AllGood_UseCompression_On",  "UseCompression=on",   FailOn::Never),
-        std::make_tuple("AllGood_UseCompression_Off", "UseCompression=off",  FailOn::Never)
+        std::make_tuple("AllGood_ClientName_Wrapped", "ClientName={TestApp/0.1; (TestOS)}",  FailOn::Never)
     ),
     [] (const auto & param_info) {
         return std::get<0>(param_info.param);
diff --git a/driver/utils/amortized_istream_reader.h b/driver/utils/amortized_istream_reader.h
@@ -22,11 +22,6 @@ class AmortizedIStreamReader
     {
     }
 
-    explicit AmortizedIStreamReader(std::istream & raw_stream, std::unique_ptr<std::istream> stream_holder)
-        : raw_stream_(raw_stream), stream_holder_(std::move(stream_holder))
-    {
-    }
-
     ~AmortizedIStreamReader() {
         // Put back any pre-read characters, just in case...
         // (it should be done in reverse order)
@@ -139,5 +134,4 @@ class AmortizedIStreamReader
     Poco::Net::HTTPClientSession & session_;
     std::size_t offset_ = 0;
     std::string buffer_;
-    std::unique_ptr<std::istream> stream_holder_;  // can be empty if ownership is managed externally
 };
diff --git a/packaging/odbc.ini.sample b/packaging/odbc.ini.sample
@@ -42,7 +42,7 @@ Description = DSN (localhost) for ClickHouse ODBC Driver (ANSI)
 #                               # Path to the extended driver log file
 # AutoSessionId = off           # Auto generate session_id required to use some features of CH (e.g. TEMPORARY TABLE)
 # ClientName =                  # Sets additional information about the calling application. This string will be used as a prefix for the User-Agent header.
-# Compress = off                # Pass enable_http_compression=1 parameter to server
+# Compression = off             # Enables compression for data sent from ClickHouse to the driver
 
 [ClickHouse DSN (Unicode)]
 Driver      = ClickHouse ODBC Driver (Unicode)

Original file line number	Diff line number	Diff line change
`@@ -105,6 +105,9 @@ Poco::URI Connection::getUri() const {`
`105`	`105`	`else if (Poco::UTF8::icompare(parameter.first, "session_id") == 0 && !parameter.second.empty()) {`
`106`	`106`	`session_id_set = true;`
`107`	`107`	`}`
	`108`	`+ else if (Poco::UTF8::icompare(parameter.first, "enable_http_compression") == 0 && !parameter.second.empty()) {`
	`109`	`+ enable_http_compression_set = true;`
	`110`	`+ }`
`108`	`111`	`}`
`109`	`112`
`110`	`113`	`if (!default_format_set)`
`@@ -119,6 +122,7 @@ Poco::URI Connection::getUri() const {`
`119`	`122`	`uri.addQueryParameter("session_id", session_id);`
`120`	`123`	`}`
`121`	`124`
	`125`	`+ // Add http compression parameter, but only if the parameter is not already defined in the URI`
`122`	`126`	`if (enable_http_compression && !enable_http_compression_set) {`
`123`	`127`	`uri.addQueryParameter("enable_http_compression", enable_http_compression ? "1" : "0");`
`124`	`128`	`}`
`@@ -414,7 +418,7 @@ void Connection::setConfiguration(const key_value_map_t & cs_fields, const key_v`
`414`	`418`	`client_name = value;`
`415`	`419`	`}`
`416`	`420`	`}`
`417`		`- else if (Poco::UTF8::icompare(key, INI_COMPRESS) == 0 \|\| Poco::UTF8::icompare(key, INI_USE_COMPRESSION) == 0) {`
	`421`	`+ else if (Poco::UTF8::icompare(key, INI_COMPRESSION) == 0) {`
`418`	`422`	`recognized_key = true;`
`419`	`423`	`unsigned int typed_value = 0;`
`420`	`424`	`valid_value =`
`@@ -445,8 +449,6 @@ void Connection::setConfiguration(const key_value_map_t & cs_fields, const key_v`
`445`	`449`	`const auto & recognized_key = std::get<0>(res);`
`446`	`450`	`const auto & valid_value = std::get<1>(res);`
`447`	`451`
`448`		`- // LOG("DSN: known attribute '" << key << "', valid value, '" << valid_value << "'");`
`449`		`-`
`450`	`452`	`if (recognized_key) {`
`451`	`453`	`if (!valid_value)`
`452`	`454`	`throw std::runtime_error("DSN: bad value '" + value + "' for attribute '" + key + "'");`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`#include "driver/result_set.h"`
`2`		`-#include "driver/driver.h"`
`3`	`2`	`#include "driver/format/ODBCDriver2.h"`
`4`	`3`	`#include "driver/format/RowBinaryWithNamesAndTypes.h"`
`5`	`4`
`@@ -314,13 +313,6 @@ ResultReader::ResultReader(`
`314`	`313`	`{`
`315`	`314`	`}`
`316`	`315`
`317`		`-ResultReader::ResultReader(const std::string & timezone_, std::istream & raw_stream, std::unique_ptr<ResultMutator> && mutator, std::unique_ptr<std::istream> && inflating_input_stream_)`
`318`		`- : timezone(timezone_)`
`319`		`- , stream(raw_stream, std::move(inflating_input_stream_))`
`320`		`- , result_mutator(std::move(mutator))`
`321`		`-{`
`322`		`-}`
`323`		`-`
`324`	`316`	`bool ResultReader::hasResultSet() const {`
`325`	`317`	`return static_cast<bool>(result_set);`
`326`	`318`	`}`