mirror of
https://github.com/CarmJos/MineSQL.git
synced 2024-09-19 20:25:45 +00:00
docs: 补充使用场景
This commit is contained in:
parent
5ecd7f54e2
commit
a461932135
50
README.md
50
README.md
@ -17,30 +17,47 @@
|
||||
|
||||
轻松(用)SQL的独立运行库插件,支持多种服务端,适用于MineCraft全版本。
|
||||
|
||||
## 使用场景
|
||||
## 优势
|
||||
|
||||
### 对于插件使用者
|
||||
### 对于服主 (插件使用者)
|
||||
|
||||
- 统一配置数据库连接,避免重复配置费时费力分神。
|
||||
- 支持更高级更全面的配置方式,以根据不同的使用场景独立优化[连接池配置](https://github.com/Chris2018998/BeeCP/wiki/Configuration--List)。
|
||||
- 使相关插件共用连接池,避免每个插件单独新开连接池导致资源的浪费。
|
||||
|
||||
### 对于插件开发者
|
||||
|
||||
- 基于 [EasySQL](https://github.com/CarmJos/EasySQL) 进行快捷的数据库操作。
|
||||
- 通过 `MineSQL.getRegistry().get(database-name)` 快捷获取数据源,避免繁琐的链接过程。
|
||||
- 详细的 DEBUG 方法,找到可恶的错误究竟在哪。
|
||||
- 不再需要打包各类JDBC-Driver、连接池依赖以及EasySQL本体到插件中。
|
||||
|
||||
### 额外提醒
|
||||
|
||||
- 使用本依赖时,请保证其他插件的来源安全,避免可能带来的数据安全风险。
|
||||
|
||||
## 安装
|
||||
|
||||
1. 从 [Releases(发行)](https://github.com/CarmJos/MineSQL/releases/) 中点击 [最新版](https://github.com/CarmJos/MineSQL/releases/latest) 下载 `MineSQL-x.y.z.jar` 。
|
||||
2. 将下载的 `MineSQL-x.y.z.jar` 放入服务器 `plugins/` 文件夹下。
|
||||
3. 启动服务器,预加载配置文件后关闭服务器。
|
||||
4. 修改 `plugins/MineSQL/config.yml` 以配置您的数据库选项。
|
||||
5. 启动服务器,若配置无误,则您会看到 MineSQL一切正常的提示消息。
|
||||
|
||||
## 配置
|
||||
|
||||
### 插件配置文件 [`config.yml`](minesql-core/src/main/resources/config.yml)
|
||||
### 插件配置文件 [`config.yml`](.doc/example-config.yml)
|
||||
|
||||
完整示例配置请见 [源文件](minesql-core/src/main/resources/config.yml)。
|
||||
完整示例配置请见 [示例配置文件](.doc/example-config.yml)。
|
||||
|
||||
#### MySQL/MariaDB 数据源详细配置示例
|
||||
|
||||
```yaml
|
||||
databases:
|
||||
sources:
|
||||
"mysql-database": # 数据源ID,建议全英文小写并以“-”分隔,例如:hello-minecraft
|
||||
# 数据库驱动类型
|
||||
# 若您的数据库为 mariadb,则强烈推荐设置为 mariadb
|
||||
driver-type: mysql
|
||||
type: mysql
|
||||
host: 127.0.0.1 # 数据库地址
|
||||
port: 3306 # 数据库端口
|
||||
database: minecraft # 数据库库名
|
||||
@ -51,20 +68,21 @@ databases:
|
||||
#### h2 数据源详细配置示例
|
||||
|
||||
```yaml
|
||||
databases:
|
||||
"h2-database": # 数据源ID,建议全小写以“-”分隔,例如:hello-minecraft
|
||||
driver-type: h2
|
||||
# h2数据库运行模式
|
||||
# 可选 file(文件模式) 与 mem(内存模式)
|
||||
# 文件模式下,须指定 file-path ,以服务器运行目录为基准,支持绝对路径和相对路径。
|
||||
# 内存模式下,所有数据库都将存储在内存中,一旦关服则数据将全部丢失,该模式一般用于测试
|
||||
mode: file # 可选 mem(内存) file(文件) ;内存模式
|
||||
sources:
|
||||
# h2数据库运行模式
|
||||
# 可选 h2-file(文件模式) 与 h2-mem(内存模式)
|
||||
# 文件模式下,须指定 file路径 ,以服务器运行目录为基准,支持绝对路径和相对路径。
|
||||
# 内存模式下,所有数据库都将存储在内存中,一旦关服则数据将全部丢失,该模式一般用于测试
|
||||
"h2-file-db": # 数据源ID,建议全小写以“-”分隔,例如:hello-minecraft
|
||||
type: h2-file
|
||||
file-path: "db-files/minecraft"
|
||||
"h2-mem-db": # 数据源ID,建议全小写以“-”分隔,例如:hello-minecraft
|
||||
type: h2-mem
|
||||
```
|
||||
|
||||
### Properties 配置文件 [`<插件目录>/db-properties/*.properties`](minesql-core/src/main/resources/db-properties/.example-mysql.properties)
|
||||
### Properties 配置文件 [`<插件目录>/db-properties/*.properties`](core/src/main/resources/db-properties/.example-mysql.properties)
|
||||
|
||||
示例配置请见 [示例MySQL数据源Properties](minesql-core/src/main/resources/db-properties/.example-mysql.properties)。
|
||||
示例配置请见 [示例MySQL数据源Properties](core/src/main/resources/db-properties/.example-mysql.properties)。
|
||||
|
||||
Properties 文件的文件名几位数据源的ID,允许为英文、数字、下划线、短横线;请不要包含中文、其他特殊符号与空格,以`.`开头的文件将被忽略。
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user