Skip to content
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.

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

Added connection string to clickhouse-client #50689

Merged
merged 16 commits into from
Jun 14, 2023

Conversation

Demilivor
Copy link
Contributor

@Demilivor Demilivor commented Jun 8, 2023

Closes #29880

Connection string syntax:

clickhouse://[user_info@][hosts_and_ports][/dbname][?query_parameters]

The connection string must be passed as first argument to clickhouse-client. It can be combined with arbitrary other command line options except --host(h) and --port.

Examples

clickhouse-client "clickhouse://localhost:9000/my_database" --query "SELECT 1"
clickhouse-client "clickhouse://localhost:9000" --user default
clickhouse-client "clickhouse://some_user%40some_mail.com:secret@localhost:9000" # %40 encodes @

**Known issues**
Currently, a password in the connection string and an empty password passed via `--password` makes the client ignore the password:

``` bash
clickhouse-client "clickhouse://user_with_password:secret@/" --password
# clickhouse response:
ClickHouse client version 23.5.1.1.
Password for user (user_with_password): 

Error has the same root cause as: #50459. Internally, the connection string is converted to command line options.

Changelog category (leave one):

  • New Feature

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

clickhouse-client can now be called with a connection instead of "--host", "--port", "--user" etc.

@Demilivor
Copy link
Contributor Author

Demilivor commented Jun 8, 2023

Good day @rschu1ze please be reviewer of this pull request and add a label 'can be tested'.

@rschu1ze rschu1ze self-assigned this Jun 8, 2023
@robot-ch-test-poll robot-ch-test-poll added the pr-feature Pull request with new product feature label Jun 8, 2023
@robot-ch-test-poll
Copy link
Contributor

robot-ch-test-poll commented Jun 8, 2023

This is an automated comment for commit 4db8fa3 with description of existing statuses. It's updated for the latest CI running
The full report is available here
The overall status of the commit is 🔴 failure

Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help🟢 success
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR🟢 success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process🟢 success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help🟢 success
Docker image for serversThe check to build and optionally push the mentioned image to docker hub🟢 success
Docs CheckBuilds and tests the documentation🟢 success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here🟢 success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc🟢 success
Install packagesChecks that the built packages are installable in a clear environment🟢 success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests🟢 success
Mergeable CheckChecks if all other necessary checks are successful🟢 success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests🟢 success
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub🟢 success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool🟢 success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed🟢 success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc🟢 success
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc🔴 failure
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors🟢 success
Style CheckRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report🟢 success
Unit testsRuns the unit tests for different release types🟢 success
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts🟢 success

@rvasin

This comment was marked as outdated.

@rschu1ze rschu1ze added the can be tested Allows running workflows for external contributors label Jun 8, 2023
@rschu1ze

This comment was marked as outdated.

@rvasin

This comment was marked as outdated.

Copy link
Member

@rschu1ze rschu1ze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't looked at the C++ uri parsing code and the test yet but my first impression is positive. Thanks!

docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
src/Client/ConnectionString.cpp Show resolved Hide resolved
src/Client/ConnectionString.cpp Outdated Show resolved Hide resolved
src/Client/ConnectionString.cpp Show resolved Hide resolved
programs/client/Client.cpp Outdated Show resolved Hide resolved
programs/client/Client.cpp Outdated Show resolved Hide resolved
@Demilivor
Copy link
Contributor Author

I didn't have time to finish the changes today. I plan to finish and update on Tuesday.

I'm still not sure about the renaming:

user_info->userspec
hosts_and_ports->hostspec
 query_parameters->paramspec

Also not sure about disabling --user(-u), --password and --database(d) along with the connection string

I'm planning a couple more changes:
Prohibit the use of --connection client option along with connection string.
If user_info is username:@. It has ':' but the password is empty, then client will ask the user for the password in the same way:
clickhouse-client --user username --password

Copy link
Member

@rschu1ze rschu1ze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The remaining comments are minor and of cosmetic nature. Besides them, everything looks good, thanks!

docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
docs/en/interfaces/cli.md Outdated Show resolved Hide resolved
docs/en/interfaces/cli.md Show resolved Hide resolved
src/Client/ConnectionString.cpp Outdated Show resolved Hide resolved
src/Client/ConnectionString.cpp Outdated Show resolved Hide resolved
src/Client/ConnectionString.cpp Outdated Show resolved Hide resolved
src/Client/ConnectionString.cpp Outdated Show resolved Hide resolved
else
{
// in case of user_info == 'user:', ':' is specified, but password is empty
// then add password argument "\n" which means: Ask user for a password.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. Didn't know that clickhouse-client had such a shortcut.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small inline question about constants:
Should we add public constant constexpr std::string_view ASK_USER_PASSWORD = "\n"sv somewhere in ClientBase.h?
Using "\n" as a special case for password requires adding comments in several parts of code, it is not oblivious for other non-familiar developers with code base what does "\n" means without comments.
ASK_USER_PASSWORD.

Copy link
Member

@rschu1ze rschu1ze Jun 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that would be a good idea. But it is not urgent, totally fine to do this in some follow-up PR (e.g. here: #50966)

@rschu1ze rschu1ze merged commit 2643fd2 into ClickHouse:master Jun 14, 2023
259 of 265 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
can be tested Allows running workflows for external contributors pr-feature Pull request with new product feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ClickHouse connection strings
4 participants