Skip to content

Use asciidoc variables refine version switch #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hs-liuxh wants to merge 1 commit into
base: v5.1
Choose a base branch
from
Open

Use asciidoc variables refine version switch #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CN/antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,16 @@ asciidoc:
attributes:
source-language: asciidoc@
table-caption: false
ivorysql-version: 5.1
pg-version: 18.1
package-link: 'https://github.com/ivorysql/ivorysql'
package-link-x86_64-deb: 'IvorySQL-5.1-62069c2-20251211.amd64.deb'
package-link-x86_64-rpm: 'IvorySQL-5.1-62069c2-20251211.x86_64.rpm'
package-link-aarch64-deb: 'IvorySQL-5.1-62069c2-20251211.arm64.deb'
package-link-aarch64-rpm: 'IvorySQL-5.1-62069c2-20251211.aarch64.rpm'
package-link-mips64el-deb: 'IvorySQL-5.1-62069c2-20251211.mips64el.deb'
package-link-mips64el-rpm: 'IvorySQL-5.1-62069c2-20251211.mips64el.rpm'
package-link-loongarch64-deb: 'IvorySQL-5.1-62069c2-20251211.loongarch64.deb'
package-link-loongarch64-rpm: 'IvorySQL-5.1-62069c2-20251211.loongarch64.rpm'
nav:
- modules/ROOT/nav.adoc
150 changes: 75 additions & 75 deletions CN/modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,90 +1,90 @@
* IvorySQL
** xref:v5.1/welcome.adoc[欢迎]
** xref:v5.1/1.adoc[发行说明]
** xref:v5.1/2.adoc[关于IvorySQL]
** xref:v{ivorysql-version}/welcome.adoc[欢迎]
** xref:v{ivorysql-version}/1.adoc[发行说明]
** xref:v{ivorysql-version}/2.adoc[关于IvorySQL]
** IvorySQL入门
*** xref:v5.1/3.1.adoc[快速开始]
*** xref:v5.1/3.2.adoc[日常监控]
*** xref:v5.1/3.3.adoc[日常维护]
*** xref:v{ivorysql-version}/3.1.adoc[快速开始]
*** xref:v{ivorysql-version}/3.2.adoc[日常监控]
*** xref:v{ivorysql-version}/3.3.adoc[日常维护]
** IvorySQL高级
*** xref:v5.1/4.1.adoc[安装指南]
*** xref:v5.1/4.2.adoc[集群搭建]
*** xref:v5.1/4.5.adoc[迁移指南]
*** xref:v5.1/4.3.adoc[开发者指南]
*** xref:v{ivorysql-version}/4.1.adoc[安装指南]
*** xref:v{ivorysql-version}/4.2.adoc[集群搭建]
*** xref:v{ivorysql-version}/4.5.adoc[迁移指南]
*** xref:v{ivorysql-version}/4.3.adoc[开发者指南]
*** 容器化指南
**** xref:v5.1/4.6.1.adoc[K8S部署]
**** xref:v5.1/4.6.2.adoc[Operator部署]
**** xref:v5.1/4.6.4.adoc[Docker & Podman部署]
**** xref:v5.1/4.6.3.adoc[Docker Swarm & Docker Compose部署]
*** xref:v5.1/4.4.adoc[运维管理指南]
**** xref:v{ivorysql-version}/4.6.1.adoc[K8S部署]
**** xref:v{ivorysql-version}/4.6.2.adoc[Operator部署]
**** xref:v{ivorysql-version}/4.6.4.adoc[Docker & Podman部署]
**** xref:v{ivorysql-version}/4.6.3.adoc[Docker Swarm & Docker Compose部署]
*** xref:v{ivorysql-version}/4.4.adoc[运维管理指南]
*** 云服务平台指南
**** xref:v5.1/4.7.1.adoc[IvorySQL Cloud安装]
**** xref:v5.1/4.7.2.adoc[IvorySQL Cloud使用]
**** xref:v{ivorysql-version}/4.7.1.adoc[IvorySQL Cloud安装]
**** xref:v{ivorysql-version}/4.7.2.adoc[IvorySQL Cloud使用]
** IvorySQL生态
*** xref:v5.1/cpu_arch_adp.adoc[芯片架构适配]
*** xref:v5.1/os_arch_adp.adoc[操作系统适配]
*** xref:v{ivorysql-version}/cpu_arch_adp.adoc[芯片架构适配]
*** xref:v{ivorysql-version}/os_arch_adp.adoc[操作系统适配]
*** 生态组件适配
**** xref:v5.1/5.0.adoc[概述]
**** xref:v5.1/5.1.adoc[postgis]
**** xref:v5.1/5.2.adoc[pgvector]
**** xref:v5.1/5.3.adoc[pgddl(DDL Extractor)]
**** xref:v5.1/5.4.adoc[pg_cron]
**** xref:v5.1/5.5.adoc[pgsql-http]
**** xref:v5.1/5.6.adoc[plpgsql_check]
**** xref:v5.1/5.7.adoc[pgroonga]
**** xref:v5.1/5.8.adoc[pgaudit]
**** xref:v5.1/5.9.adoc[pgrouting]
**** xref:v5.1/5.10.adoc[system_stats]
**** xref:v{ivorysql-version}/5.0.adoc[概述]
**** xref:v{ivorysql-version}/5.1.adoc[postgis]
**** xref:v{ivorysql-version}/5.2.adoc[pgvector]
**** xref:v{ivorysql-version}/5.3.adoc[pgddl(DDL Extractor)]
**** xref:v{ivorysql-version}/5.4.adoc[pg_cron]
**** xref:v{ivorysql-version}/5.5.adoc[pgsql-http]
**** xref:v{ivorysql-version}/5.6.adoc[plpgsql_check]
**** xref:v{ivorysql-version}/5.7.adoc[pgroonga]
**** xref:v{ivorysql-version}/5.8.adoc[pgaudit]
**** xref:v{ivorysql-version}/5.9.adoc[pgrouting]
**** xref:v{ivorysql-version}/5.10.adoc[system_stats]
** IvorySQL架构设计
*** 查询处理
**** xref:v5.1/6.1.1.adoc[双parser]
**** xref:v{ivorysql-version}/6.1.1.adoc[双parser]
*** 兼容框架
**** xref:v5.1/7.1.adoc[框架设计]
**** xref:v5.1/7.2.adoc[GUC框架]
**** xref:v5.1/7.4.adoc[双模式设计]
**** xref:v5.1/6.2.1.adoc[initdb过程]
**** xref:v{ivorysql-version}/7.1.adoc[框架设计]
**** xref:v{ivorysql-version}/7.2.adoc[GUC框架]
**** xref:v{ivorysql-version}/7.4.adoc[双模式设计]
**** xref:v{ivorysql-version}/6.2.1.adoc[initdb过程]
*** 兼容特性
**** xref:v5.1/6.3.1.adoc[like]
**** xref:v5.1/6.3.3.adoc[RowID]
**** xref:v5.1/6.3.2.adoc[OUT 参数]
**** xref:v5.1/6.3.4.adoc[%TYPE、%ROWTYPE]
**** xref:v5.1/6.3.5.adoc[NLS 参数]
**** xref:v5.1/6.3.6.adoc[函数与存储过程]
**** xref:v5.1/6.3.7.adoc[嵌套子函数]
**** xref:v5.1/6.3.8.adoc[Force View]
**** xref:v5.1/6.3.9.adoc[大小写转换]
**** xref:v5.1/6.3.10.adoc[sys_guid 函数]
**** xref:v5.1/6.3.11.adoc[空字符串转null]
**** xref:v5.1/6.3.12.adoc[CALL INTO]
**** xref:v{ivorysql-version}/6.3.1.adoc[like]
**** xref:v{ivorysql-version}/6.3.3.adoc[RowID]
**** xref:v{ivorysql-version}/6.3.2.adoc[OUT 参数]
**** xref:v{ivorysql-version}/6.3.4.adoc[%TYPE、%ROWTYPE]
**** xref:v{ivorysql-version}/6.3.5.adoc[NLS 参数]
**** xref:v{ivorysql-version}/6.3.6.adoc[函数与存储过程]
**** xref:v{ivorysql-version}/6.3.7.adoc[嵌套子函数]
**** xref:v{ivorysql-version}/6.3.8.adoc[Force View]
**** xref:v{ivorysql-version}/6.3.9.adoc[大小写转换]
**** xref:v{ivorysql-version}/6.3.10.adoc[sys_guid 函数]
**** xref:v{ivorysql-version}/6.3.11.adoc[空字符串转null]
**** xref:v{ivorysql-version}/6.3.12.adoc[CALL INTO]
*** 内置函数
**** xref:v5.1/6.4.1.adoc[sys_context]
**** xref:v5.1/6.4.2.adoc[userenv]
*** xref:v5.1/6.5.adoc[国标GB18030]
**** xref:v{ivorysql-version}/6.4.1.adoc[sys_context]
**** xref:v{ivorysql-version}/6.4.2.adoc[userenv]
*** xref:v{ivorysql-version}/6.5.adoc[国标GB18030]
** Oracle兼容功能列表
*** xref:v5.1/7.3.adoc[1、大小写转换]
*** xref:v5.1/7.5.adoc[2、LIKE操作符]
*** xref:v5.1/7.6.adoc[3、匿名块]
*** xref:v5.1/7.7.adoc[4、函数与存储过程]
*** xref:v5.1/7.8.adoc[5、内置数据类型与内置函数]
*** xref:v5.1/7.9.adoc[6、端口与IP]
*** xref:v5.1/7.10.adoc[7、XML函数]
*** xref:v5.1/7.11.adoc[8、sequence]
*** xref:v5.1/7.12.adoc[9、包]
*** xref:v5.1/7.13.adoc[10、不可见列]
*** xref:v5.1/7.14.adoc[11、RowID]
*** xref:v5.1/7.15.adoc[12、OUT 参数]
*** xref:v5.1/7.16.adoc[13、%TYPE、%ROWTYPE]
*** xref:v5.1/7.17.adoc[14、NLS 参数]
*** xref:v5.1/7.18.adoc[15、Force View]
*** xref:v5.1/7.19.adoc[16、嵌套子函数]
*** xref:v5.1/7.20.adoc[17、sys_guid 函数]
*** xref:v5.1/7.21.adoc[18、空字符串转null]
*** xref:v5.1/7.22.adoc[19、CALL INTO]
*** xref:v{ivorysql-version}/7.3.adoc[1、大小写转换]
*** xref:v{ivorysql-version}/7.5.adoc[2、LIKE操作符]
*** xref:v{ivorysql-version}/7.6.adoc[3、匿名块]
*** xref:v{ivorysql-version}/7.7.adoc[4、函数与存储过程]
*** xref:v{ivorysql-version}/7.8.adoc[5、内置数据类型与内置函数]
*** xref:v{ivorysql-version}/7.9.adoc[6、端口与IP]
*** xref:v{ivorysql-version}/7.10.adoc[7、XML函数]
*** xref:v{ivorysql-version}/7.11.adoc[8、sequence]
*** xref:v{ivorysql-version}/7.12.adoc[9、包]
*** xref:v{ivorysql-version}/7.13.adoc[10、不可见列]
*** xref:v{ivorysql-version}/7.14.adoc[11、RowID]
*** xref:v{ivorysql-version}/7.15.adoc[12、OUT 参数]
*** xref:v{ivorysql-version}/7.16.adoc[13、%TYPE、%ROWTYPE]
*** xref:v{ivorysql-version}/7.17.adoc[14、NLS 参数]
*** xref:v{ivorysql-version}/7.18.adoc[15、Force View]
*** xref:v{ivorysql-version}/7.19.adoc[16、嵌套子函数]
*** xref:v{ivorysql-version}/7.20.adoc[17、sys_guid 函数]
*** xref:v{ivorysql-version}/7.21.adoc[18、空字符串转null]
*** xref:v{ivorysql-version}/7.22.adoc[19、CALL INTO]
** IvorySQL贡献指南
*** xref:v5.1/8.1.adoc[社区贡献指南]
*** xref:v5.1/8.2.adoc[asciidoc语法快速参考]
** xref:v5.1/9.adoc[工具参考]
** xref:v5.1/10.adoc[FAQ]
*** xref:v{ivorysql-version}/8.1.adoc[社区贡献指南]
*** xref:v{ivorysql-version}/8.2.adoc[asciidoc语法快速参考]
** xref:v{ivorysql-version}/9.adoc[工具参考]
** xref:v{ivorysql-version}/10.adoc[FAQ]
* PostgreSQL
** xref:v5.1/100.adoc[PG参数参考手册]
** xref:v5.1/110.adoc[PG函数参考手册]
** xref:v{ivorysql-version}/100.adoc[PG参数参考手册]
** xref:v{ivorysql-version}/110.adoc[PG函数参考手册]
2 changes: 1 addition & 1 deletion CN/modules/ROOT/pages/v5.1/23.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ IvorySQL由一个核心开发团队维护，该团队拥有对GitHub上的IvoryS

