YaSQL 项目使用教程

YaSQL 项目使用教程

YaSQL 基于Django框架开发的DB工单审核、执行、查询的平台 项目地址: https://gitcode.com/gh_mirrors/ya/YaSQL

1. 项目的目录结构及介绍

YaSQL/
├── bin/
│   └── yasql
├── conf/
│   ├── config.json
│   └── logging.conf
├── docs/
│   └── README.md
├── lib/
│   └── yasql.jar
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
├── .gitignore
├── LICENSE
└── README.md

目录结构介绍

• bin/: 存放可执行文件，如 yasql。
• conf/: 存放项目的配置文件，如 config.json 和 logging.conf。
• docs/: 存放项目的文档文件，如 README.md。
• lib/: 存放项目的依赖库文件，如 yasql.jar。
• src/: 存放项目的源代码文件，包括 main/ 和 test/ 两个子目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

启动文件

• bin/yasql: 这是一个可执行脚本，用于启动 YaSQL 项目。通常情况下，执行该脚本即可启动项目。

启动步骤

1. 进入项目根目录。
2. 执行 ./bin/yasql 命令启动项目。

3. 项目的配置文件介绍

配置文件

• conf/config.json: 这是 YaSQL 项目的主要配置文件，包含了数据库连接信息、日志配置等。
• conf/logging.conf: 这是 YaSQL 项目的日志配置文件，用于配置日志的输出格式、级别等。

配置文件示例

config.json

{
  "database": {
    "url": "jdbc:mysql://localhost:3306/yasql",
    "username": "root",
    "password": "password"
  },
  "logging": {
    "level": "INFO",
    "file": "logs/yasql.log"
  }
}

logging.conf

[loggers]
keys=root

[handlers]
keys=consoleHandler,fileHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=INFO
handlers=consoleHandler,fileHandler

[handler_consoleHandler]
class=StreamHandler
level=INFO
formatter=simpleFormatter
args=(sys.stdout,)

[handler_fileHandler]
class=FileHandler
level=INFO
formatter=simpleFormatter
args=('logs/yasql.log', 'a')

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s

配置文件说明

• config.json:

  • database: 配置数据库连接信息，包括 URL、用户名和密码。
  • logging: 配置日志级别和日志文件路径。

• logging.conf:

  • 配置日志的输出格式、级别、以及日志文件的存储位置。

通过以上配置文件，可以灵活地调整 YaSQL 项目的运行参数和日志输出。

YaSQL 基于Django框架开发的DB工单审核、执行、查询的平台 项目地址: https://gitcode.com/gh_mirrors/ya/YaSQL