Skip to content

Commit 571a55b

Browse files
committed
docs: migrate from AsciiDoc to Markdown
Signed-off-by: faweizhao26 <faweizhao26@gmail.com>
1 parent 15c7476 commit 571a55b

177 files changed

Lines changed: 14483 additions & 22992 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.DS_Store

8 KB
Binary file not shown.

CN/.DS_Store

6 KB
Binary file not shown.

CN/antora.yml

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,6 @@
11
name: ivorysql-doc
22
title: 文档中心
33
version: v5.3
4-
start_page: welcome.adoc
5-
asciidoc:
6-
attributes:
7-
source-language: asciidoc@
8-
table-caption: false
9-
ivorysql-version: 5.3
10-
pg-version: 18.3
11-
package-link: 'https://github.com/ivorysql/ivorysql'
12-
package-link-x86_64-deb: 'IvorySQL-5.3-4dfba1d-20260312.amd64.deb'
13-
package-link-x86_64-rpm: 'IvorySQL-5.3-4dfba1d-20260312.x86_64.rpm'
14-
package-link-aarch64-deb: 'IvorySQL-5.3-4dfba1d-20260312.arm64.deb'
15-
package-link-aarch64-rpm: 'IvorySQL-5.3-4dfba1d-20260312.aarch64.rpm'
16-
package-link-mips64el-deb: 'IvorySQL-5.3-4dfba1d-20260312.mips64el.deb'
17-
package-link-mips64el-rpm: 'IvorySQL-5.3-4dfba1d-20260312.mips64el.rpm'
18-
package-link-loongarch64-deb: 'IvorySQL-5.3-4dfba1d-20260312.loongarch64.deb'
19-
package-link-loongarch64-rpm: 'IvorySQL-5.3-4dfba1d-20260312.loongarch64.rpm'
4+
start_page: welcome.md
205
nav:
21-
- modules/ROOT/nav.adoc
6+
- modules/ROOT/nav.md

CN/modules/.DS_Store

6 KB
Binary file not shown.

CN/modules/ROOT/.DS_Store

8 KB
Binary file not shown.

CN/modules/ROOT/nav.adoc

Lines changed: 0 additions & 93 deletions
This file was deleted.

CN/modules/ROOT/nav.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
- [关于IvorySQL](2.md)
2+
- [欢迎](welcome.md)
3+
- [发行说明](1.md)
4+
- **快速上手**
5+
- [快速开始](3.1.md)
6+
- **安装部署**
7+
- [安装指南](4.1.md)
8+
- [集群搭建](4.2.md)
9+
- **Oracle兼容功能**
10+
- [1、大小写转换](7.3.md)
11+
- [2、LIKE操作符](7.5.md)
12+
- [3、匿名块](7.6.md)
13+
- [4、函数与存储过程](7.7.md)
14+
- [5、内置数据类型与内置函数](7.8.md)
15+
- [6、端口与IP](7.9.md)
16+
- [7、XML函数](7.10.md)
17+
- [8、sequence](7.11.md)
18+
- [9、包](7.12.md)
19+
- [10、不可见列](7.13.md)
20+
- [11、RowID](7.14.md)
21+
- [12、OUT 参数](7.15.md)
22+
- [13、%TYPE、%ROWTYPE](7.16.md)
23+
- [14、NLS 参数](7.17.md)
24+
- [15、Force View](7.18.md)
25+
- [16、嵌套子函数](7.19.md)
26+
- [17、sys_guid 函数](7.20.md)
27+
- [18、空字符串转null](7.21.md)
28+
- [19、CALL INTO](7.22.md)
29+
- **容器化与云服务**
30+
- **容器化指南**
31+
- [K8S部署](4.6.1.md)
32+
- [Operator部署](4.6.2.md)
33+
- [Docker & Podman部署](4.6.4.md)
34+
- [Docker Swarm & Docker Compose部署](4.6.3.md)
35+
- **云服务平台指南**
36+
- [IvorySQL Cloud安装](4.7.1.md)
37+
- [IvorySQL Cloud使用](4.7.2.md)
38+
- **IvorySQL生态**
39+
- [芯片架构适配](cpu_arch_adp.md)
40+
- [操作系统适配](os_arch_adp.md)
41+
- **生态组件适配**
42+
- [概述](5.0.md)
43+
- [postgis](5.1.md)
44+
- [pgvector](5.2.md)
45+
- [pgddl(DDL Extractor)](5.3.md)
46+
- [pg_cron](5.4.md)
47+
- [pgsql-http](5.5.md)
48+
- [plpgsql_check](5.6.md)
49+
- [pgroonga](5.7.md)
50+
- [pgaudit](5.8.md)
51+
- [pgrouting](5.9.md)
52+
- [system_stats](5.10.md)
53+
- **监控运维**
54+
- [日常监控](3.2.md)
55+
- [日常维护](3.3.md)
56+
- [运维管理](4.4.md)
57+
- **数据迁移**
58+
- [迁移指南](4.5.md)
59+
- **IvorySQL开发者**
60+
- [社区贡献指南](8.1.md)
61+
- [开发者指南](4.3.md)
62+
- **IvorySQL架构设计**
63+
- **查询处理**
64+
- [双parser](6.1.1.md)
65+
- **兼容框架**
66+
- [框架设计](7.1.md)
67+
- [GUC框架](7.2.md)
68+
- [双模式设计](7.4.md)
69+
- [initdb过程](6.2.1.md)
70+
- **兼容特性**
71+
- [like](6.3.1.md)
72+
- [RowID](6.3.3.md)
73+
- [OUT 参数](6.3.2.md)
74+
- [%TYPE、%ROWTYPE](6.3.4.md)
75+
- [NLS 参数](6.3.5.md)
76+
- [函数与存储过程](6.3.6.md)
77+
- [嵌套子函数](6.3.7.md)
78+
- [Force View](6.3.8.md)
79+
- [大小写转换](6.3.9.md)
80+
- [sys_guid 函数](6.3.10.md)
81+
- [空字符串转null](6.3.11.md)
82+
- [CALL INTO](6.3.12.md)
83+
- **内置函数**
84+
- [sys_context](6.4.1.md)
85+
- [userenv](6.4.2.md)
86+
- [国标GB18030](6.5.md)
87+
- **参考指南**
88+
- [工具参考](9.md)
89+
- [Markdown语法快速参考](8.2.md)
90+
- [PG参数参考手册](100.md)
91+
- [PG函数参考手册](110.md)
92+
- **常见问题解答**
93+
- [FAQ](10.md)
Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
1-
:sectnums:
2-
:sectnumlevels: 5
1+
## 版本概览
2+
[**发布日期:2026 年 3 月 12 日**]
33

