Skip to content

UDF: allow positional options for clickhouse-local and populate global udf settings #52643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robot-clickhouse-ci-1 merged 5 commits into from
Jul 28, 2023
Merged

UDF: allow positional options for clickhouse-local and populate global udf settings #52643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d35c87c
allow positional options for clickhouse-local and populate global udf…
yakov-olkhovskiy Jul 27, 2023
9d73be6
test is added
yakov-olkhovskiy Jul 27, 2023
8bba7ba
fix style
yakov-olkhovskiy Jul 27, 2023
b95745d
fix: check positional options
yakov-olkhovskiy Jul 27, 2023
5942c80
fix test: '--option' now is allowed after terminating '--'
yakov-olkhovskiy Jul 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions programs/local/LocalServer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,10 @@ void LocalServer::tryInitPath()

global_context->setUserFilesPath(""); // user's files are everywhere

std::string user_scripts_path = config().getString("user_scripts_path", fs::path(path) / "user_scripts/");
global_context->setUserScriptsPath(user_scripts_path);
fs::create_directories(user_scripts_path);

/// top_level_domains_lists
const std::string & top_level_domains_path = config().getString("top_level_domains_path", path + "top_level_domains/");
if (!top_level_domains_path.empty())
Expand Down Expand Up @@ -490,6 +494,17 @@ try

applyCmdSettings(global_context);

/// try to load user defined executable functions, throw on error and die
try
{
global_context->loadOrReloadUserDefinedExecutableFunctions(config());
}
catch (...)
{
tryLogCurrentException(&logger(), "Caught exception while loading user defined executable functions.");
throw;
}

if (is_interactive)
{
clearTerminal();
Expand Down
5 changes: 2 additions & 3 deletions src/Client/ClientBase.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2624,9 +2624,8 @@ void ClientBase::parseAndCheckOptions(OptionsDescription & options_description,
throw Exception(ErrorCodes::UNRECOGNIZED_ARGUMENTS, "Unrecognized option '{}'", unrecognized_options[0]);
}

/// Check positional options (options after ' -- ', ex: clickhouse-client -- <options>).
unrecognized_options = po::collect_unrecognized(parsed.options, po::collect_unrecognized_mode::include_positional);
if (unrecognized_options.size() > 1)
/// Check positional options.
if (std::ranges::count_if(parsed.options, [](const auto & op){ return !op.unregistered && op.string_key.empty() && !op.original_tokens[0].starts_with("--"); }) > 1)
throw Exception(ErrorCodes::BAD_ARGUMENTS, "Positional options are not supported.");

po::store(parsed, options);
Expand Down
2 changes: 0 additions & 2 deletions tests/queries/0_stateless/02096_bad_options_in_client_and_local.reference
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,3 @@ OK
OK
OK
OK
OK
OK
4 changes: 0 additions & 4 deletions tests/queries/0_stateless/02096_bad_options_in_client_and_local.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ ${CLICKHOUSE_LOCAL} --unknown-option 2>&1 | grep -F -q "UNRECOGNIZED_ARGUMENTS"

${CLICKHOUSE_LOCAL} --unknown-option-1 --unknown-option-2 2>&1 | grep -F -q "UNRECOGNIZED_ARGUMENTS" && echo "OK" || echo "FAIL"

${CLICKHOUSE_LOCAL} -- --unknown-option 2>&1 | grep -F -q "BAD_ARGUMENTS" && echo "OK" || echo "FAIL"

${CLICKHOUSE_LOCAL} -- 'positional-argument' 2>&1 | grep -F -q "BAD_ARGUMENTS" && echo "OK" || echo "FAIL"

${CLICKHOUSE_LOCAL} -f 2>&1 | grep -F -q "Bad arguments" && echo "OK" || echo "FAIL"
Expand All @@ -22,8 +20,6 @@ ${CLICKHOUSE_CLIENT} --unknown-option 2>&1 | grep -F -q "UNRECOGNIZED_ARGUMENTS"

${CLICKHOUSE_CLIENT} --unknown-option-1 --unknown-option-2 2>&1 | grep -F -q "UNRECOGNIZED_ARGUMENTS" && echo "OK" || echo "FAIL"

${CLICKHOUSE_CLIENT} -- --unknown-option 2>&1 | grep -F -q "BAD_ARGUMENTS" && echo "OK" || echo "FAIL"

${CLICKHOUSE_CLIENT} -- 'positional-argument' 2>&1 | grep -F -q "BAD_ARGUMENTS" && echo "OK" || echo "FAIL"

${CLICKHOUSE_CLIENT} --j 2>&1 | grep -F -q "Bad arguments" && echo "OK" || echo "FAIL"
Expand Down
1 change: 1 addition & 0 deletions tests/queries/0_stateless/02833_local_udf_options.reference
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
qwerty
11 changes: 11 additions & 0 deletions tests/queries/0_stateless/02833_local_udf_options.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/usr/bin/env bash

set -e

CUR_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
# shellcheck source=../shell_config.sh
. "$CUR_DIR"/../shell_config.sh

SCRIPTS_DIR=$CUR_DIR/scripts_udf

$CLICKHOUSE_LOCAL -q 'select test_function()' -- --user_scripts_path=$SCRIPTS_DIR --user_defined_executable_functions_config=$SCRIPTS_DIR/function.xml
9 changes: 9 additions & 0 deletions tests/queries/0_stateless/scripts_udf/function.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<functions>
<function>
<type>executable</type>
<name>test_function</name>
<return_type>String</return_type>
<format>TabSeparated</format>
<command>udf.sh</command>
</function>
</functions>
3 changes: 3 additions & 0 deletions tests/queries/0_stateless/scripts_udf/udf.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/sh

echo qwerty