Skip to content

Commit 1faa9f5

Browse files
bigplaicebigplaice
committed
support redis_fdw and add missing content in overview part of ecosystem
1 parent 531848c commit 1faa9f5

File tree

6 files changed

+236
-8
lines changed

6 files changed

+236
-8
lines changed

‎CN/modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
*** xref:master/ecosystem_components/pg_curl.adoc[pg_curl]
5959
*** xref:master/ecosystem_components/pg_textsearch.adoc[pg_textsearch]
6060
*** xref:master/ecosystem_components/pg_hint_plan.adoc[pg_hint_plan]
61+
*** xref:master/ecosystem_components/redis_fdw.adoc[redis_fdw]
6162
* 监控运维
6263
** xref:master/getting-started/daily_monitoring.adoc[日常监控]
6364
** xref:master/getting-started/daily_maintenance.adoc[日常维护]

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,15 @@ IvorySQL 作为一款兼容 Oracle 且基于 PostgreSQL 的高级开源数据库
2121
| 8 | xref:master/ecosystem_components/pgaudit.adoc[pgaudit] | 18.0 | 提供细粒度的审计功能，记录数据库操作日志，便于安全审计和合规性检查 | 数据库安全审计、合规性检查、审计报告生成
2222
| 9 | xref:master/ecosystem_components/pgrouting.adoc[pgrouting] | 3.8.0 | 提供地理空间数据的路由计算功能，支持多种算法和数据格式 | 地理空间分析、路径规划、物流优化
2323
| 10 | xref:master/ecosystem_components/system_stats.adoc[system_stats] | 3.2 | 提供用于访问系统级统计信息的函数 | 系统监控
24-
| 11 | xref:master/ecosystem_components/pg_ai_query.adoc[pg_ai_query] | 0.1.1 | AI驱动的自然语言转SQL扩展，支持多种大语言模型 | AI辅助查询、自然语言数据库交互
24+
| 11 | xref:master/ecosystem_components/wal2json.adoc[wal2json] | 2.6 | 用于 PostgreSQL 逻辑解码的输出插件，为每个事务生成一个JSON对象 | 变更数据捕获（CDC）、实时数据同步、事件驱动微服务、缓存刷新及跨库数据同步等
2525
| 12 | xref:master/ecosystem_components/pg_stat_monitor.adoc[pg_stat_monitor] | 2.3.1 | 收集性能统计数据，并通过统一视图和直方图形式直观展示查询性能指标。 | 性能监控
26-
| 13 | xref:master/ecosystem_components/pg_partman.adoc[pg_partman] | 5.2 | 辅助管理原生分区表，自动创建、维护、清理分区子表 | 海量数据存储管理
27-
| 14 | xref:master/ecosystem_components/pg_curl.adoc[pg_curl] | 2.4 | 基于 libcurl 的网络传输扩展，支持 HTTP/HTTPS、FTP、SMTP、IMAP 等二十余种协议，可在 SQL 中完成各类网络数据传输操作 | REST API 集成、邮件发送、文件传输、外部系统通知
28-
| 15 | xref:master/ecosystem_components/pg_hint_plan.adoc[pg_hint_plan] | PG18 | 通过SQL注释中的hints控制执行计划，在不修改SQL逻辑的情况下优化查询性能 | 查询性能优化、执行计划调优、数据库性能分析
26+
| 13 | xref:master/ecosystem_components/pg_ai_query.adoc[pg_ai_query] | 0.1.1 | AI驱动的自然语言转SQL扩展，支持多种大语言模型 | AI辅助查询、自然语言数据库交互
27+
| 14 | xref:master/ecosystem_components/pg_partman.adoc[pg_partman] | 5.2 | 辅助管理原生分区表，自动创建、维护、清理分区子表 | 海量数据存储管理
28+
| 15 | xref:master/ecosystem_components/pgbouncer.adoc[pgbouncer] | x.x | |
29+
| 16 | xref:master/ecosystem_components/pg_curl.adoc[pg_curl] | 2.4 | 基于 libcurl 的网络传输扩展，支持 HTTP/HTTPS、FTP、SMTP、IMAP 等二十余种协议，可在 SQL 中完成各类网络数据传输操作 | REST API 集成、邮件发送、文件传输、外部系统通知
30+
| 17 | xref:master/ecosystem_components/pg_textsearch.adoc[pg_textsearch] | 0.6.1 | 提供全文检索能力，支持文本分词、索引构建与高效全文查询 | 文档检索与内容搜索
31+
| 18 | xref:master/ecosystem_components/pg_hint_plan.adoc[pg_hint_plan] | PG18 | 通过SQL注释中的hints控制执行计划，在不修改SQL逻辑的情况下优化查询性能 | 查询性能优化、执行计划调优、数据库性能分析
32+
| 19 | xref:master/ecosystem_components/redis_fdw.adoc[redis_fdw] | PG18 | 将 Redis 数据映射为 PostgreSQL 外部表，支持通过标准 SELECT/INSERT/UPDATE/DELETE 语句读写 Redis | 统一 SQL 查询、轻量级数据同步、透明化缓存读写及跨库数据分析
2933
|====
3034

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

