Add setting apply_settings_from_server

al13n321 · al13n321 · commit 1406c6533d00 · 2025-02-04T06:46:41.000Z
diff --git a/programs/client/Client.cpp b/programs/client/Client.cpp
@@ -484,15 +484,7 @@ void Client::connect()
             config().setString("host", connection_parameters.host);
             config().setInt("port", connection_parameters.port);
 
-            //github.com/ Apply setting changes received from server, but with lower priority than settings
-            //github.com/ changed from command line.
-            SettingsChanges settings_from_server = assert_cast<Connection &>(*connection).settingsFromServer();
-            const Settings & settings = global_context->getSettingsRef();
-            std::erase_if(settings_from_server, [&](const SettingChange & change)
-            {
-                return settings.isChanged(change.name);
-            });
-            global_context->applySettingsChanges(settings_from_server);
+            settings_from_server = assert_cast<Connection &>(*connection).settingsFromServer();
 
             break;
         }
diff --git a/src/Client/ClientBase.cpp b/src/Client/ClientBase.cpp
@@ -109,6 +109,7 @@ namespace Setting
     extern const SettingsBool partial_result_on_first_cancel;
     extern const SettingsBool throw_if_no_data_to_insert;
     extern const SettingsBool implicit_select;
+    extern const SettingsBool apply_settings_from_server;
 }
 
 namespace ErrorCodes
@@ -850,18 +851,8 @@ void ClientBase::setDefaultFormatsAndCompressionFromConfiguration()
             default_input_compression_method = chooseCompressionMethod(*file_name, "");
     }
 
-    format_max_block_size = getClientConfiguration().getUInt64("format_max_block_size", global_context->getSettingsRef()[Setting::max_block_size]);
-
-    //github.com/ Setting value from cmd arg overrides one from config
-    if (global_context->getSettingsRef()[Setting::max_insert_block_size].changed)
-    {
-        insert_format_max_block_size = global_context->getSettingsRef()[Setting::max_insert_block_size];
-    }
-    else
-    {
-        insert_format_max_block_size
-            = getClientConfiguration().getUInt64("insert_format_max_block_size", global_context->getSettingsRef()[Setting::max_insert_block_size]);
-    }
+    if (getClientConfiguration().has("insert_format_max_block_size"))
+        insert_format_max_block_size_from_config = getClientConfiguration().getUInt64("insert_format_max_block_size");
 }
 
 void ClientBase::initTTYBuffer(ProgressOption progress_option, ProgressOption progress_table_option)
@@ -1877,6 +1868,12 @@ void ClientBase::sendDataFrom(ReadBuffer & buf, Block & sample, const ColumnsDes
             current_format = insert->format;
     }
 
+    //github.com/ Setting value from cmd arg overrides one from config.
+    size_t insert_format_max_block_size = client_context->getSettingsRef()[Setting::max_insert_block_size];
+    if (!client_context->getSettingsRef()[Setting::max_insert_block_size].changed &&
+        insert_format_max_block_size_from_config.has_value())
+        insert_format_max_block_size = insert_format_max_block_size_from_config.value();
+
     auto source = client_context->getInputFormat(current_format, buf, sample, insert_format_max_block_size);
     Pipe pipe(source);
 
@@ -2131,6 +2128,8 @@ void ClientBase::processParsedSingleQuery(const String & full_query, const Strin
         if (!connection->checkConnected(connection_parameters.timeouts))
             connect();
 
+        applySettingsFromServerIfNeeded(); // after connect() and applySettingsFromQuery()
+
         ASTPtr input_function;
         const auto * insert = parsed_query->as<ASTInsertQuery>();
         if (insert && insert->select)
@@ -2766,6 +2765,29 @@ bool ClientBase::addMergeTreeSettings(ASTCreateQuery & ast_create)
     return added_new_setting;
 }
 
