Um exemplo prático de cliente Python para se conectar ao serviço ClickHouse Cloud

Aprenda a se conectar ao serviço ClickHouse Cloud usando Python com um exemplo passo a passo usando o driver clickhouse-connect.

Este é um exemplo passo a passo de como começar a usar Python com o serviço ClickHouse Cloud.

Tenha em mente que as versões do Python e as dependências das bibliotecas estão em constante evolução. Certifique-se também de usar as versões compatíveis mais recentes do driver e do ambiente Python ao testar isso.

No momento da redação deste artigo, estamos usando o driver clickhouse-connect na versão 0.5.23 e o Python 3.11.2.

​

Passos

1. Verifique a versão do Python:

$  python -V
Python 3.11.2

2. Vamos montar o projeto em uma pasta chamada ch-python:

$ mkdir ch-python
$ cd ch-python

3. Crie um arquivo de dependências chamado requirements.txt com:

clickhouse-connect==0.5.23

4. Crie um arquivo Python chamado main.py:

import clickhouse_connect
import sys
import json

CLICKHOUSE_CLOUD_HOSTNAME = 'HOSTNAME.clickhouse.cloud'
CLICKHOUSE_CLOUD_USER = 'default'
CLICKHOUSE_CLOUD_PASSWORD = 'YOUR_SECRET_PASSWORD'

client = clickhouse_connect.get_client(
    host=CLICKHOUSE_CLOUD_HOSTNAME, port=8443, username=CLICKHOUSE_CLOUD_USER, password=CLICKHOUSE_CLOUD_PASSWORD)

print("connected to " + CLICKHOUSE_CLOUD_HOSTNAME + "\n")
client.command(
    'CREATE TABLE IF NOT EXISTS new_table (key UInt32, value String, metric Float64) ENGINE MergeTree ORDER BY key')

print("table new_table created or exists already!\n")

row1 = [1000, 'String Value 1000', 5.233]
row2 = [2000, 'String Value 2000', -107.04]
data = [row1, row2]
client.insert('new_table', data, column_names=['key', 'value', 'metric'])

print("written 2 rows to table new_table\n")

QUERY = "SELECT max(key), avg(metric) FROM new_table"

result = client.query(QUERY)

sys.stdout.write("query: ["+QUERY + "] returns:\n\n")
print(result.result_rows)

5. Crie o ambiente virtual:

chpython$ python -m venv venv

6. Ative o ambiente virtual:

chpython$ source venv/bin/activate

Depois que o ambiente for carregado, o prompt do terminal deverá começar com (venv); instale as dependências:

(venv) ➜  chpython$ pip install -r requirements.txt
Collecting certifi
  Using cached certifi-2023.5.7-py3-none-any.whl (156 kB)
Collecting urllib3>=1.26
  Using cached urllib3-2.0.2-py3-none-any.whl (123 kB)
Collecting pytz
  Using cached pytz-2023.3-py2.py3-none-any.whl (502 kB)
Collecting zstandard
  Using cached zstandard-0.21.0-cp311-cp311-macosx_11_0_arm64.whl (364 kB)
Collecting lz4
  Using cached lz4-4.3.2-cp311-cp311-macosx_11_0_arm64.whl (212 kB)
Installing collected packages: pytz, zstandard, urllib3, lz4, certifi, clickhouse-connect
Successfully installed certifi-2023.5.7 clickhouse-connect-0.5.23 lz4-4.3.2 pytz-2023.3 urllib3-2.0.2 zstandard-0.21.0

7. Execute o código!

(venv) chpython$ venv/bin/python main.py

connected to HOSTNAME.clickhouse.cloud

table new_table created or exists already!

written 2 rows to table new_table

query: [SELECT max(key), avg(metric) FROM new_table] returns:

[(2000, -50.9035)]

Se você estiver usando uma versão mais antiga do Python (por exemplo, 3.9.6), poderá encontrar um ImportError relacionado à biblioteca urllib3. Nesse caso, atualize seu ambiente Python para uma versão mais recente ou fixe a versão de urllib3 em 1.26.15 no arquivo requirements.txt.