session_exec 项目使用教程

session_exec 项目使用教程

1. 项目目录结构及介绍

session_exec 是一个 PostgreSQL 扩展，用于在用户登录时执行指定的函数。以下是项目的目录结构及其介绍：

session_exec/
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
└── session_exec.c

• .gitignore: 用于指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的开源许可证文件，采用 BSD-2-Clause 许可证。
• Makefile: 用于编译和安装扩展的 Makefile 文件。
• README.md: 项目的说明文档，包含基本的使用方法和配置说明。
• session_exec.c: 扩展的核心源代码文件，实现了登录时执行指定函数的功能。

2. 项目的启动文件介绍

session_exec 扩展的启动文件是 session_exec.c。该文件包含了扩展的主要逻辑，用于在用户登录时执行指定的函数。以下是该文件的主要功能介绍：

• session_exec_init: 初始化扩展，注册登录时执行的函数。
• session_exec_startup: 在 PostgreSQL 启动时加载扩展，并配置登录时执行的函数。
• session_exec_shutdown: 在 PostgreSQL 关闭时清理扩展资源。

3. 项目的配置文件介绍

session_exec 扩展的配置主要通过 PostgreSQL 的配置文件 postgresql.conf 进行。以下是相关的配置项及其说明：

• session_preload_libraries: 指定在连接开始时预载入的共享库，需要设置为 session_exec。

  session_preload_libraries = 'session_exec'
  

• session_exec.login_name: 指定在登录时执行的函数名称。

  session_exec.login_name = 'your_login_function'
  

通过以上配置，session_exec 扩展会在用户登录时自动执行指定的函数，从而实现自定义的登录验证逻辑。

4. 安装与使用

4.1 安装步骤

1. 下载 session_exec 扩展：

   git clone https://github.com/okbob/session_exec.git
   

2. 编译并安装扩展：

   cd session_exec
   make
   sudo make install
   

3. 在 postgresql.conf 中添加配置：

   session_preload_libraries = 'session_exec'
   session_exec.login_name = 'your_login_function'
   

4. 重启 PostgreSQL 服务：

   sudo systemctl restart postgresql
   

4.2 使用示例

假设你有一个名为 check_login 的函数，用于检查用户登录次数并锁定用户。你可以在 postgresql.conf 中配置如下：

session_preload_libraries = 'session_exec'
session_exec.login_name = 'check_login'

然后，在 PostgreSQL 中创建 check_login 函数：

CREATE OR REPLACE FUNCTION check_login() RETURNS void AS $$
BEGIN
    -- 自定义登录检查逻辑
END;
$$ LANGUAGE plpgsql;

通过以上步骤，session_exec 扩展会在每次用户登录时自动执行 check_login 函数，从而实现自定义的登录验证逻辑。