== **贡献者指南**

在贡献之前，我们需要了解下IvorySQL目前的版本以及文档的版本。目前，我们维护着5.1等版本，我们的版本紧跟PG的更新步伐，贡献之前请更新至最新版本。之后我们需要细心浏览一下贡献的样式风格，熟悉代码贡献风格、提Issue样式、拉取PR标题样式、代码注释样式、文档贡献样式、文章贡献样式，这可以帮助您尽快成为IvorySQL的贡献者奥~。
在贡献之前，我们需要了解下IvorySQL目前的版本以及文档的版本。目前，我们维护着{ivorysql-version}等版本，我们的版本紧跟PG的更新步伐，贡献之前请更新至最新版本。之后我们需要细心浏览一下贡献的样式风格，熟悉代码贡献风格、提Issue样式、拉取PR标题样式、代码注释样式、文档贡献样式、文章贡献样式，这可以帮助您尽快成为IvorySQL的贡献者奥~。

=== 贡献前的准备

Expand Down
23 changes: 16 additions & 7 deletions CN/modules/ROOT/pages/v5.1/3.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ https://www.ionos.com/help/server-cloud-infrastructure/server-administration/cre
+

创建或编辑IvorySQL yum源配置文件/etc/yum.repos.d/ivorysql.repo
[source,bash,subs="attributes"]
```
vim /etc/yum.repos.d/ivorysql.repo
[ivorysql5]
Expand All @@ -51,12 +52,13 @@ enabled=1
gpgcheck=0
```
保存退出后，安装IvorySQL5
[source,bash,subs="attributes"]
```
$ sudo dnf install -y ivorysql5-5.1
$ sudo dnf install -y ivorysql5-{ivorysql-version}
```
....

