Skip to content

Commit 92031f9

Browse files
committed
update format
1 parent 5ac8e1a commit 92031f9

4 files changed

Lines changed: 21 additions & 19 deletions

File tree

CN/modules/ROOT/pages/master/ecosystem_components/ecosystem_overview.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ IvorySQL 作为一款兼容 Oracle 且基于 PostgreSQL 的高级开源数据库
3434
| 21 | xref:master/ecosystem_components/pg_show_plans.adoc[pg_show_plans] | 2.1 | 显示当前所有正在运行的 SQL 语句的执行计划,支持 TEXT、JSON、YAML 等多种输出格式 | 查询性能诊断、实时执行计划监控、慢查询分析
3535
| 22 | xref:master/ecosystem_components/pg_bulkload.adoc[pg_bulkload] | 3.1.23 | 为IvorySQL提供高速数据载入工具,可以跳过PG的共享缓存直接将数据导入表中 | 海量数据初始加载,历史数据归档,跨库迁移
3636
| 23 | xref:master/ecosystem_components/pg_bigm.adoc[pg_bigm] | 1.2 | 为 IvorySQL 提供二元分词全文检索能力,适配中日韩文本,快速实现模糊检索与相似度查询 | 中日韩文内容、商品、地址类文字搜索场景
37+
| 24 | xref:master/ecosystem_components/pgdog.adoc[PgDog] | 0.1.45 | 专为 PostgreSQL 设计的高性能、开源集群中间件(代理工具),采用 Rust 语言编写 | 自动分片、连接池和负载均衡功能
3738
|====
3839

3940
这些插件均经过 IvorySQL 团队的测试和适配,确保在 IvorySQL 环境下稳定运行。用户可以根据业务需求选择合适的插件,进一步提升数据库系统的能力和灵活性。

CN/modules/ROOT/pages/master/ecosystem_components/pgdog.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
== 概述
88
PgDog 是一个专为 PostgreSQL 设计的高性能、开源集群中间件(代理工具),采用 Rust 语言编写。它集成了自动分片、连接池和负载均衡功能,能让开发者在无需修改任何应用程序代码的前提下,实现 PostgreSQL 数据库的水平扩展与高可用管理。
99

10-
注意,PgDog 使用 PostgreSQL 原生的 pg_query 模块实现语句解析,所以暂时不支持在 Oracle 兼容模式下运行。
10+
NOTE: PgDog 使用 PostgreSQL 原生的 pg_query 模块实现语句解析,所以暂时不支持在 Oracle 兼容模式下运行。
1111

1212
项目地址:<https://github.com/pgdogdev/pgdog>
1313

@@ -41,7 +41,7 @@ wget https://github.com/pgdogdev/pgdog/archive/refs/tags/v0.1.45.tar.gz
4141
tar -zxf v0.1.45.tar.gz
4242
cd pgdog-0.1.45
4343
44-
# 编译完后,会在`target/release`目录下生成可执行文件
44+
# 编译完后,会在 target/release 目录下生成可执行文件
4545
cargo build --release
4646
----
4747

@@ -72,7 +72,7 @@ PgDog通过两个文件进行配置:
7272
|===
7373

7474

75-
创建`pgdog.toml`:
75+
创建 `pgdog.toml`
7676

7777
[source,toml]
7878
----
@@ -88,8 +88,8 @@ name = "ivory_shard"
8888
host = "ivory-shard0"
8989
port = 5432
9090
database_name = "testdb"
91-
user = "ivorysql" # 如果不提供,默认使用`users.toml`中对应的`name`
92-
password = "ivorysql" # 如果不提供,默认使用`users.toml`中对应的`password`
91+
user = "ivorysql" # 如果不提供,默认使用 users.toml 中对应的 name
92+
password = "ivorysql" # 如果不提供,默认使用 users.toml 中对应的 password
9393
shard = 0
9494
9595
[[databases]]
@@ -108,7 +108,7 @@ column = "customer_id"
108108
data_type = "bigint"
109109
----
110110

111-
创建`users.toml`:
111+
创建 `users.toml`
112112

113113
[source,toml]
114114
----
@@ -124,10 +124,10 @@ database = "ivory_shard"
124124
pool_size = 10
125125
----
126126

127-
创建`docker-compose.shard.yml`:
127+
创建 `docker-compose.shard.yml`
128128

129129
[TIP]
130-
`volumes`字段请根据实际的配置文件位置进行修改
130+
`volumes` 字段请根据实际的配置文件位置进行修改
131131

132132
[source,dockerfile]
133133
----
@@ -171,7 +171,7 @@ services:
171171

172172
=== 管理控制台
173173

174-
PgDog 提供了内置的管理数据库,用户名密码通过`users.toml`中`[[admin]]`字段进行配置。
174+
PgDog 提供了内置的管理数据库,用户名密码通过 `users.toml` 中 `+[[admin]]+` 字段进行配置。
175175

176176
[source,bash]
177177
----
@@ -233,7 +233,7 @@ psql "postgres://ivorysql:ivorysql@localhost:6433/ivory_shard"
233233
=== 执行操作
234234

235235
[TIP]
236-
请确认分片后端没有`orders`表,PgDog会自动创建。
236+
请确认分片后端没有 `orders` 表,PgDog会自动创建。
237237

