受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: devel

Chapter 45. 服务器编程接口

Table of Contents

45.1. 接口函数
SPI_connect — 将一个 C 函数连接到 SPI 管理器
SPI_finish — 将一个 C 函数与 SPI 管理器断开
SPI_execute — 执行一个命令
SPI_exec — 执行一个读/写命令
SPI_execute_extended — 执行使用外部参数的命令
SPI_execute_with_args — 执行使用外部参数的命令
SPI_prepare — 准备一个语句,但不执行它
SPI_prepare_cursor — 准备一个语句,但暂不执行
SPI_prepare_extended — 准备一个语句,但暂不执行
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_extended — 执行一个由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_parse_open — 使用查询字符串和参数设置游标
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 查询中使用
45.2. 接口支持函数
SPI_fname — 为指定的列号确定列名
SPI_fnumber — 根据指定列名确定列号
SPI_getvalue — 返回指定列的字符串值
SPI_getbinval — 返回指定列的二进制值
SPI_gettype — 返回指定列的数据类型名称
SPI_gettypeid — 返回指定列的数据类型的OID
SPI_getrelname — 返回指定关系的名称
SPI_getnspname — 返回指定关系所属的名字空间
SPI_result_code_string — 将结果代码表示为字符串
45.3. 内存管理
SPI_palloc — 在上层执行器上下文中分配内存
SPI_repalloc — 在上层执行器上下文中重分配内存
SPI_pfree — 在上层执行器上下文中释放内存
SPI_copytuple — 在上层执行器上下文中创建一行的拷贝
SPI_returntuple — 准备把一个元组返回为一个 Datum
SPI_modifytuple — 通过替换给定行的选定字段来创建新行
SPI_freetuple — 释放一个在上层执行器上下文中分配的行
SPI_freetuptable — 释放由 SPI_execute 或类似函数创建的结果行集
SPI_freeplan — 释放一个之前保存的预备语句
45.4. 事务管理
SPI_commit — 提交当前事务
SPI_rollback — 回滚当前事务
SPI_start_transaction — 废弃函数
45.5. 数据改变的可见性
45.6. 示例

服务器编程接口SPI)使用户定义 C 函数的编写者能够在其函数或过程中运行 SQL 命令。SPI 是一组接口函数, 用于简化对解析器、规划器和执行器的访问。SPI 还负责一部分内存管理工作。

Note

可用的过程语言提供了多种从函数中执行 SQL 命令的方法。这些设施大多基于 SPI,因此本文档对这些语言的用户也会有帮助。

注意,如果通过 SPI 调用的某条命令失败,控制不会返回到你的 C 函数。相反, 执行该 C 函数的事务或子事务会被回滚。(考虑到 SPI 函数大多记录了错误返回 约定,这一点可能看起来有些意外。不过,这些约定只适用于在 SPI 函数自身内 部检测到的错误。)如果在可能失败的 SPI 调用外围建立自己的子事务,则可以 在出错后重新取得控制权。

SPI 函数在成功时返回非负结果(要么直接作为整数返回值, 要么如后文所述存放在全局变量 SPI_result 中)。发生错 误时,则返回负值或 NULL

使用 SPI 的源代码文件必须包含头文件 executor/spi.h

45.1. 接口函数 #

SPI_connect — 将一个 C 函数连接到 SPI 管理器
SPI_finish — 将一个 C 函数与 SPI 管理器断开
SPI_execute — 执行一个命令
SPI_exec — 执行一个读/写命令
SPI_execute_extended — 执行使用外部参数的命令
SPI_execute_with_args — 执行使用外部参数的命令
SPI_prepare — 准备一个语句,但不执行它
SPI_prepare_cursor — 准备一个语句,但暂不执行
SPI_prepare_extended — 准备一个语句,但暂不执行
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_extended — 执行一个由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_parse_open — 使用查询字符串和参数设置游标
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 查询中使用

提交更正

如果您发现文档中有不正确的内容、与您使用特定功能的经验不符或需要进一步说明,请使用此表单来报告文档问题。