Implement GRPC protocol. by vitlibar · Pull Request #15111 · ClickHouse/ClickHouse

vitlibar · 2020-09-21T22:19:33Z

I hereby agree to the terms of the CLA available at: https://yandex.ru/legal/cla/?lang=en

Changelog category:

New Feature

Changelog entry:
Implement gRPC protocol in ClickHouse.

For the specification of the protocol see clickhouse_grpc.proto

To use the protocol first set grpc_port in the main configuration file, and then you can either write a client in any of the programming languages supported by gRPC by using the provided schema or use the built-in client utils/grpc-client/clickhouse-grpc-client.py. The built-in client is operated very likely to clickhouse-client, for example

utils/grpc-client/clickhouse-grpc-client.py -q "SELECT sum(number) FROM numbers(10)"

cat a.txt | utils/grpc-client/clickhouse-grpc-client.py -q "INSERT INTO temp FORMAT TSV"

and so on. Without parameters it runs the built-in client in the interactive mode.

The implementation of gRPC protocol also supports compression, SSL, getting progress and logs, authentication, parallel queries through the same channel, cancellation of queries, sessions, external tables.

performance comparison

This PR is to finish the work started by @mnkonkova (#10136)

…rom musl 1.2.1.

…d_unwind@GLIBC_PRIVATE and to fix shared build.

…nt with asan.

vitlibar · 2020-11-25T06:00:21Z

test_storage_rabbitmq/test.py::test_rabbitmq_csv_with_delimiter will be fixed in #17311

alexey-milovidov · 2020-11-26T05:30:43Z

programs/CMakeLists.txt

 add_subdirectory (install)
 add_subdirectory (git-import)

+#add_subdirectory (grpc-client)


Can I build it?

It's an old test which Maria used to test the grpc protocol for the first time. It cannot be build currently. I didn't fix it because grpc protocol can be invoked directly from python so we don't need a C++ client to test in our integration tests that grpc protocol works.

I didn't remove the sources of the target grpc-client because I was thinking about converting it into C++ client like clickhouse-client, but then I wrote a gRPC client in python, so now I don't think we need the target grpc-client and I suppose we can remove it.

I removed this target in #17435

alexey-milovidov · 2020-11-26T05:33:55Z

programs/grpc-client/grpc_client.cpp

+        std::unique_ptr<GRPCConnection::GRPC::Stub> stub_;
+};
+
+int main(int argc, char** argv)


Ok, it's just a test, maybe better move to tests subdirectory somewhere.

alexey-milovidov · 2020-11-26T05:34:38Z

programs/server/config.xml

+    <!-- gRPC protocol (see src/Server/grpc_protos/clickhouse_grpc.proto for the API)
+    <grpc_port>9001</grpc_port>
+    <grpc>
+        <enable_ssl>true</enable_ssl> -->


This --> is strange.

xml doesn't support nested comments.

Yes, but it looks like you close this comment too early.

What do you think about this style?

It looks surprising to the reader, I'm sure almost no one will understand it from the first glance.

alexey-milovidov · 2020-11-26T05:35:11Z

src/Core/include/config_core.h

@@ -0,0 +1,13 @@
+#pragma once


Accidentially committed?

Removed in #17435

alexey-milovidov · 2020-11-26T05:35:36Z

