Skip to content

Commit 5ef6bc2

Browse files
authored
docs: add database creation tips (#449)
添加创建数据库的提示。 Fixes #336 ```release-note None ```
1 parent e4edfed commit 5ef6bc2

File tree

5 files changed

+43
-17
lines changed

5 files changed

+43
-17
lines changed

docs/getting-started/install/docker-compose.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,14 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
226226
# 端口号 默认8090
227227
- --server.port=8090
228228
```
229+
230+
:::info
231+
使用外部数据库时,需要提前手动创建好数据库,以 MySQL 为例:
232+
233+
```sql
234+
create database halo character set utf8mb4 collate utf8mb4_bin;
235+
```
236+
:::
229237
</TabItem>
230238
</Tabs>
231239

docs/getting-started/install/jar-file.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,26 +110,31 @@ title: 使用 JAR 文件部署
110110
111111
数据库配置说明:
112112
113-
| 参数名 | 描述 |
114-
|----------------------------|-------------------------------------------------------|
115-
| `spring.r2dbc.url` | 数据库连接地址,详细可查阅下方的 `配置对应关系` |
116-
| `spring.r2dbc.username` | 数据库用户名 |
117-
| `spring.r2dbc.password` | 数据库密码 |
113+
| 参数名 | 描述 |
114+
| -------------------------- | ----------------------------------------------------------- |
115+
| `spring.r2dbc.url` | 数据库连接地址,详细可查阅下方的 `配置对应关系` |
116+
| `spring.r2dbc.username` | 数据库用户名 |
117+
| `spring.r2dbc.password` | 数据库密码 |
118118
| `spring.sql.init.platform` | 数据库平台名称,支持 `postgresql`、`mysql`、`mariadb`、`h2` |
119119

120120
配置对应关系:
121121

122122
| 链接方式 | 链接地址格式 | `spring.sql.init.platform` |
123-
|-------------|------------------------------------------------------------------------------------|----------------------------|
123+
| ----------- | ---------------------------------------------------------------------------------- | -------------------------- |
124124
| PostgreSQL | `r2dbc:pool:postgresql://{HOST}:{PORT}/{DATABASE}` | postgresql |
125125
| MySQL | `r2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}` | mysql |
126-
| MariaDB | `r2dbc:pool:mariadb://{HOST}:{PORT}/{DATABASE}` | mariadb |
126+
| MariaDB | `r2dbc:pool:mariadb://{HOST}:{PORT}/{DATABASE}` | mariadb |
127127
| H2 Database | `r2dbc:h2:file:///${halo.work-dir}/db/halo-next?MODE=MySQL&DB_CLOSE_ON_EXIT=FALSE` | h2 |
128128

129129
:::info
130130
- HOST:数据库服务地址,如 `localhost`
131131
- PORT:数据库服务端口,如 `3306`
132-
- DATABASE:数据库名称,如 `halo`,需要提前创建
132+
- DATABASE:数据库名称,如 `halo`,需要提前创建,以 MySQL 为例:
133+
134+
```sql
135+
create database halo character set utf8mb4 collate utf8mb4_bin;
136+
```
137+
133138
:::
134139

135140
:::warning

docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ const config = {
189189
prism: {
190190
theme: darkCodeTheme,
191191
darkTheme: darkCodeTheme,
192-
additionalLanguages: ["java"],
192+
additionalLanguages: ["java","sql"],
193193
},
194194
zoom: {
195195
selector: ".markdown :not(a) > img",

versioned_docs/version-2.20/getting-started/install/docker-compose.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,14 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
226226
# 端口号 默认8090
227227
- --server.port=8090
228228
```
229+
230+
:::info
231+
使用外部数据库时,需要提前手动创建好数据库,以 MySQL 为例:
232+
233+
```sql
234+
create database halo character set utf8mb4 collate utf8mb4_bin;
235+
```
236+
:::
229237
</TabItem>
230238
</Tabs>
231239

versioned_docs/version-2.20/getting-started/install/jar-file.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,26 +110,31 @@ title: 使用 JAR 文件部署
110110
111111
数据库配置说明:
112112
113-
| 参数名 | 描述 |
114-
|----------------------------|-------------------------------------------------------|
115-
| `spring.r2dbc.url` | 数据库连接地址,详细可查阅下方的 `配置对应关系` |
116-
| `spring.r2dbc.username` | 数据库用户名 |
117-
| `spring.r2dbc.password` | 数据库密码 |
113+
| 参数名 | 描述 |
114+
| -------------------------- | ----------------------------------------------------------- |
115+
| `spring.r2dbc.url` | 数据库连接地址,详细可查阅下方的 `配置对应关系` |
116+
| `spring.r2dbc.username` | 数据库用户名 |
117+
| `spring.r2dbc.password` | 数据库密码 |
118118
| `spring.sql.init.platform` | 数据库平台名称,支持 `postgresql`、`mysql`、`mariadb`、`h2` |
119119

120120
配置对应关系:
121121

122122
| 链接方式 | 链接地址格式 | `spring.sql.init.platform` |
123-
|-------------|------------------------------------------------------------------------------------|----------------------------|
123+
| ----------- | ---------------------------------------------------------------------------------- | -------------------------- |
124124
| PostgreSQL | `r2dbc:pool:postgresql://{HOST}:{PORT}/{DATABASE}` | postgresql |
125125
| MySQL | `r2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}` | mysql |
126-
| MariaDB | `r2dbc:pool:mariadb://{HOST}:{PORT}/{DATABASE}` | mariadb |
126+
| MariaDB | `r2dbc:pool:mariadb://{HOST}:{PORT}/{DATABASE}` | mariadb |
127127
| H2 Database | `r2dbc:h2:file:///${halo.work-dir}/db/halo-next?MODE=MySQL&DB_CLOSE_ON_EXIT=FALSE` | h2 |
128128

129129
:::info
130130
- HOST:数据库服务地址,如 `localhost`
131131
- PORT:数据库服务端口,如 `3306`
132-
- DATABASE:数据库名称,如 `halo`,需要提前创建
132+
- DATABASE:数据库名称,如 `halo`,需要提前创建,以 MySQL 为例:
133+
134+
```sql
135+
create database halo character set utf8mb4 collate utf8mb4_bin;
136+
```
137+
133138
:::
134139

135140
:::warning

0 commit comments

Comments
 (0)