PostgreSQL【应用 03】Docker部署的PostgreSQL扩展SQL之C语言函数（编写、编译、载入）计算向量余弦距离实例分享

通过使用 PostgreSQL 的 C 函数接口，我们可以编写用 C 语言实现的函数，并将其集成到数据库中。这些函数可以在 SQL 查询中像其他内置函数一样被调用，从而扩展 PostgreSQL 的功能。

C 函数在某些情况下可以提供比 SQL 函数更高的执行效率，因为它们可以直接访问底层系统资源并进行更高级的优化。通过使用 C 函数，我们可以在函数内部实现复杂的算法和逻辑，利用 C 语言的功能和库来提高执行效率。

环境说明：

# 此版本库可用
[root@tcloud ~]# docker -v
Docker version 20.10.13, build a224086

# 此版本不可用
[root@nodexxx ~]# docker -v
Docker version 1.13.1, build 7d71120/1.13.1

注意：Docker version 1.13.1无法使用。

1.准备

1.1 开发文档

-- 查询数据库版本
SELECT "version"()
-- PostgreSQL 12.12 (Debian 12.12-1.pgdg110+1) on x86_64-pc-linux-gnu, compiled by gcc (Debian 10.2.1-6) 10.2.1 20210110, 64-bit

根据数据库的版本查看文档：

英文：PostgreSQL: Documentation: 12: 37.10. C-Language Functions

中文：37.10. C 语言函数 (postgres.cn)

1.2 工具安装

# 避免报错1 bash: cc: command not found
# 未 update 可能会报错 E: Unable to locate package gcc
apt-get update
apt-get install gcc

# 避免报错2
functionNameFile.c:1:10: fatal error: postgres.h: No such file or directory
    1 | #include "postgres.h"
      |          ^~~~~~~~~~~~
compilation terminated.

# 根据版本进行安装【必备】
apt-get install postgresql-server-dev-12
# 报错
postgresql-server-dev-12 : Depends: llvm-11-dev but it is not installable

2.开始

2.1 编写C语言函数

创建一个新的文件，例如 cosine_distance_c.c，并添加以下内容：

#include "postgres.h"
#include "fmgr.h"
#include "math.h"
#include "utils/array.h"
#include "utils/float.h"

PG_MODULE_MAGIC;

PG_FUNCTION_INFO_V1(cosine_distance_c);

Datum cosine_distance_c(PG_FUNCTION_ARGS)
{
    ArrayType *arr1;
    arr1  = PG_GETARG_ARRAYTYPE_P(0);
    ArrayType *arr2;
    arr2 = PG_GETARG_ARRAYTYPE_P(1);
    int num_elems1, num_elems2;
    int16 elmlen;
    bool elmbyval, elmIsNull;
    Datum *elems1, *elems2;
    float8 sum_xy = 0.00000;
    float8 sum_x2 = 0.00000;
    float8 sum_y2 = 0.00000;
    float8 result;
    int i;
    deconstruct_array(arr1, 701, 8, FLOAT8PASSBYVAL, 'd', &elems1, NULL, &num_elems1);
    deconstruct_array(arr2, 701, 8, FLOAT8PASSBYVAL, 'd', &elems2, NULL, &num_elems2);
    if (num_elems1 != num_elems2)
        ereport(ERROR, (errmsg("Array lengths are not equal")));
    for (i = 0; i < num_elems1; i++)
    {
        sum_xy = sum_xy +  DatumGetFloat8(elems1[i]) * DatumGetFloat8(elems2[i]);
        sum_x2 = sum_x2 +  DatumGetFloat8(elems1[i]) * DatumGetFloat8(elems1[i]);
        sum_y2 = sum_y2 +  DatumGetFloat8(elems2[i]) * DatumGetFloat8(elems2[i]);
    }
    if (sum_x2 == 0.0 || sum_y2 == 0.0)
        ereport(ERROR, (errmsg("One or both arrays have zero magnitude")));
    result = sum_xy / (sqrt(sum_x2) * sqrt(sum_y2));
    pfree(elems1);
    pfree(elems2);
    PG_RETURN_FLOAT8(result);
}

2.2 编译和链接动态载入的函数

Linux环境：

# 创建PIC的编译器标志是-fpic。创建一个共享库的编译器标志是-shared。
cc -fPIC -c funcs.c
cc -shared -o funcs.so funcs.o

实例使用 C 编译器将源代码编译为共享库，例如 cosine_distance_c.so：

# 使用
cc -fPIC -I`pg_config --includedir-server` -c cosine_distance_c.c
cc -shared -o cosine_distance_c.so cosine_distance_c.o -I`pg_config --includedir-server` -lm

3. 将共享库文件复制到 PostgreSQL 的共享库目录中：

cp cosine_distance_c.so `pg_config --libdir`/.

# 实际查询
root@a0e33689b846:/# pg_config --libdir
/usr/lib/x86_64-linux-gnu

4. 在 PostgreSQL 中创建函数的定义：

-- 这里用到了 pg_config --libdir 查询到的目录
CREATE FUNCTION cosine_distance_c(float8[], float8[])
    RETURNS float8
    AS '//usr/lib/x86_64-linux-gnu/cosine_distance_c.so', 'cosine_distance_c'
    LANGUAGE C STRICT;

现在，你可以在 SQL 查询中使用 cosine_distance_c 函数来计算两个 numeric 数组之间的余弦距离，例如：

SELECT cosine_distance_c(ARRAY[1.0, 2.0, 3.0], ARRAY[4.0, 5.0, 6.0]);

注意：上述示例是一个简化的实现，它假设传入的两个数组参数都是 numeric 类型的一维数组。在实际应用中，你可能需要进行更多的参数校验和错误处理，并支持更复杂的数组类型和维度。