src/Interpreters/ClientInfo.h

    {
        TCP = 1,
        HTTP = 2,
+        GRPC = 3,


What about MySQL and PostgreSQL interfaces?

alexey-milovidov · 2020-11-26T05:38:31Z

tests/integration/test_grpc_protocol_ssl/configs/grpc_config.xml

@@ -0,0 +1,24 @@
+<yandex>
+    <grpc_port>9001</grpc_port>


Maybe change all ports to 9100?
Because 9001 is often used for second ClickHouse instance if multiple instances are run on the same server.

Changed in #17435

alexey-milovidov · 2020-11-26T05:41:08Z

programs/server/config.xml

+    <grpc_port>9001</grpc_port>
+    <grpc>
+        <enable_ssl>true</enable_ssl> -->
+


Trailing whitespaces.

alexey-milovidov · 2020-11-26T05:42:52Z

$ ./clickhouse-grpc-client.py
'list' object has no attribute 'join'

Bye

    <!-- gRPC protocol (see src/Server/grpc_protos/clickhouse_grpc.proto for the API) -->
    <grpc_port>9001</grpc_port>
    <grpc>
        <enable_ssl>false</enable_ssl>
        
        <!-- The following two files are used only if enable_ssl=1
        <ssl_cert_file>/path/to/ssl_cert_file</ssl_cert_file>
        <ssl_key_file>/path/to/ssl_key_file</ssl_key_file> -->
        
        <!-- Whether server will request client for a certificate
        <ssl_require_client_auth>true</ssl_require_client_auth> -->
        
        <!-- The following file is used only if ssl_require_client_auth=1
        <ssl_ca_cert_file>/path/to/ssl_ca_cert_file</ssl_ca_cert_file> -->
        
        <!-- Default compression algorithm (applied if client doesn't specify another algorithm).
             Supported algorithms: none, deflate, gzip, stream_gzip
        <compression>gzip</compression> -->

        <!-- Default compression level (applied if client doesn't specify another level).
             Supported levels: none, low, medium, high
        <compression_level>high</compression_level> -->

        <!-- Send/receive message size limits in bytes. -1 means unlimited
        <max_send_message_size>-1</max_send_message_size>
        <max_receive_message_size>4194304</max_receive_message_size> -->
    </grpc>

vitlibar · 2020-11-26T07:42:23Z

$ ./clickhouse-grpc-client.py
'list' object has no attribute 'join'

There was a small mistake in error-handling in this python script, and you have to install grpcio-tools: pip3 install grpcio-tools. Fixed in dbd1366

alexey-milovidov · 2020-11-28T05:50:19Z

Wow, it works!

Does not look polished though:

$ ./clickhouse-grpc-client.py
Connecting to localhost:9100 as user default.
Connected to ClickHouse server version 20.13.1.1 via gRPC protocol in 0.0042569637298583984.
grpc :) SELECT 1
┌─1─┐
│ 1 │
└───┘

Elapsed: 0.002447843551635742 sec.

grpc :) SELECT count() FROM system.numbers
^CCancelling query.
Query was cancelled.
grpc :) SELECT count() FROM test.hits
┌─count()─┐
│ 8873898 │
└─────────┘

Elapsed: 0.002803325653076172 sec.

grpc :) SELECT uniq(*) FROM test.hits
┌─uniq(WatchID, JavaEnable, Title, GoodEvent, EventTime, EventDate, CounterID, ClientIP, ClientIP6, RegionID, UserID, CounterClass, OS, UserAgent, URL, Referer, URLDomain, RefererDomain, Refresh, IsRobot, RefererCategories, URLCategories, URLRegions, RefererRegions, ResolutionWidth, ResolutionHeight, ResolutionDepth, FlashMajor, FlashMinor, FlashMinor2, NetMajor, NetMinor, UserAgentMajor, UserAgentMinor, CookieEnable, JavascriptEnable, IsMobile, MobilePhone, MobilePhoneModel, Params, IPNetworkID, TraficSourceID, SearchEngineID, SearchPhrase, AdvEngineID, IsArtifical, WindowClientWidth, WindowClientHeight, ClientTimeZone, ClientEventTime, SilverlightVersion1, SilverlightVersion2, SilverlightVersion3, SilverlightVersion4, PageCharset, CodeVersion, IsLink, IsDownload, IsNotBounce, FUniqID, HID, IsOldCounter, IsEvent, IsParameter, DontCountHits, WithHash, HitColor, UTCEventTime, Age, Sex, Income, Interests, Robotness, GeneralInterests, RemoteIP, RemoteIP6, WindowName, OpenerName, HistoryLength, BrowserLanguage, BrowserCountry, SocialNetwork, SocialAction, HTTPError, SendTiming, DNSTiming, ConnectTiming, ResponseStartTiming, ResponseEndTiming, FetchTiming, RedirectTiming, DOMInteractiveTiming, DOMContentLoadedTiming, DOMCompleteTiming, LoadEventStartTiming, LoadEventEndTiming, NSToDOMContentLoadedTiming, FirstPaintTiming, RedirectCount, SocialSourceNetworkID, SocialSourcePage, ParamPrice, ParamOrderID, ParamCurrency, ParamCurrencyID, GoalsReached, OpenstatServiceName, OpenstatCampaignID, OpenstatAdID, OpenstatSourceID, UTMSource, UTMMedium, UTMCampaign, UTMContent, UTMTerm, FromTag, HasGCLID, RefererHash, URLHash, CLID, YCLID, ShareService, ShareURL, ShareTitle, ParsedParams.Key1, ParsedParams.Key2, ParsedParams.Key3, ParsedParams.Key4, ParsedParams.Key5, ParsedParams.ValueDouble, IslandID, RequestNum, RequestTry)─┐
│                                                                                                                                                                                                                                                    8904699 │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