4+
IvorySQL 5.3 基于 PostgreSQL 18.3 构建,包含多项错误修复。有关更新的完整列表,请访问我们的 [文档站点](https://docs.ivorysql.org/)
45

5-
== 版本概览
6-
7-
[*发布日期:2026 年 3 月 12 日*]
8-
9-
IvorySQL 5.3 基于 PostgreSQL 18.3 构建,包含多项错误修复。有关更新的完整列表,请访问我们的 https://docs.ivorysql.org/[文档站点]。
10-
11-
== 增强内容
12-
6+
## 增强内容
137
- PostgreSQL 18.3
148

159
1. 修复在重放由旧小版本生成的 multixid 截断 WAL 记录后出现的失败问题。
@@ -18,7 +12,7 @@ IvorySQL 5.3 基于 PostgreSQL 18.3 构建,包含多项错误修复。有关
1812
4. 修复 json_strip_nulls() 和 jsonb_strip_nulls() 的易变性标记。
1913
5. 修复 LATERAL UNION ALL 子查询输出中可能为空的外连接集合的计算问题。
2014

21-
更多详情,请参阅 https://www.postgresql.org/docs/release/18.3/[PostgreSQL 18.3 发布说明]
15+
更多详情,请参阅 [PostgreSQL 18.3 发布说明](https://www.postgresql.org/docs/release/18.3/)
2216

2317
- PostgreSQL 18.2
2418

@@ -28,17 +22,16 @@ IvorySQL 5.3 基于 PostgreSQL 18.3 构建,包含多项错误修复。有关
2822
4. 修复多字节字符长度验证不充分的问题。
2923
5. 加固 contrib/pg_trgm,使其能应对字符串小写化行为的变化。
3024

31-
更多详情,请参阅 https://www.postgresql.org/docs/release/18.2/[PostgreSQL 18.2 发布说明]。
32-
33-
== 新特性
25+
更多详情,请参阅 [PostgreSQL 18.2 发布说明](https://www.postgresql.org/docs/release/18.2/)
3426

35-
- 升级至 PG 18.3 内核:Feature https://github.com/IvorySQL/IvorySQL/pull/1199[#1199] +
27+
## 新特性
28+
- 升级至 PG 18.3 内核:Feature [#1199](https://github.com/IvorySQL/IvorySQL/pull/1199) +
3629
PostgreSQL 内核已升级至 18.3 版本。
3730

38-
- 升级至 PG 18.2 内核:Feature https://github.com/IvorySQL/IvorySQL/pull/1195[#1195] +
31+
- 升级至 PG 18.2 内核:Feature [#1195](https://github.com/IvorySQL/IvorySQL/pull/1195) +
3932
PostgreSQL 内核已升级至 18.2 版本。
4033

41-
- http://trial.ivorysql.org/[在线体验]:IvorySQL 5.3:Feature https://github.com/IvorySQL/ivorysql-wasm/pull/7[#7] +
34+
- [在线体验](http://trial.ivorysql.org/):IvorySQL 5.3:Feature [#7](https://github.com/IvorySQL/ivorysql-wasm/pull/7) +
4235
上线交互式浏览器环境,用户可实时体验与评估 IvorySQL 5.3,无需安装。
4336

4437
- 全平台打包:+
@@ -53,30 +46,27 @@ IvorySQL 5.3 基于 PostgreSQL 18.3 构建,包含多项错误修复。有关
5346
- PostgreSQL Extensions +
5447
新增支持 10 个 PostgreSQL 扩展:pg_cron、pgAudit、PostGIS、pgRouting、PGroonga、ddlx、pgsql-http、system_stats、plpgsql_check、pgvector。
5548

56-
== 缺陷修复
57-
58-
- 清除编译警告:PR https://github.com/IvorySQL/IvorySQL/pull/1190[#1190]
59-
- 修复 ColumnRefOrFuncCall 的 raw_expression_tree_walker 问题:Issue https://github.com/IvorySQL/IvorySQL/issues/1182[#1182]
60-
- 修复从 PostgreSQL 升级到 IvorySQL 失败的问题:Issue https://github.com/IvorySQL/IvorySQL/issues/1130[#1130]
61-
- 改善 ivorysql.compatible_mode = 'pg' 时关于 plisql 用法的错误信息:PR https://github.com/IvorySQL/IvorySQL/pull/1178[#1178]
62-
- 修复 liboracle_parser.c 中 token_is_col_id() 的数组越界读取问题:Issue https://github.com/IvorySQL/IvorySQL/issues/1159[#1159]
63-
- 修复 psql 的 Tab 补全显示 INVISIBLEINCREMENT 的问题:Issue https://github.com/IvorySQL/IvorySQL/issues/1135[#1135]
64-
- 修复嵌套函数表达式中变量重置的 Bug:Issue https://github.com/IvorySQL/IvorySQL/issues/1124[#1124]
65-
- 修复 packages 和 subprocedures 中混用位置参数/命名参数时的类型强制转换失败问题:Issue https://github.com/IvorySQL/IvorySQL/issues/1006[#1006]
66-
- 修复 package 过程从参数初始化局部变量时发生的段错误:Issue https://github.com/IvorySQL/IvorySQL/issues/1005[#1005]
67-
- 修复因新年导致的回归测试失败问题:PR https://github.com/IvorySQL/IvorySQL/pull/1146[#1146]
68-
69-
== 源码仓库
70-
49+
## 缺陷修复
50+
- 清除编译警告:PR [#1190](https://github.com/IvorySQL/IvorySQL/pull/1190)
51+
- 修复 ColumnRefOrFuncCall 的 raw_expression_tree_walker 问题:Issue [#1182](https://github.com/IvorySQL/IvorySQL/issues/1182)
52+
- 修复从 PostgreSQL 升级到 IvorySQL 失败的问题:Issue [#1130](https://github.com/IvorySQL/IvorySQL/issues/1130)
53+
- 改善 ivorysql.compatible_mode = 'pg' 时关于 plisql 用法的错误信息:PR [#1178](https://github.com/IvorySQL/IvorySQL/pull/1178)
54+
- 修复 liboracle_parser.c 中 token_is_col_id() 的数组越界读取问题:Issue [#1159](https://github.com/IvorySQL/IvorySQL/issues/1159)
55+
- 修复 psql 的 Tab 补全显示 INVISIBLEINCREMENT 的问题:Issue [#1135](https://github.com/IvorySQL/IvorySQL/issues/1135)
56+
- 修复嵌套函数表达式中变量重置的 Bug:Issue [#1124](https://github.com/IvorySQL/IvorySQL/issues/1124)
57+
- 修复 packages 和 subprocedures 中混用位置参数/命名参数时的类型强制转换失败问题:Issue [#1006](https://github.com/IvorySQL/IvorySQL/issues/1006)
58+
- 修复 package 过程从参数初始化局部变量时发生的段错误:Issue [#1005](https://github.com/IvorySQL/IvorySQL/issues/1005)
59+
- 修复因新年导致的回归测试失败问题:PR [#1146](https://github.com/IvorySQL/IvorySQL/pull/1146)
60+
61+
## 源码仓库
7162
IvorySQL 的主要代码仓库:
7263

7364
- IvorySQL 数据库源码:https://github.com/IvorySQL/IvorySQL
7465
- IvorySQL 官网:https://github.com/IvorySQL/Ivory-www
7566
- IvorySQL 文档:https://github.com/IvorySQL/IvorySQL-docs
7667
- IvorySQL Docker:https://github.com/IvorySQL/docker_library
7768

78-
== 贡献者名单
79-
69+
## 贡献者名单
8070
以下人员(按字母顺序)作为补丁作者、提交者、审阅者、测试者或问题报告者,为本次发布做出了贡献。
8171

8272

@@ -98,4 +88,4 @@ IvorySQL 的主要代码仓库:
9888
* 陶郑
9989
* 杨世华
10090
* 赵法威
101-
* 张哲
91+
* 张哲
Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
1-
2-
:sectnums:
3-
:sectnumlevels: 5
4-
5-
6-
= FAQ
7-
8-
== IvorySQL贡献的许可
9-
1+
# FAQ
2+
## IvorySQL贡献的许可
103
如果您提交的贡献是原创作品,那么您可以假设IvorySQL将作为整个IvorySQL版本的一部分发布给下游用户,该版本将遵循Apache许可证2.0版本。
114

125
如果您提交的内容不是原创作品,同样鼓励代码共享和尊重原作者的著作权,同样允许代码修改,再发布。请注意需要满足如下条件:
@@ -21,8 +14,7 @@
2114

2215
最后,请记住,从非原始的工作中删除许可标头从来都不是一个好主意。即使您使用的文件部分最初在顶部有许可标头,您也应该保留它。与往常一样,如果您不太确定您的贡献所涉及的许可问题,请随时在开发人员邮件列表中联系我们。
2316

24-
== 编码指南
25-
17+
## 编码指南
2618
您获得反馈和看到代码合并到项目中的机会在很大程度上取决于更改的粒度。如果您的想法发生了更大的变化,我们强烈建议您在花大量时间编写代码之前,先加入开发人员的邮件列表,并与我们分享您的建议。即使您的建议得到社区的验证,我们仍然建议您将实际工作作为一系列小型的、独立的提交来完成。这使得评审员的工作更加容易,并提高了反馈的及时性。
2719

2820
当谈到IvorySQL的C和C++部分时,我们尝试遵循PostgreSQL编码约定。除此之外:
@@ -33,16 +25,13 @@
3325

3426
至少,您应该始终运行make installcheck world,以确保您没有破坏任何东西。
3527

36-
== 适用于上游PostgreSQL的更改
37-
28+
## 适用于上游PostgreSQL的更改
3829
如果您正在进行的更改涉及PostgreSQL和IvorySQL之间的通用功能,则可能会要求您将其转发到PostgreSQL。这不仅是为了我们不断减少两个项目之间的差异,而且是为了让与PostgreSQL相关的任何变化都能从对上游PostgreSQL社区更广泛的审查中受益。一般来说,将这两个代码库都放在手边是个好主意,这样您就可以确定您的更改是否需要前移。
3930

40-
== 补丁提交
41-
31+
## 补丁提交
4232
一旦您准备好与IvorySQL核心团队和IvorySQL社区的其他成员共享您的工作,您应该将所有提交推送到从官方IvorySQL派生的分支的您自己的存储库中,并向我们发送请求。
4333

44-
== 补丁审查
45-
34+
## 补丁审查
4635
假定提交的拉取请求通过验证检查,可供同行审查。同行审查是确保对IvorySQL的贡献具有高质量并与路线图和社区期望保持一致的过程。我们鼓励IvorySQL社区的每个成员审查请求并提供反馈。由于您不必成为核心团队成员就可以做到这一点,因此我们建议您向有兴趣成为IvorySQL长期贡献者的任何人提供一系列拉动式评论。
4736

4837
同行评审的一个结果可能是达成共识,即您需要以某些方式修改pull请求。GitHub允许您将其他提交推送到从中发送请求的分支中。这些额外的提交将对所有审阅者可见。
@@ -51,6 +40,5 @@
5140

5241
在补丁审查期间的任何时候,您都可能会因审查人员和核心团队成员的工作效率而遇到延迟。请耐心点,也不要气馁。如果您在几天内没有收到预期的反馈,请添加一条评论,要求更新pull请求本身,或者向邮件列表发送一封电子邮件。
5342

54-
== 直接提交到存储库
55-
56-
有时,您会看到核心团队成员直接提交到存储库,而无需执行pull请求工作流。这仅适用于小的更改,我们使用的经验法则是:如果更改涉及任何可能导致测试失败的功能,那么它必须通过pull请求工作流。另一方面,如果更改发生在代码库的非功能部分(例如在注释块中修复打字错误),则核心团队成员可以决定直接提交到存储库。
43+
## 直接提交到存储库
44+
有时,您会看到核心团队成员直接提交到存储库,而无需执行pull请求工作流。这仅适用于小的更改,我们使用的经验法则是:如果更改涉及任何可能导致测试失败的功能,那么它必须通过pull请求工作流。另一方面,如果更改发生在代码库的非功能部分(例如在注释块中修复打字错误),则核心团队成员可以决定直接提交到存储库。

0 commit comments

Comments
 (0)