正确安装后，数据库将被安装在/usr/ivory-5/路径下的IvorySQL-version(如:IvorySQL-5.1)文件夹内
正确安装后，数据库将被安装在/usr/ivory-5/路径下的IvorySQL-version(如:IvorySQL-{ivorysql-version})文件夹内
....

执行以下命令为ivorysql用户赋权：
Expand Down Expand Up @@ -112,28 +114,35 @@ ivorysql 3238 1551 0 20:35 pts/0 00:00:00 grep --color=auto postgres
=== docker方式运行

** 从Docker Hub上获取IvorySQL镜像

[source,bash,subs="attributes"]
```
$ docker pull ivorysql/ivorysql:5.1-ubi8
$ docker pull ivorysql/ivorysql:{ivorysql-version}-ubi8
```

** 运行IvorySQL

[source,bash,subs="attributes"]
```
$ docker run --name ivorysql -p 5434:5432 -e IVORYSQL_PASSWORD=your_password -d ivorysql/ivorysql:5.1-ubi8
$ docker run --name ivorysql -p 5434:5432 -e IVORYSQL_PASSWORD=your_password -d ivorysql/ivorysql:{ivorysql-version}-ubi8
```

** 查看IvorySQL容器运行是否成功

[source,bash,subs="attributes"]
```
$ docker ps | grep ivorysql
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
6faa2d0ed705 ivorysql:5.1-ubi8 "docker-entrypoint.s…" 50 seconds ago Up 49 seconds 5866/tcp, 0.0.0.0:5434->5432/tcp ivorysql
6faa2d0ed705 ivorysql:{ivorysql-version}-ubi8 "docker-entrypoint.s…" 50 seconds ago Up 49 seconds 5866/tcp, 0.0.0.0:5434->5432/tcp ivorysql
```