238238
[source,sql]
239239
----
@@ -246,7 +246,7 @@ CREATE TABLE orders (
246246
);
247247
248248
-- 插入数据:这两条数据将分别插入到两个分片后端
249-
-- BUG:这里不能使用`generate_series`函数,因为PgDog暂时对这个函数进行透传
249+
-- BUG:这里不能使用 generate_series 函数,因为PgDog暂时对这个函数进行透传
250250
INSERT INTO orders values(1, 1, 1);
251251
INSERT INTO orders values(2, 2, 2);
252252
INSERT INTO orders values(3, 3, 3);
@@ -262,7 +262,7 @@ SELECT * FROM orders;
262262
=== 分别连接两个分片后端确认数据
263263

264264
[TIP]
265-
这里将看到两个分片后端的条目并不是均分的,这是因为PgDog根据`[[sharded_tables]]`中配置的`customer_id`字段,提取了数值并对其进行HASH分片。
265+
这里将看到两个分片后端的条目并不是均分的,这是因为PgDog根据 `+[[sharded_tables]]+` 中配置的 `customer_id` 字段,提取了数值并对其进行HASH分片。
266266

267267
[source,bash]
268268
----

EN/modules/ROOT/pages/master/ecosystem_components/ecosystem_overview.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ IvorySQL, as an advanced open-source database compatible with Oracle and based o
3535
|*21*| xref:master/ecosystem_components/pg_show_plans.adoc[pg_show_plans] | 2.1 | Displays execution plans of all currently running SQL statements, supporting TEXT, JSON, and YAML output formats | Query performance diagnosis, real-time execution plan monitoring, slow query analysis
3636
|*22*| xref:master/ecosystem_components/pg_bulkload.adoc[pg_bulkload] | 3.1.23 | Provides high-speed data loading tool for IvorySQL, which directly imports data into tables bypassing PostgreSQL shared buffers | initial loading of massive data, historical data archiving and cross-database migration
3737
|*23*| xref:master/ecosystem_components/pg_bigm.adoc[pg_bigm] | 1.2 | Equips IvorySQL with bigram full-text search capability, supporting Chinese, Japanese and Korean texts to implement fuzzy retrieval and similarity query efficiently | text search for articles, commodities and addresses in CJK languages
38+
|*24*| xref:master/ecosystem_components/pgdog.adoc[PgDog] | 0.1.45 | High-performance, open-source clustering middleware (proxy tool) designed specifically for PostgreSQL and written in Rust | Connection pooler, load balancer, distributed database.
3839
|====
3940

4041
These plugins have all been tested and adapted by the IvorySQL team to ensure stable operation in the IvorySQL environment. Users can select appropriate plugins based on business needs to further enhance the capabilities and flexibility of the database system.

EN/modules/ROOT/pages/master/ecosystem_components/pgdog.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
== Overview
77
PgDog is a high-performance, open-source clustering middleware (proxy tool) designed specifically for PostgreSQL and written in Rust. It integrates automatic sharding, connection pooling, and load balancing, enabling developers to achieve horizontal scaling and high-availability management of PostgreSQL databases without modifying any application code.
88

9-
Note that PgDog uses PostgreSQL's native pg_query module to parse statements, so it currently does not support Oracle compatibility mode.
9+
NOTE: PgDog uses PostgreSQL's native pg_query module to parse statements, so it currently does not support Oracle compatibility mode.
1010

1111
Project URL: <https://github.com/pgdogdev/pgdog>
1212

@@ -40,7 +40,7 @@ wget https://github.com/pgdogdev/pgdog/archive/refs/tags/v0.1.45.tar.gz
4040
tar -zxf v0.1.45.tar.gz
4141
cd pgdog-0.1.45
4242
43-
# After compilation, the executable will be generated in the `target/release` directory
43+
# After compilation, the executable will be generated in the target/release directory
4444
cargo build --release
4545
----
4646

@@ -87,8 +87,8 @@ name = "ivory_shard"
8787
host = "ivory-shard0"
8888
port = 5432
8989
database_name = "testdb"
90-
user = "ivorysql" # if not provide, using `name` in `users.toml`
91-
password = "ivorysql" # if not provide, using `password` in `users.toml`
90+
user = "ivorysql" # if not provide, using name in users.toml
91+
password = "ivorysql" # if not provide, using password in users.toml
9292
shard = 0
9393
9494
[[databases]]
@@ -170,7 +170,7 @@ services:
170170

171171
=== Administration Console
172172

173-
PgDog provides a built-in administration database. The username and password are configured via the `[[admin]]` field in `users.toml`.
173+
PgDog provides a built-in administration database. The username and password are configured via the `+[[admin]]+` field in `users.toml`.
174174

175175
[source,bash]
176176
----
@@ -245,7 +245,7 @@ CREATE TABLE orders (
245245
);
246246
247247
-- Insert data: these rows will be inserted into the two shard backends respectively
248-
-- BUG: the `generate_series` function cannot be used here, because PgDog currently passes this function through transparently
248+
-- BUG: the generate_series function cannot be used here, because PgDog currently passes this function through transparently
249249
INSERT INTO orders values(1, 1, 1);
250250
INSERT INTO orders values(2, 2, 2);
251251
INSERT INTO orders values(3, 3, 3);
@@ -261,7 +261,7 @@ SELECT * FROM orders;
261261
=== Connecting to Each Shard Backend to Verify the Data
262262

263263
[TIP]
264-
Here you will see that the entries in the two shard backends are not evenly distributed. This is because PgDog extracts the value of the `customer_id` field configured in `[[sharded_tables]]` and applies HASH-based sharding to it.
264+
Here you will see that the entries in the two shard backends are not evenly distributed. This is because PgDog extracts the value of the `customer_id` field configured in `+[[sharded_tables]]+` and applies HASH-based sharding to it.
265265

266266
[source,bash]
267267
----

0 commit comments

Comments
 (0)