# clickhouse-query

**Repository Path**: angryshan/clickhouse-query

## Basic Information

- **Project Name**: clickhouse-query
- **Description**: ClickHouse查询构建器，基于PDO+MySQL协议连接，提供链式API的ClickHouse查询解决方案
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-10
- **Last Updated**: 2025-08-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ClickHouse查询构建器

## 功能

* 基于链式API的ClickHouse查询构建
* 表结构映射和字段管理
* 数据库连接管理和并发控制
* 统一的异常处理机制

## 环境要求

* php >= 7.4
* hyperf >= 2.0
* thinkphp >= 6.0

## 安装

```bash
composer require angryshan/clickhouse-query -vvv
```

## 配置文件

发布配置文件`config/clickhouse.php`

```bash
php bin/hyperf.php vendor:publish angryshan/clickhouse-query
php think vendor:publish
```

或者复制以下内容到`config/clickhouse.php`
```
<?php

return [
    // 连接池名称
    'pool_name' => 'clickhouse',
    
    // 连接控制
    'connection_control' => [
        // 最大并发查询数
        'max_running_processes' => 5,
        
        // 最大等待尝试次数
        'max_wait_attempts' => 60,
        
        // 最小等待时间（微秒）
        'wait_min_microseconds' => 500000,
        
        // 最大等待时间（微秒）
        'wait_max_microseconds' => 1000000,
    ],
    
    // 全局查询条件
    'global_conditions' => [
        // 示例: 'game_id' => 1, 
    ],
]; 
```

## 使用示例

### 基础查询

```php
use ClickHouseQuery\Database\QueryBuilder\ClickHouseQueryBuilder;
use ClickHouseQuery\Tables\AbstractTable;

// 定义表
class BusinessTable extends AbstractTable
{
    protected string $tableName = 'business_table';
}

// 创建查询构建器
$table = new BusinessTable();
$builder = new ClickHouseQueryBuilder($table->getTableName());

// 执行查询
try {
    $result = $builder
        ->select(['id', 'name'])
        ->where(['status' => 1])
        ->get();
        
    // 处理结果...
    
} catch (Exception $e) {
    // 异常处理
}
```

### 复杂查询

```php
$result = $builder
    ->select(['department', 'COUNT(*) as count'])
    ->where([
        'status' => 1,
        'created_at >' => '2024-01-01'
    ])
    ->groupBy(['department'])
    ->orderBy('count', 'DESC')
    ->limit(10)
    ->get();
```

## 注意事项

* 必须使用 try-catch 处理异常
* 查询执行后自动重置状态
* WHERE条件需使用数组格式
* 字段名需符合ClickHouse规范

## 文档说明

更多详细信息请参考代码内的注释和类文档。

## 许可证

MIT 许可证（MIT）。有关更多信息，请参见[协议文件](LICENSE)。