== 数据库连接

psql连接数据库：
[source,bash,subs="attributes"]
```
$ psql -d <database>
psql (18.1)
psql ({pg-version})
Type "help" for help.

ivorysql=#
Expand All @@ -148,4 +157,4 @@ TIP: Docker运行IvorySQL时，需要添加额外参数，如 psql -d ivorysql -

现在可以开始使用IvorySQL啦！就是这么简单！

想要获得更多安装方式，请参考xref:v5.1/4.1.adoc[安装指南]
想要获得更多安装方式，请参考xref:v{ivorysql-version}/4.1.adoc[安装指南]
38 changes: 27 additions & 11 deletions CN/modules/ROOT/pages/v5.1/4.1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ IvorySQL安装方式包括以下5种：
- <<源码安装>>
- <<deb安装>>

本章将详细介绍每种方式的安装、运行及卸载过程。想要更快获得IvorySQL，请参阅xref:v5.1/3.1.adoc#快速开始[快速开始]。
本章将详细介绍每种方式的安装、运行及卸载过程。想要更快获得IvorySQL，请参阅xref:v{ivorysql-version}/3.1.adoc#快速开始[快速开始]。

同样，安装前请先创建一个用户，并赋予其root权限，安装、使用和卸载均以该用户执行。这里以ivorysql用户为例。

Expand All @@ -31,21 +31,26 @@ enabled=1
gpgcheck=0
```
保存退出后，安装IvorySQL5
[source,bash,subs="attributes"]
```
$ sudo dnf install -y ivorysql5-5.1
$ sudo dnf install -y ivorysql5-{ivorysql-version}
```

