PolarDB-X SQL 项目教程

PolarDB-X SQL 项目教程

polardbx-sql 项目地址: https://gitcode.com/gh_mirrors/pol/polardbx-sql

1. 项目目录结构及介绍

PolarDB-X SQL 是 PolarDB-X 分布式数据库的计算节点（Compute Node），负责 SQL 解析、优化和执行等核心功能。项目的目录结构如下：

• APP-META/：包含项目的元数据信息。
• docker-config/：包含 Docker 相关的配置文件。
• environment/：包含项目运行所需的环境配置文件。
• server/：包含服务端的代码和配置文件。
• .github/：包含 GitHub Actions 相关的配置文件。
• .mvn/：包含 Maven 项目的配置文件。
• codestyle/：包含代码风格相关的配置文件。
• docs/：包含项目文档。
• polardbx-calcite/：包含 Calcite 相关的代码。
• polardbx-common/：包含项目公共部分的代码。
• polardbx-executor/：包含执行器相关的代码。
• polardbx-gms/：包含全局元服务（Global Meta Service）相关的代码。
• polardbx-net/：包含网络通信相关的代码。
• polardbx-optimizer/：包含优化器相关的代码。
• polardbx-orc-tools/：包含 ORC 文件处理相关的工具代码。
• polardbx-orc/：包含 ORC 文件存储相关的代码。
• polardbx-parser/：包含 SQL 解析器相关的代码。
• polardbx-rpc/：包含远程过程调用（RPC）相关的代码。
• polardbx-rule/：包含数据分片规则相关的代码。
• polardbx-server/：包含服务端启动和运行相关的代码。
• polardbx-test/：包含项目测试相关的代码。
• polardbx-transaction/：包含分布式事务相关的代码。
• script/：包含项目脚本文件。
• .dockerignore：包含 Docker 构建时需要忽略的文件。
• .gitignore：包含 Git 忽略的文件。
• .gitmodules：包含项目子模块的配置信息。
• CONTRIBUTING.md：包含贡献指南。
• LICENSE：包含项目许可证信息。
• NOTICE：包含项目通知信息。
• README.md：包含项目简介和说明。
• docker_build.sh：包含 Docker 镜像构建脚本。
• mvnw：包含 Maven 命令行工具。
• pom.xml：包含 Maven 项目描述文件。
• saveVersion.sh：包含版本保存脚本。

2. 项目的启动文件介绍

PolarDB-X SQL 项目的启动主要依赖于 polardbx-server 目录下的启动脚本。以下是主要的启动文件：

• polardbx-server.sh：Linux 系统下的启动脚本，用于启动 PolarDB-X SQL 服务。
• polardbx-server.bat：Windows 系统下的启动脚本，用于启动 PolarDB-X SQL 服务。

启动脚本会调用 Maven 命令来启动服务，确保在执行启动脚本前已经正确配置了 Maven 环境和项目依赖。

3. 项目的配置文件介绍

PolarDB-X SQL 项目的配置主要通过 server/ 目录下的配置文件进行。以下是主要的配置文件：

• application.properties：项目的核心配置文件，包含数据库连接信息、服务端口、日志级别等基本配置。
• config.properties：包含项目的高级配置，如缓存设置、线程池配置等。
• log4j2.xml：日志配置文件，用于配置日志输出格式、日志级别和日志文件存储位置。

在修改配置文件后，需要重启 PolarDB-X SQL 服务以使配置生效。在配置过程中，请确保遵循项目的最佳实践和配置指南。

polardbx-sql 项目地址: https://gitcode.com/gh_mirrors/pol/polardbx-sql