+void ClientBase::applySettingsFromServerIfNeeded()
+{
+    const Settings & settings = client_context->getSettingsRef();
+    SettingsChanges changes_to_apply;
+    for (const SettingChange & change : settings_from_server)
+    {
+        //github.com/ Apply settings received from server with lower priority than settings changed from
+        //github.com/ command line or query.
+        if (settings.isChanged(change.name))
+            continue;
+
+        //github.com/ The setting apply_settings_from_server may itself be received from server.
+        //github.com/ Apply it first.
+        if (change.name == "apply_settings_from_server")
+            client_context->setSetting("apply_settings_from_server", change.value);
+        else
+            changes_to_apply.push_back(change);
+    }
+
+    if (settings[Setting::apply_settings_from_server])
+        global_context->applySettingsChanges(changes_to_apply);
+}
+
 void ClientBase::startKeystrokeInterceptorIfExists()
 {
     if (keystroke_interceptor)
diff --git a/src/Client/ClientBase.h b/src/Client/ClientBase.h
@@ -229,6 +229,8 @@ class ClientBase
     void initQueryIdFormats();
     bool addMergeTreeSettings(ASTCreateQuery & ast_create);
 
+    void applySettingsFromServerIfNeeded();
+
     void startKeystrokeInterceptorIfExists();
     void stopKeystrokeInterceptorIfExists();
 
@@ -325,8 +327,7 @@ class ClientBase
     bool select_into_file = false; //github.com/ If writing result INTO OUTFILE. It affects progress rendering.
     bool select_into_file_and_stdout = false; //github.com/ If writing result INTO OUTFILE AND STDOUT. It affects progress rendering.
     bool is_default_format = true; //github.com/ false, if format is set in the config or command line.
-    size_t format_max_block_size = 0; //github.com/ Max block size for console output.
-    size_t insert_format_max_block_size = 0; //github.com/ Max block size when reading INSERT data.
+    std::optional<size_t> insert_format_max_block_size_from_config = 0; //github.com/ Max block size when reading INSERT data.
     size_t max_client_network_bandwidth = 0; //github.com/ The maximum speed of data exchange over the network for the client in bytes per second.
 
     bool has_vertical_output_suffix = false; //github.com/ Is \G present at the end of the query string?
@@ -377,6 +378,9 @@ class ClientBase
     String prompt;
     String server_display_name;
 
+    //github.com/ Settings received from the server, if any. Populated by connect().
+    SettingsChanges settings_from_server;
+
     ProgressIndication progress_indication;
     ProgressTable progress_table;
     bool need_render_progress = true;
diff --git a/src/Core/Settings.cpp b/src/Core/Settings.cpp
@@ -5896,6 +5896,9 @@ As each series represents a node in Keeper, it is recommended to have no more th
 )", 0) \
     DECLARE(Bool, use_hive_partitioning, true, R"(
 When enabled, ClickHouse will detect Hive-style partitioning in path (`/name=value/`) in file-like table engines [File](../../engines/table-engines/special/file.md#hive-style-partitioning)/[S3](../../engines/table-engines/integrations/s3.md#hive-style-partitioning)/[URL](../../engines/table-engines/special/url.md#hive-style-partitioning)/[HDFS](../../engines/table-engines/integrations/hdfs.md#hive-style-partitioning)/[AzureBlobStorage](../../engines/table-engines/integrations/azureBlobStorage.md#hive-style-partitioning) and will allow to use partition columns as virtual columns in the query. These virtual columns will have the same names as in the partitioned path, but starting with `_`.
+)", 0) \
+    DECLARE(Bool, apply_settings_from_server, true, R"(
+Whether the client should use the user settings from the the server configuration. This only affects operations performed on the client side, in particular parsing the INSERT input data and formatting the query result. Most of query execution happens on the server and is not affected by this setting. The settings are sent over network even if this setting is set to false; server setting send_settings_to_client can be used to disable it fully.
 )", 0) \
     \
     /* ####################################################### */ \
diff --git a/src/Core/SettingsChangesHistory.cpp b/src/Core/SettingsChangesHistory.cpp
@@ -67,6 +67,9 @@ const VersionToSettingsChangesMap & getSettingsChangesHistory()
         addSettingsChanges(settings_changes_history, "25.2",
         {
             {"query_plan_use_new_logical_join_step", false, true, "Enable new step"},
+            //github.com/ 24.12 and 25.1 don't have this setting but behave as if it's set to true.
+            //github.com/ Older versions behave as if it's set to false.
+            {"apply_settings_from_server", false, true, "Client-side code (e.g. INSERT input parsing and query output formatting) will use the same settings as the server, including settings from server config."},
         });
         addSettingsChanges(settings_changes_history, "25.1",
         {
diff --git a/tests/integration/test_settings_from_server/configs/users.d/users.xml b/tests/integration/test_settings_from_server/configs/users.d/users.xml
@@ -7,6 +7,14 @@
             <output_format_json_quote_64bit_integers>1</output_format_json_quote_64bit_integers>
             <output_format_json_array_of_rows>1</output_format_json_array_of_rows>
         </second_profile>
+        <no_apply_profile>
+            <output_format_json_quote_64bit_integers>0</output_format_json_quote_64bit_integers>
+            <apply_settings_from_server>0</apply_settings_from_server>
+        </no_apply_profile>
+        <compat_profile>
+            <output_format_json_quote_64bit_integers>0</output_format_json_quote_64bit_integers>
+            <compatibility>24.11</compatibility>
+        </compat_profile>
     </profiles>
     <users>
         <default>
@@ -17,5 +25,13 @@
             <password></password>
             <profile>second_profile</profile>
         </second_user>
+        <no_apply_user>
+            <password></password>
+            <profile>no_apply_profile</profile>
+        </no_apply_user>
+        <compat_user>
+            <password></password>
+            <profile>compat_profile</profile>
+        </compat_user>
     </users>
 </clickhouse>
diff --git a/tests/integration/test_settings_from_server/test.py b/tests/integration/test_settings_from_server/test.py
@@ -50,7 +50,7 @@ def test_settings_from_server(started_cluster):
     )
     assert "[" not in res, "should not be formatted as a JSON array"
 
-    # Setting changed by server but changed back client command line.
+    # Setting changed by server but changed back by client command line.
     res = node.query(
         "select 42::UInt64 as x format JSONEachRow",
         user="second_user",
@@ -66,6 +66,38 @@ def test_settings_from_server(started_cluster):
     assert res == "86400\n"
     node.query("drop user u")
 
+    # apply_settings_from_server = false
+    res = node.query("select 42::UInt64 as x settings apply_settings_from_server=0 format JSON")
+    assert '"x": "42"' in res, "should be quoted"
+
+    # apply_settings_from_server = false using SET query.
+    res = node.query("set apply_settings_from_server=0; select 42::UInt64 as x format JSON;")
+    assert '"x": "42"' in res, "should be quoted"
+
+    # apply_settings_from_server = false received from server.
+    res = node.query("select 42::UInt64 as x format JSON", user="no_apply_user")
+    assert '"x": "42"' in res, "should be quoted"
+
+    # apply_settings_from_server = false received from server but overridden by the query.
+    res = node.query("select 42::UInt64 as x settings apply_settings_from_server=1 format JSON", user="no_apply_user")
+    assert '"x": 42' in res, "should be unquoted"
+
+    # apply_settings_from_server = false implicitly set using compatibility setting.
+    res = node.query("select 42::UInt64 as x format JSON", user="compat_user")
+    assert '"x": "42"' in res, "should be quoted"
+
+    # apply_settings_from_server = false implicitly set using compatibility setting, but overridden by the query.
+    res = node.query("select 42::UInt64 as x settings apply_settings_from_server=1 format JSON", user="compat_user")
+    assert '"x": 42' in res, "should be unquoted"
+
+    # Multiple queries in one session with different value of apply_settings_from_server.
+    res = node.query("select 42::UInt64 as x settings apply_settings_from_server=0 format JSON; select 42::UInt64 as x format JSON;")
+    quoted_pos = res.find('"x": "42"')
+    unquoted_pos = res.find('"x": 42')
+    assert quoted_pos != -1, "first query should return quoted number"
+    assert unquoted_pos != -1, "second query should return unquoted number"
+    assert quoted_pos < unquoted_pos, "should be quoted for first query, unquoted for second"
+
     # send_settings_to_client = false
     res = node_no_send.query("select 42::UInt64 as x format JSON")
     assert '"x": "42"' in res, "should be quoted"

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,9 @@ const VersionToSettingsChangesMap & getSettingsChangesHistory()`
`67`	`67`	`addSettingsChanges(settings_changes_history, "25.2",`
`68`	`68`	`{`
`69`	`69`	`{"query_plan_use_new_logical_join_step", false, true, "Enable new step"},`
	`70`	`+ /// 24.12 and 25.1 don't have this setting but behave as if it's set to true.`
	`71`	`+ /// Older versions behave as if it's set to false.`
	`72`	`+ {"apply_settings_from_server", false, true, "Client-side code (e.g. INSERT input parsing and query output formatting) will use the same settings as the server, including settings from server config."},`
`70`	`73`	`});`
`71`	`74`	`addSettingsChanges(settings_changes_history, "25.1",`
`72`	`75`	`{`