[[docker安装]]
== docker安装

** 从Docker Hub上获取IvorySQL镜像

[source,bash,subs="attributes"]
```
$ docker pull ivorysql/ivorysql:5.1-ubi8
$ docker pull ivorysql/ivorysql:{ivorysql-version}-ubi8
```

** 运行IvorySQL

[source,bash,subs="attributes"]
```
$ docker run --name ivorysql -p 5434:5432 -e IVORYSQL_PASSWORD=your_password -d ivorysql/ivorysql:5.1-ubi8
$ docker run --name ivorysql -p 5434:5432 -e IVORYSQL_PASSWORD=your_password -d ivorysql/ivorysql:{ivorysql-version}-ubi8
```
-e参数说明
|====
Expand All @@ -72,8 +77,10 @@ $ docker run --name ivorysql -p 5434:5432 -e IVORYSQL_PASSWORD=your_password -d
$ sudo dnf install -y lz4 libicu libxslt python3
```
** 获取rpm包

[source,bash,subs="attributes"]
```
$ sudo wget https://github.com/IvorySQL/IvorySQL/releases/download/IvorySQL_5.1/IvorySQL-5.1-62069c2-20251211.x86_64.rpm
$ sudo wget https://github.com/IvorySQL/IvorySQL/releases/download/IvorySQL_{ivorysql-version}/IvorySQL-{ivorysql-version}-9d890e9-20251120.x86_64.rpm
```
** 安装rpm包

Expand Down Expand Up @@ -102,7 +109,7 @@ $ sudo apt install -y pkg-config uuid-dev
```
$ git clone https://github.com/IvorySQL/IvorySQL.git
$ cd IvorySQL
$ git checkout tags/IvorySQL_5.1
$ git checkout -b IVORY_REL_5_STABLE origin/IVORY_REL_5_STABLE
```
** 配置

Expand Down Expand Up @@ -143,13 +150,17 @@ $ sudo apt -y install pkg-config libreadline-dev libicu-dev libldap2-dev uuid-de
```

** 获取deb包

[source,bash,subs="attributes"]
```
$ sudo wget https://github.com/IvorySQL/IvorySQL/releases/download/IvorySQL_5.1/IvorySQL-5.1-62069c2-20251211.amd64.deb
$ sudo wget https://github.com/IvorySQL/IvorySQL/releases/download/IvorySQL_{ivorysql-version}/IvorySQL-{ivorysql-version}-a50789d-20250304.amd64.deb
```

** 安装deb包

[source,bash,subs="attributes"]
```
$ sudo dpkg -i IvorySQL-5.1-62069c2-20251211.amd64.deb
$ sudo dpkg -i IvorySQL-{ivorysql-version}-a50789d-20250304.amd64.deb
```
数据库将被安装在/usr/ivory-5/路径下。

Expand Down Expand Up @@ -213,9 +224,10 @@ ivorysql 130445 130274 0 02:45 pts/1 00:00:00 grep --color=auto postgres
== 数据库连接

psql连接数据库：
[source,bash,subs="attributes"]
```
$ psql -d <database>
psql (18.1)
psql ({pg-version})
Type "help" for help.

ivorysql=#
Expand Down Expand Up @@ -245,10 +257,12 @@ $ sudo dnf remove -y ivorysql5-5.0
=== docker安装的卸载

执行以下命令，使IvorySQL容器停止运行，并删除IvorySQL容器和镜像：

[source,bash,subs="attributes"]
```
$ docker stop ivorysql
$ docker rm ivorysql
$ docker rmi ivorysql/ivorysql:5.1-ubi8
$ docker rmi ivorysql/ivorysql:{ivorysql-version}-ubi8
```

=== rpm安装的卸载
Expand All @@ -271,7 +285,9 @@ $ sudo rm -rf /usr/ivory-5
=== deb安装的卸载

执行以下命令卸载数据库并清理文件夹：

[source,bash,subs="attributes"]
```
$ sudo dpkg -P IvorySQL-5.1
$ sudo dpkg -P IvorySQL-{ivorysql-version}
$ sudo rm -rf /usr/ivory-5
```
Loading