历史版本。 PostgreSQL 10 已结束支持。 2022-11-10. 请参阅 当前版本手册.
第 46 章 服务器编程接口
目录
- 46.1. 接口函数
- SPI_connect — 将一个过程连接到 SPI 管理器
- SPI_finish — 将一个过程与 SPI 管理器断开
- SPI_execute — 执行一个命令
- SPI_exec — 执行一个读/写命令
- SPI_execute_with_args — 执行使用外部参数的命令
- SPI_prepare — 准备一个语句，但暂不执行
- SPI_prepare_cursor — 准备一个语句，但暂不执行
- SPI_prepare_params — 准备一个语句，但暂不执行
- SPI_getargcount — 返回由
SPI_prepare准备的语句所需参数个数 - SPI_getargtypeid — 返回由
SPI_prepare准备的语句中某个参数的数据类型 OID - SPI_is_cursor_plan — 如果由
SPI_prepare准备的语句可用于SPI_cursor_open则返回true - SPI_execute_plan — 执行由
SPI_prepare准备好的语句 - SPI_execute_plan_with_paramlist — 执行由
SPI_prepare准备好的语句 - SPI_execp — 以读/写模式执行一个语句
- SPI_cursor_open — 使用由
SPI_prepare创建的语句建立一个游标 - SPI_cursor_open_with_args — 使用一个查询和参数建立一个游标
- SPI_cursor_open_with_paramlist — 使用参数建立一个游标
- SPI_cursor_find — 用名称查找一个现有的游标
- SPI_cursor_fetch — 从一个游标取出一些行
- SPI_cursor_move — 移动一个游标
- SPI_scroll_cursor_fetch — 从一个游标取出一些行
- SPI_scroll_cursor_move — 移动一个游标
- SPI_cursor_close — 关闭一个游标
- SPI_keepplan — 保存一个预备语句
- SPI_saveplan — 保存一个预备语句
- SPI_register_relation — 让临时命名关系可在 SPI 查询中按名称使用
- SPI_unregister_relation — 从注册表中移除一个临时命名关系
- SPI_register_trigger_data — 让触发器捕获的临时数据可在 SPI 查询中使用
- 46.2. 接口支持函数
- SPI_fname — 为指定的列号确定列名
- SPI_fnumber — 根据指定列名确定列号
- SPI_getvalue — 返回指定列的字符串值
- SPI_getbinval — 返回指定列的二进制值
- SPI_gettype — 返回指定列的数据类型名称
- SPI_gettypeid — 返回指定列的数据类型的 OID
- SPI_getrelname — 返回指定关系的名称
- SPI_getnspname — 返回指定关系所属的名字空间
- 46.3. 内存管理
- SPI_palloc — 在上层执行器上下文中分配内存
- SPI_repalloc — 在上层执行器上下文中重分配内存
- SPI_pfree — 在上层执行器上下文中释放内存
- SPI_copytuple — 在上层执行器上下文中创建一行的副本
- SPI_returntuple — 准备把一个元组返回为一个 Datum
- SPI_modifytuple — 通过替换给定行的选定字段来创建新行
- SPI_freetuple — 释放一个在上层执行器上下文中分配的行
- SPI_freetuptable — 释放由
SPI_execute或类似函数创建的结果行集 - SPI_freeplan — 释放一个之前保存的预备语句
- 46.4. 数据更改的可见性
- 46.5. 示例
服务器编程接口（SPI）使用户定义 C 函数的编写者能够在其函数中运行 SQL 命令。SPI 是一组接口函数，用于简化对解析器、规划器和执行器的访问。SPI 还负责一部分内存管理工作。
注意
可用的过程语言提供了多种从过程中执行 SQL 命令的方法。这些设施大多基于 SPI，因此本文档对这些语言的用户也会有帮助。
为避免误解，本文用“函数”指 SPI 接口函数，而用“过程”指使用 SPI 的用户定义 C 函数。
注意，如果通过 SPI 调用的某条命令失败，控制不会返回到你的过程。相反，执行该过程的事务或子事务会被回滚。（考虑到 SPI 函数大多记录了错误返回约定，这一点可能看起来有些意外。不过，这些约定只适用于在 SPI 函数自身内部检测到的错误。）如果在可能失败的 SPI 调用外围建立自己的子事务，则可以在出错后重新取得控制权。
SPI 函数在成功时返回非负结果（要么直接作为整数返回值，要么如后文所述存放在全局变量 SPI_result 中）。发生错误时，则返回负值或 NULL。
使用 SPI 的源代码文件必须包含头文件
executor/spi.h。
46.1. 接口函数 #
- SPI_connect — 将一个过程连接到 SPI 管理器
- SPI_finish — 将一个过程与 SPI 管理器断开
- SPI_execute — 执行一个命令
- SPI_exec — 执行一个读/写命令
- SPI_execute_with_args — 执行使用外部参数的命令
- SPI_prepare — 准备一个语句，但暂不执行
- SPI_prepare_cursor — 准备一个语句，但暂不执行
- SPI_prepare_params — 准备一个语句，但暂不执行
- SPI_getargcount — 返回由
SPI_prepare准备的语句所需参数个数 - SPI_getargtypeid — 返回由
SPI_prepare准备的语句中某个参数的数据类型 OID - SPI_is_cursor_plan — 如果由
SPI_prepare准备的语句可用于SPI_cursor_open则返回true - SPI_execute_plan — 执行由
SPI_prepare准备好的语句 - SPI_execute_plan_with_paramlist — 执行由
SPI_prepare准备好的语句 - SPI_execp — 以读/写模式执行一个语句
- SPI_cursor_open — 使用由
SPI_prepare创建的语句建立一个游标 - SPI_cursor_open_with_args — 使用一个查询和参数建立一个游标
- SPI_cursor_open_with_paramlist — 使用参数建立一个游标
- SPI_cursor_find — 用名称查找一个现有的游标
- SPI_cursor_fetch — 从一个游标取出一些行
- SPI_cursor_move — 移动一个游标
- SPI_scroll_cursor_fetch — 从一个游标取出一些行
- SPI_scroll_cursor_move — 移动一个游标
- SPI_cursor_close — 关闭一个游标
- SPI_keepplan — 保存一个预备语句
- SPI_saveplan — 保存一个预备语句
- SPI_register_relation — 让临时命名关系可在 SPI 查询中按名称使用
- SPI_unregister_relation — 从注册表中移除一个临时命名关系
- SPI_register_trigger_data — 让触发器捕获的临时数据可在 SPI 查询中使用