Define a special connection type for ClickHouse

[babaralishah]

Hi!
I am on this issue for a few days but am unable to complete this task.
I am using apache airflow on docker.
I have installed the click house plugins in my container.
Now the issue that I am having is I am unable to see the connection type for the click house.
I have happily connected the MySql to the airflow, but I am unable to connect the click house to the airflow.
I have also attached some SS for a better understanding of my problem statement before u people.

[georborodin]

@babaralishah I've faced the same issue. Connection types are registered from provider.yaml files (like this). It is explained here in the official docs. Might be a good idea to create a community provider from this plugin, btw.

For now, the workaround would be be to create a new connection via API call or via CLI airflow connections add 'clickhouse_connection' --conn-uri 'clickhouse://user:password@host'. Bear in mind, that if you edit connection created this way in UI, it's connection type might be overwritten by whatever the UI shows.

[babaralishah]

@babaralishah I've faced the same issue. Connection types are registered from provider.yaml files (like this). It is explained here in the official docs. Might be a good idea to create a community provider from this plugin, btw.

For now, the workaround would be be to create a new connection via API call or via CLI airflow connections add 'clickhouse_connection' --conn-uri 'clickhouse://user:password@host'. Bear in mind, that if you edit connection created this way in UI, it's connection type might be overwritten by whatever the UI shows.

Hi!
I am unable to find the Airlfow Cli, what should i do now?
is it possible that i can run that in the cli of Docker?

[babaralishah]

I have ran these commands:
airflow connections add 'clickhouse_connection3' --conn-uri 'clickhouse+native://default@localhost:4040'
airflow connections add 'clickhouse_connection' --conn-uri 'clickhouse://default@localhost:4040'

and got the click house in the connections list but still unable to execute the queries, and getting this error:
clickhouse_driver.errors.NetworkError: Code: 210. Cannot assign requested address (localhost:4041)

[georborodin]

@babaralishah just docker exec that command in any container running Airflow.

[babaralishah]

@babaralishah just docker exec that command in any container running Airflow.

yeah ran that command:

[ne1r0n]

@babaralishah where is your ClickHouse server running? This plugin uses NATIVE clickhouse protocol, so most likely you should use port 9000 and make sure the server is available on localhost or use the correct host to connect. You can set the connection type to HTTP.

[babaralishah]

@babaralishah where is your ClickHouse server running? This plugin uses NATIVE clickhouse protocol, so most likely you should use port 9000 and make sure the server is available on localhost or use the correct host to connect. You can set the connection type to HTTP.

@ne1r0n
i have mentioned my ports of click house that is running in the docker

[bryzgaloff]

@babaralishah you should use not localhost but ClickHouse container IP to access it from another container (Airflow). localhost inside a container is a container itself. Read more about Docker network configuration.

@georborodin thank you for your help.

Looks like this is an issue with Airflow v2+. In case you are able to configure a connection provider and make a PR, I may review it. But please make sure to test it properly for different versions.

You may also use older versions of Airflow, e.g. v2.0–2.2 are confirmed to be supported.

[georborodin]

@bryzgaloff I would definitely be interested in contributing. If all goes well, I'll provide a PR in a couple of days, the process seems straightforward (at least now 😀).
Should I start a separate issue explaining the benefits of turning this plugin into a provider?

[bryzgaloff]

Should I start a separate issue explaining the benefits of turning this plugin into a provider?

Wow, will it change this plugin completely? I am not yet familiar with providers. Are they much different to plugins? I expected that you will have to only define some YAML file to let Airflow know details about new connection types.

[georborodin]

@bryzgaloff don't know for sure. If the route from docs is to be taken, the project layout will need changes as well as maybe migrating code to Airflow repo.

I think, that only the provider.yaml file might be enough, but haven't tested it yet.

[babaralishah]

It started working when I passed the connection type as Sqlite and the port that I have exposed to the click house is 9000

[bryzgaloff]

Thank you all for your feedback, connection-related instructions are now added to README: https://github.com/whisklabs/airflow-clickhouse-plugin/blob/master/README.md#how-to-create-an-airflow-connection-to-clickhouse

This issue is kept open till we define a special connection type for ClickHouse.