‎CN/modules/ROOT/pages/master/ecosystem_components/redis_fdw.adoc‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
2+
:sectnums:
3+
:sectnumlevels: 5
4+
5+
= redis_fdw
6+
7+
== 概述
8+
redis_fdw 实现PostgreSQL与Redis键值数据库的连接，支持SELECT、INSERT、UPDATE、DELETE等操作，适用于PostgreSQL 10+及Redis 6.0左右版本，可处理哈希、列表等多种数据类型。在 PostgreSQL 和 Oracle 兼容模式下均可正常工作。
9+
10+
== 安装
11+
12+
[TIP]
13+
源码安装环境为 Ubuntu 24.04(x86_64)，环境中已经安装了IvorySQL5及以上版本，安装路径为/usr/ivory-5。
14+
15+
=== 源码安装
16+
17+
[literal]
18+
----
19+
# 安装 Hiredis 库
20+
wget https://github.com/redis/hiredis/archive/refs/tags/v1.3.0.tar.gz
21+
tar xzvf v1.3.0.tar.gz
22+
cd hiredis-1.3.0
23+
make
24+
sudo make install
25+
sudo ldconfig
26+
27+
# 安装本地 Redis 服务
28+
sudo apt update
29+
sudo apt install -y redis-server
30+
31+
# 本地Redis服务默认开启，127.0.0.1:6379
32+
33+
# 使用 redis-cli 命令 创建一个管理员用户：（临时创建的用户重启 Redis 会丢失）
34+
# 用户：highgo，密码：Admin@123，启用，全键全命令
35+
ACL SETUSER highgo on >Admin@123 ~* +@all
36+
37+
# 下载 redis_fdw 源码包
38+
git clone https://github.com/pg-redis-fdw/redis_fdw.git -b REL_18_STABLE
39+
cd redis_fdw
40+
41+
# 编译安装 redis_fdw 插件
42+
make PG_CONFIG=/usr/ivory-5/bin/pg_config
43+
sudo make install PG_CONFIG=/usr/ivory-5/bin/pg_config
44+
45+
----
46+
47+
[TIP]
48+
如果出现找不到xlocale.h的错误，需要手动修改 /usr/ivory-5/include/postgresql/server/pg_config.h
49+
删除或者注释掉 #define HAVE_XLOCALE_H 1 这一行
50+
51+
=== 创建Extension
52+
53+
[literal]
54+
----
55+
postgres=# create extension redis_fdw;
56+
CREATE EXTENSION
57+
----
58+
59+
== 使用
60+
61+
[literal]
62+
----
63+
// 创建外部服务器
64+
// Create a foreign server with appropriate configuration
65+
postgres=# CREATE SERVER redis_server
66+
postgres-# FOREIGN DATA WRAPPER redis_fdw
67+
postgres-# OPTIONS ( address '127.0.0.1', port '6379');
68+
CREATE SERVER
69+
----
70+
71+
[literal]
72+
----
73+
// 创建用户映射
74+
// User mapping
75+
postgres=# CREATE USER MAPPING FOR highgo
76+
postgres-# SERVER redis_server
77+
postgres-# OPTIONS (password 'Admin@123');
78+
CREATE USER MAPPING
79+
----
80+
81+
[literal]
82+
----
83+
// 创建一个简单表
84+
postgres=# CREATE FOREIGN TABLE redis_db0 (
85+
postgres(# key text,
86+
postgres(# val text
87+
postgres(# )
88+
postgres-# SERVER redis_server
89+
postgres-# OPTIONS (
90+
postgres(# database '0'
91+
postgres(# );
92+
CREATE FOREIGN TABLE
93+
----
94+
95+
[literal]
96+
----
97+
// 插入数据
98+
postgres=# insert into redis_db0 values('k2', 'v2');
99+
INSERT 0 1
100+
----
101+
102+
[literal]
103+
----
104+
// 读取数据
105+
postgres=# select * from redis_db0;
106+
key | val
107+
-----+-----
108+
k2 | v2
109+
(1 row)
110+
----

‎EN/modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
*** xref:master/ecosystem_components/pg_curl.adoc[pg_curl]
5959
*** xref:master/ecosystem_components/pg_textsearch.adoc[pg_textsearch]
6060
*** xref:master/ecosystem_components/pg_hint_plan.adoc[pg_hint_plan]
61+
*** xref:master/ecosystem_components/redis_fdw.adoc[redis_fdw]
6162
* Monitor and O&M
6263
** xref:master/getting-started/daily_monitoring.adoc[Monitoring]
6364
** xref:master/getting-started/daily_maintenance.adoc[Maintenance]

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,15 @@ IvorySQL, as an advanced open-source database compatible with Oracle and based o
2222
|*8*| xref:master/ecosystem_components/pgaudit.adoc[pgaudit] | 18.0 | Provides fine-grained auditing, recording database operation logs to support security auditing and compliance checks | Database security auditing, compliance checks, audit report generation
2323
|*9*| xref:master/ecosystem_components/pgrouting.adoc[pgrouting] | 3.8.0 | Provides routing computation for geospatial data, supporting multiple algorithms and data formats | Geospatial analysis, route planning, logistics optimization
2424
|*10*| xref:master/ecosystem_components/system_stats.adoc[system_stats] | 3.2 | Provide functions for accessing system-level statistics. | system monitor
25-
|*11*| xref:master/ecosystem_components/pg_ai_query.adoc[pg_ai_query] | 0.1.1 | AI-driven natural language to SQL extension supporting multiple LLMs | AI-assisted querying, natural language database interaction
25+
|*11*| xref:master/ecosystem_components/wal2json.adoc[wal2json] | 2.6 | converts database Write-Ahead Log (WAL) changes into structured JSON format | it is primarily used for change data capture (CDC), real-time data replication, event-driven microservices, cache invalidation, and cross-database synchronization
2626
|*12*| xref:master/ecosystem_components/pg_stat_monitor.adoc[pg_stat_monitor] | 2.3.1 | Collects performance statistics and provides query performance insights in a single view and graphically in histogram. | Performance monitoring
27-
|*13*| xref:master/ecosystem_components/pg_partman.adoc[pg_partman] | 5.2 | Automates the creation, maintenance, and cleanup of native partition subtables. | Large-Scale Data Storage Management
28-
|*14*| xref:master/ecosystem_components/pg_curl.adoc[pg_curl] | 2.4 | A libcurl-based network transfer extension supporting HTTP/HTTPS, FTP, SMTP, IMAP, and 20+ other protocols, enabling network data transfer operations directly in SQL | REST API integration, email sending, file transfer, external system notifications
29-
|*15*| xref:master/ecosystem_components/pg_hint_plan.adoc[pg_hint_plan] | PG18 | Controls execution plans via SQL comment hints, optimizing query performance without modifying SQL logic | Query performance optimization, execution plan tuning, database performance analysis
27+
|*13*| xref:master/ecosystem_components/pg_ai_query.adoc[pg_ai_query] | 0.1.1 | AI-driven natural language to SQL extension supporting multiple LLMs | AI-assisted querying, natural language database interaction
28+
|*14*| xref:master/ecosystem_components/pg_partman.adoc[pg_partman] | 5.2 | Automates the creation, maintenance, and cleanup of native partition subtables. | Large-Scale Data Storage Management
29+
|*15*| xref:master/ecosystem_components/pgbouncer.adoc[pgbouncer] | x.x |
30+
|*16*| xref:master/ecosystem_components/pg_curl.adoc[pg_curl] | 2.4 | A libcurl-based network transfer extension supporting HTTP/HTTPS, FTP, SMTP, IMAP, and 20+ other protocols, enabling network data transfer operations directly in SQL | REST API integration, email sending, file transfer, external system notifications
31+
|*17*| xref:master/ecosystem_components/pg_textsearch.adoc[pg_textsearch] | 0.6.1 | enhances PostgreSQL with full-text search capabilities, enabling fast text indexing, tokenization, and efficient full-text querying | document and content retrieval
32+
|*18*| xref:master/ecosystem_components/pg_hint_plan.adoc[pg_hint_plan] | PG18 | Controls execution plans via SQL comment hints, optimizing query performance without modifying SQL logic | Query performance optimization, execution plan tuning, database performance analysis
33+
|*19*| xref:master/ecosystem_components/redis_fdw.adoc[redis_fdw] | PG18 | connects PostgreSQL with Redis, supporting standard SQL operations including SELECT, INSERT, UPDATE, and DELETE | unified SQL querying, lightweight data synchronization, transparent cache access, and cross-database data analysis
3034
|====
3135

3236
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/redis_fdw.adoc‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
2+
:sectnums:
3+
:sectnumlevels: 5
4+
5+
= redis_fdw
6+
7+
== Overview
8+
redis_fdw enables the connection between PostgreSQL and the Redis key-value database, supporting operations such as SELECT, INSERT, UPDATE, and DELETE. It is compatible with PostgreSQL 10+ and Redis versions around 6.0, and can handle various data types including hashes and lists. It works in both PostgreSQL and Oracle compatibility modes..
9+
10+
== Installation
11+
12+
[TIP]
13+
The source code installation environment is Ubuntu 24.04 (x86_64), in which IvorySQL 5 or a later version has been installed. The installation path is /usr/ivory-5.
14+
15+
=== Source Code Installation
16+
17+
[literal]
18+
----
19+
# Install Hiredis lib
20+
wget https://github.com/redis/hiredis/archive/refs/tags/v1.3.0.tar.gz
21+
tar xzvf v1.3.0.tar.gz
22+
cd hiredis-1.3.0
23+
make
24+
sudo make install
25+
sudo ldconfig
26+
27+
# Install local Redis server
28+
sudo apt update
29+
sudo apt install -y redis-server
30+
31+
# Local Redis server is running on 127.0.0.1:6379
32+
33+
# Create an administrator user using the redis-cli command:
34+
# (Temporarily created users will be lost after Redis restarts.)
35+
# User: highgo, password: Admin@123
36+
ACL SETUSER highgo on >Admin@123 ~* +@all
37+
38+
# Download source code of redis_fdw
39+
git clone https://github.com/pg-redis-fdw/redis_fdw.git -b REL_18_STABLE
40+
cd redis_fdw
41+
42+
# Compile and install redis_fdw extension
43+
make PG_CONFIG=/usr/ivory-5/bin/pg_config
44+
sudo make install PG_CONFIG=/usr/ivory-5/bin/pg_config
45+
46+
----
47+
48+
[TIP]
49+
If there is error "xlocale.h: No such file or directory" during compilation, user should remove the line of "#define HAVE_XLOCALE_H 1" from file /usr/ivory-5/include/postgresql/server/pg_config.h.
50+
51+
=== Create extension
52+
53+
[literal]
54+
----
55+
postgres=# create extension redis_fdw;
56+
CREATE EXTENSION
57+
----
58+
59+
== Usage
60+
61+
[literal]
62+
----
63+
// Create a foreign server with appropriate configuration
64+
postgres=# CREATE SERVER redis_server
65+
postgres-# FOREIGN DATA WRAPPER redis_fdw
66+
postgres-# OPTIONS ( address '127.0.0.1', port '6379');
67+
CREATE SERVER
68+
----
69+
70+
[literal]
71+
----
72+
// User mapping
73+
postgres=# CREATE USER MAPPING FOR highgo
74+
postgres-# SERVER redis_server
75+
postgres-# OPTIONS (password 'Admin@123');
76+
CREATE USER MAPPING
77+
----
78+
79+
[literal]
80+
----
81+
// Create a simple table
82+
postgres=# CREATE FOREIGN TABLE redis_db0 (
83+
postgres(# key text,
84+
postgres(# val text
85+
postgres(# )
86+
postgres-# SERVER redis_server
87+
postgres-# OPTIONS (
88+
postgres(# database '0'
89+
postgres(# );
90+
CREATE FOREIGN TABLE
91+
----
92+
93+
[literal]
94+
----
95+
// Insert data
96+
postgres=# insert into redis_db0 values('k2', 'v2');
97+
INSERT 0 1
98+
----
99+
100+
[literal]
101+
----
102+
// Read the data
103+
postgres=# select * from redis_db0;
104+
key | val
105+
-----+-----
106+
k2 | v2
107+
(1 row)
108+
----

0 commit comments

Comments
 (0)