Elapsed: 2.339322566986084 sec.

grpc :)

robot-clickhouse added doc-alert pr-feature Pull request with new product feature labels Sep 21, 2020

vitlibar marked this pull request as draft September 21, 2020 22:21

vitlibar mentioned this pull request Sep 21, 2020

A prototype implementation of GRPC protocol in ClickHouse. #10136

Closed

vitlibar force-pushed the grpc-protocol branch from 5d056cf to f6a1954 Compare September 21, 2020 22:26

vitlibar force-pushed the grpc-protocol branch from f6a1954 to 49de752 Compare September 30, 2020 22:33

robot-clickhouse added the submodule changed At least one submodule changed in this PR. label Sep 30, 2020

vitlibar force-pushed the grpc-protocol branch 2 times, most recently from 6aed8d0 to 62a14e8 Compare October 4, 2020 04:21

robot-clickhouse removed the submodule changed At least one submodule changed in this PR. label Oct 4, 2020

vitlibar force-pushed the grpc-protocol branch 12 times, most recently from 9790b74 to 8af548f Compare October 7, 2020 16:58

robot-clickhouse added the submodule changed At least one submodule changed in this PR. label Oct 7, 2020

vitlibar force-pushed the grpc-protocol branch 2 times, most recently from 215fda4 to c429ce0 Compare October 7, 2020 22:19

robot-clickhouse added submodule changed At least one submodule changed in this PR. and removed submodule changed At least one submodule changed in this PR. labels Oct 8, 2020

vitlibar force-pushed the grpc-protocol branch 3 times, most recently from 95f5366 to 63e11d8 Compare October 13, 2020 01:27

Vitaly Baranov added 12 commits November 24, 2020 17:55

Added support for external tables.

a0e384b

Add test for authentication.

950bccb

Implemented clickhouse grpc client.

1bd19bb

Add comments desribing the protocol.

be056a9

glibc-compatibility: Add eventfd(), eventfd_read(), eventfd_write() f…

d949898

…rom musl 1.2.1.

glibc-compatibility: Add epoll_create1() from musl 1.2.1.

fc67aae

glibc-compatibility: Add accept4() from musl 1.2.1.

a61359c

glibc-compatibility: Add getauxval().

3253a52

glibc-compatibility: Add secure_getenv().

7b0f94b

Fork abseil-cpp to remove dependency on errno@GLIBC_PRIVATE, __pthrea…

a32ed23

…d_unwind@GLIBC_PRIVATE and to fix shared build.

Redirect stderr, stdout for clickhouse-odbc-bridge to files.

3c85165

Disable running test test_odbc_interaction.test_bridge_dies_with_pare…

4b34889

…nt with asan.

vitlibar force-pushed the grpc-protocol branch from 2c4c896 to 4b34889 Compare November 24, 2020 14:55

vitlibar merged commit 08b3707 into ClickHouse:master Nov 25, 2020

alexey-milovidov mentioned this pull request Nov 26, 2020

Switch upstream repo for Arrow submodule #16664

Merged

alexey-milovidov reviewed Nov 26, 2020

View reviewed changes

vitlibar mentioned this pull request Nov 26, 2020

Implement GRPC protocol (corrections) #17435

Merged

alexey-milovidov mentioned this pull request Nov 26, 2020

HTTP Server-Sent Events #6294

Closed

lehasm mentioned this pull request Nov 14, 2021

DOCSUP-13314: document GRPC protocol support #31407

Merged

azat mentioned this pull request Jan 24, 2022

Fix getauxval() in glibc-compatibility and fix some leaks (after LSan started to work) #33957

Merged

Conversation

vitlibar commented Sep 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vitlibar commented Nov 25, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vitlibar Nov 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vitlibar Nov 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vitlibar Nov 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexey-milovidov commented Nov 26, 2020

Uh oh!

vitlibar commented Nov 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alexey-milovidov commented Nov 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vitlibar commented Sep 21, 2020 •

edited

Loading

vitlibar Nov 26, 2020 •

edited

Loading

vitlibar Nov 26, 2020 •

edited

Loading

vitlibar Nov 26, 2020 •

edited

Loading

vitlibar commented Nov 26, 2020 •

edited

Loading

alexey-milovidov commented Nov 28, 2020 •

edited

Loading