ClickHouse SQLAlchemy 项目使用教程

ClickHouse SQLAlchemy 项目使用教程

clickhouse-sqlalchemy ClickHouse dialect for SQLAlchemy 项目地址: https://gitcode.com/gh_mirrors/cl/clickhouse-sqlalchemy

1. 项目目录结构及介绍

ClickHouse SQLAlchemy 项目的主要目录结构如下：

clickhouse-sqlalchemy/
├── .github/              # GitHub 工作流和配置文件
├── clickhouse_sqlalchemy/ # 包含核心代码
│   ├── __init__.py
│   ├── ...              # 其他模块和类
├── docs/                 # 文档资料
├── tests/                # 测试用例
├── .gitignore            # Git 忽略文件列表
├── README.rst            # 项目说明文件
├── LICENSE               # 项目许可证文件
├── ChangLog.md           # 更新日志
└── ...                  # 其他文件和目录

• .github/: 存放 GitHub Actions 工作流文件，用于自动化测试、构建等操作。
• clickhouse_sqlalchemy/: 包含项目的核心代码，包括 SQLAlchemy 的 ClickHouse方言实现。
• docs/: 存放项目的文档资料。
• tests/: 存放项目的测试用例，确保代码质量。
• .gitignore: 定义了 Git 忽略的文件和目录。
• README.rst: 项目的基本介绍和说明。
• LICENSE: 项目的开源许可证信息。
• ChangLog.md: 记录了项目的更新历史。

2. 项目的启动文件介绍

项目的启动主要是通过 Python 的包管理来完成的。通常情况下，并不需要特定的启动文件，而是通过以下方式来使用：

from sqlalchemy import create_engine
from clickhouse_sqlalchemy import make_session, get_declarative_base
from clickhouse_sqlalchemy.engines import Memory

# 创建引擎
uri = 'clickhouse+native://localhost/default'
engine = create_engine(uri)

# 创建会话
session = make_session(engine)

# 创建基类
metadata = MetaData(bind=engine)
Base = get_declarative_base(metadata=metadata)

# 定义表结构
class Rate(Base):
    __tablename__ = 'rate'
    day = Column(types.Date, primary_key=True)
    value = Column(types.Int32)

    __table_args__ = (Memory(),)

# 创建表
Base.metadata.create_all(engine)

# 使用 session 执行数据库操作

以上代码展示了如何初始化项目并创建一个简单的表结构。

3. 项目的配置文件介绍

ClickHouse SQLAlchemy 项目的配置主要是通过 SQLAlchemy 的引擎 URI 来进行的。该 URI 包含了连接数据库所需的全部信息，例如：

uri = 'clickhouse+native://localhost/default'

在这个例子中，uri 是一个字符串，它指示了使用 ClickHouse 的原生驱动通过 TCP 连接到本地主机上的默认数据库。这个 URI 可以根据实际情况进行修改，以连接到不同的 ClickHouse 实例。

此外，如果需要配置其他选项，例如连接池大小、超时设置等，可以通过创建 create_engine 时传递额外的参数来实现：

engine = create_engine(uri, connect_args={'timeout': 10}, pool_size=10)

以上示例中，connect_args 用于传递给底层的数据库驱动，而 pool_size 用于设置连接池的大小。这些配置可以根据具体需求进行调整。

clickhouse-sqlalchemy ClickHouse dialect for SQLAlchemy 项目地址: https://gitcode.com/gh_mirrors/cl/clickhouse-sqlalchemy