本文介绍如何使用 ByteHouse HTTP Python Driver 驱动连接并访问 ByteHouse 云数仓。

请确保您使用的 ByteHouse Connect 和 Python 满足以下版本要求。

1. 您可以通过 pip 安装驱动。

   pip install bytehouse-connect
   

2. （可选）您也可以安装 cython 包来构建和启用 C/Cython 优化。

   pip install cython
   

可参考下面代码样例连接 ByteHouse。

import clickhouse_connect

client = clickhouse_connect.get_client(
    host="tenant-{TENANT_ID}-{REGION}-public.bytehouse.volces.com",
    port=8123,
    username="bytehouse",
    password="{API_KEY}",
    database="{DATABASE}",
    compress=False,
    secure=True,
    verify=False
)

连接 ByteHouse 后，您可以进行建表、数据读写等 DDL 操作，也可以进行查询设置，以下为简单的操作示例。

示例 1：建表、数据读写

• 使用client. order方法创建数据表

  client.command("CREATE TABLE IF NOT EXISTS test_table (key UInt32, value String, metric Float64) ENGINE = CnchMergeTree() ORDER BY tuple()")
  

• 使用client.insert 或 client.query写入/查询数据

  row1 = [1000, 'String Value 1000', 5.233]
  row2 = [2000, 'String Value 2000', -107.04]
  data = [row1, row2]
  client.insert('test_table', data, column_names=['key', 'value', 'metric'])
  
  result = client.query('SELECT max(key), avg(metric) FROM test_table')
  

示例 2：文件写入数据

from clickhouse_connect.driver.tools import insert_file

client.command("CREATE TABLE IF NOT EXISTS test_csv_table (key UInt32, value String) ENGINE = CnchMergeTree() ORDER BY tuple()")
insert_file(client, table='test_csv_table', file_path='data.csv', fmt='CSV')

示例 3：Session 参数设置

您可以通过 settings 参数设置 Session 级别参数，例如设置查询时使用的计算组。

client = clickhouse_connect.get_client(
    host="tenant-{TENANT_ID}-{REGION}-public.bytehouse.volces.com",
    port=8123,
    username="bytehouse",  
    password="{API_KEY}",  
    database="{DATABASE}",
    compress=False,
    secure=True,
    verify=False,
    settings={'virtual_warehouse':'your-vw-id'}
)

示例 4：Query 参数设置

settings = {'max_execution_time': 1000, 'session_id': 'session_1234'}
result = client.query("SELECT 1", settings=settings)