章 47.服务器编程接口

目录

• 47 .1.接口功能

  • • SPI_connect —将 C 函数连接到 SPIManagement 器

  • SPI_finish —从 SPIManagement 器断开 C 函数

  • 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 查询中提供临时触发数据

• 47 .2.接口支持功能

  • • SPI_fname —确定指定列号的列名

  • SPI_fnumber —确定指定列名的列号

  • SPI_getvalue —返回指定列的字符串值

  • SPI_getbinval —返回指定列的二进制值

  • SPI_gettype —返回指定列的数据类型名称

  • SPI_gettypeid —返回指定列的数据类型 OID

  • SPI_getrelname —返回指定关系的名称

  • SPI_getnspname —返回指定关系的名称空间

  • SPI_result_code_string —以字符串形式返回错误代码

• 47 .3.内存 Management

  • • SPI_palloc —在上级执行程序上下文中分配内存

  • SPI_repalloc —在上层执行程序上下文中重新分配内存

  • SPI_pfree —上级执行程序上下文中的可用内存

  • SPI_copytuple —在上级执行者上下文中复制一行

  • SPI_returntuple —准备返回 Tuples 作为基准

  • SPI_modifytuple-通过替换给定行的选定字段来创建行

  • SPI_freetuple —释放在上级执行者上下文中分配的行

  • SPI_freetuptable-释放由SPI_execute或类似功能创建的行集

  • SPI_freeplan —释放以前保存的准备好的语句

• 47 .4.TransactionManagement

  • • SPI_commit-提交当前 Transaction

  • SPI_rollback —中止当前 Transaction

  • SPI_start_transaction-开始新 Transaction

• 47 .5.数据更改的可见性

• 47.6. Examples

服务器编程接口(SPI)使用户定义的 C 函数的编写者能够在其函数内运行 SQL 命令。 SPI 是一组接口函数，用于简化对解析器，计划器和 Actuator 的访问。 SPI 还执行一些内存 Management。

请注意，如果通过 SPI 调用的命令失败，则控制不会返回给 C 函数。而是将回滚执行 C 函数的事务或子事务。 (考虑到 SPI 函数大多已记录了错误返回约定，这似乎令人惊讶.但是，这些约定仅适用于 SPI 函数本身中检测到的错误.)可以通过在 SPI 周围构建自己的子事务来恢复错误后的控制。可能失败的呼叫。

SPI 函数成功返回非负结果(通过返回的整数值或在全局变量SPI_result中，如下所述)。错误时，将返回否定结果或NULL。

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