opengauss/wasmedge

openGauss WebAssembly运行时（基于WasmEdge）

镜像概述和主要用途

这是一个基于WasmEdge的完整成熟的openGauss WebAssembly运行时，提供了一种创新方式来扩展openGauss数据库的功能。该项目受https://github.com/wasmerio/wasmer-postgres%E5%90%AF%E5%8F%91%EF%BC%8C%E5%85%81%E8%AE%B8%E9%80%9A%E8%BF%87WebAssembly%E6%A8%A1%E5%9D%97%E5%9C%A8openGauss%E4%B8%AD%E6%89%A7%E8%A1%8C%E8%87%AA%E5%AE%9A%E4%B9%89%E9%80%BB%E8%BE%91%E3%80%82

注意：该项目仍在积极开发中，当前版本为0.1.0，部分API尚未实现，但已可用于体验和测试。

核心功能和特性

• 易于使用：wasmedge API模仿标准WebAssembly API，降低使用门槛
• 高性能：wasmedge以接近原生速度执行WebAssembly模块，性能优异
• 安全性：所有WebAssembly调用不仅快速，更重要的是完全安全且沙箱隔离

使用场景和适用范围

适用于需要扩展openGauss数据库功能的场景，特别是：

• 需要在数据库中执行自定义计算逻辑
• 希望替代PL/pgSQL等过程语言以获得更高性能
• 需要安全隔离的自定义函数执行环境
• 希望使用Rust等系统级语言编写数据库扩展

安装方法

该项目包含两部分组件：

1. 共享库
2. PL/pgSQL扩展

前提条件

需先安装WasmEdge，详细安装指南参见WasmEdge官方文档。

编译与安装步骤

shell
# 编译共享库
$ make

# 安装扩展到openGauss
$ make install

# 激活并初始化扩展
$ gsql -d postgres -c 'CREATE EXTENSION wasm_executor'

安装完成后，将创建wasm_new_instance函数，用于实例化WebAssembly模块。

使用方法和配置说明

WebAssembly模块开发示例

以Rust编写的sum函数为例：

rust
#[no_mangle]
pub extern fn sum(x: i32, y: i32) -> i32 {
    x + y
}

环境准备

安装Rust和WebAssembly工具链：

shell
# 安装Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# 添加wasm目标
rustup target add wasm32-unknown-unknown

# 安装wasm-gc（用于压缩wasm文件）
cargo install wasm-gc

创建项目并配置

shell
cargo new hello --lib

修改Cargo.toml，添加[lib]部分：

toml
[package]
name = "hello"
version = "0.1.0"
edition = "2021"

[dependencies]

[lib]
crate-type = ["cdylib"]

编译为WebAssembly

shell
# 编译为wasm
cargo build --target wasm32-unknown-unknown --release

# 压缩wasm文件
wasm-gc target/wasm32-unknown-unknown/release/hello.wasm

在openGauss中使用WebAssembly模块

实例化WebAssembly模块

使用wasm_new_instance函数创建实例，需提供两个参数：

1. WebAssembly模块的绝对路径
2. 用于为导出函数添加前缀的命名空间

sql
-- 实例化sum.wasm模块，命名空间为'wasm'
SELECT wasm_new_instance('/absolute/path/to/sum.wasm', 'wasm');

调用WebAssembly函数

实例化后，将创建wasm_sum函数（命名空间+原函数名）：

sql
-- 调用WebAssembly导出的sum函数
SELECT wasm_sum(1, 2);

-- 输出结果：
--  wasm_sum
-- --------
--       3
-- (1 row)

支持的数据类型

目前支持的WebAssembly类型与openGauss类型映射：

• i32 → integer
• i64 → bigint
• 浮点数类型部分实现

Docker快速启动

推荐使用Docker镜像快速体验：

shell
# 拉取镜像
docker pull opengauss/wasmedge:0.2.0

# 运行容器
docker run -it opengauss/wasmedge:0.2.0 bash

Docker镜像中已预装Rust和WebAssembly工具链，可直接使用。

检查WebAssembly实例

扩展提供了wasm外部模式下的两个表，用于管理WebAssembly实例：

wasm.instances表

包含已创建的WebAssembly实例信息：

• id: 实例ID
• wasm_file: WebAssembly模块路径

sql
-- 查询所有WebAssembly实例
SELECT * FROM wasm.instances;

-- 示例输出：
--      id        |          wasm_file
-- ---------------+-------------------------------
--  2785875771    | /absolute/path/to/sum.wasm
-- (1 row)

wasm.exported_functions表

包含导出函数信息：

• instanceid: 实例ID
• funcname: 函数名
• inputs: 输入类型（已格式化为openGauss类型）
• output: 输出类型（已格式化为openGauss类型）

sql
-- 查询特定实例的导出函数
SELECT
    funcname,
    inputs,
    outputs
FROM
    wasm.exported_functions
WHERE
    instanceid = 2785875771;

-- 示例输出：
--   name  |     inputs      | outputs
-- --------+-----------------+---------
--  wasm_sum | integer,integer | integer
-- (1 row)

性能基准测试

以下基准测试显示WebAssembly作为数据库扩展语言的性能优势（与PL/pgSQL对比）：

注意：基准测试结果仅供参考，实际性能可能因环境而异。

许可证

整个项目采用MulanPSL2许可证。详情请阅读LICENSE文件。