opengauss/wasmtime

openGauss-wasmtime 镜像文档

镜像概述和主要用途

openGauss-wasmtime是一个基于Wasmtime的完整成熟的WebAssembly运行时，专为openGauss数据库设计。它提供了一种创新方式来扩展数据库能力，允许通过WebAssembly模块（如Rust等语言编译的.wasm文件）向openGauss添加自定义功能。

核心功能和特性

• 易用性：wasmtime API模仿标准WebAssembly API，易于理解和使用
• 高性能：wasmtime以接近原生的速度执行WebAssembly模块，确保高效运行
• 安全性：所有WebAssembly调用均在安全的沙箱环境中执行，保障数据库安全

使用场景和适用范围

适用于需要扩展openGauss数据库功能的场景，包括但不限于：

• 实现自定义数据处理逻辑
• 添加特定领域的计算函数
• 集成第三方算法或业务规则
• 安全地执行用户提供的代码片段

使用方法和配置说明

基本使用流程

1. 编写并编译WebAssembly模块（如使用Rust）
2. 在openGauss中创建WebAssembly实例
3. 调用导出的函数

示例：Rust函数编译与调用

1. 编写Rust代码

创建sum.rs文件：

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

2. 编译为WebAssembly

将Rust代码编译为.wasm二进制文件（需安装Rust和wasm32目标）：

shell
rustc --target wasm32-unknown-unknown sum.rs -o sum.wasm

3. 在在openGauss中使用WebAssembly函数**创建实例并调用函数：```sql

-- 创建WebAssembly实例（指定.wasm文件绝对路径和SQL函数前缀） SELECT wasm_new_instance('/absolute/path/to/sum.wasm', 'wasm');

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

-- 输出结果： -- wasm_sum

-- 3 -- (1 row)

### 数据类型映射

目前支持的WebAssembly类型与openGauss类型映射：
- `i32` → `integer`
- `i64` → `bigint`

> 注意：浮点数类型目前部分实现，暂不推荐用于生产环境。

## Docker部署示例

### 拉取镜像
```shell
docker pull opengauss/opengauss-wasmtime:0.1.0

运行容器

shell
docker run -it opengauss/opengauss-wasmtime:0.1.0 bash

查看WebAssembly实例信息

初始化方式

扩展提供两种初始化WebAssembly实例的方法：

• wasm_new_instance：从编译后的.wasm二进制文件创建实例
• wasm_new_instance_wat：从WebAssembly文本格式（.wat）文件创建实例

系统表

waswasm外部 schema下提供两个表用于查看实例信息：

wasm.instances**：存储WebAssembly实例信息

示例查询：

sql
SELECT * FROM wasm.instances;

--      id               |          wasm_file
-- ---------------+-------------------------------
--  2785875771    | /absolute/path/to/sum.wasm
--  378061239    | /absolute/path/to/gcdcd.wat
-- (1 row)

wasm.exported_functions：存储导出函数信息

示例查询：

sql
SELECT funcname, inputs, outputs 
FROM wasm.exported_functions 
WHERE instanceid = 2785875771;

--   name  |     inputs      | outputs
-- --------+-----------------+---------
--  wasm_sum | integer,integer | integer
-- (1 row)

许可证

本项目采用MulanPSL2许可证。详情请参阅LICENSE文件。