支持的版本: 当前 (17) / 16 / 15 / 14 / 13
开发版本: 开发版
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4

SPI_cursor_open

SPI_cursor_open — 使用通过 SPI_prepare 创建的语句设置游标

概要

Portal SPI_cursor_open(const char * name, SPIPlanPtr plan,
                       Datum * values, const char * nulls,
                       bool read_only)

描述

SPI_cursor_open 设置一个游标(内部是一个门户),它将执行由 SPI_prepare 准备的语句。参数的含义与 SPI_execute_plan 的相应参数相同。

使用游标而不是直接执行语句有两个好处。首先,可以一次检索少量结果行,从而避免了返回大量行的查询导致内存溢出。其次,门户的生命周期可以比当前的 C 函数长(实际上,它可以持续到当前事务结束)。将门户名称返回给 C 函数的调用者,提供了一种返回结果行集的方法。

传入的参数数据将被复制到游标的门户中,因此在游标仍然存在时可以释放它。

参数

const char * name

门户的名称,或者 NULL 让系统选择名称

SPIPlanPtr plan

准备好的语句(由 SPI_prepare 返回)

Datum * values

实际参数值的数组。必须与语句的参数数量具有相同的长度。

const char * nulls

描述哪些参数为空的数组。必须与语句的参数数量具有相同的长度。

如果 nullsNULL,则 SPI_cursor_open 假定没有参数为空。否则,nulls 数组的每个条目应该为 ' ' 如果对应的参数值非空,或者为 'n' 如果对应的参数值为空。(在后一种情况下,对应的 values 条目中的实际值并不重要。)请注意,nulls 不是文本字符串,而只是一个数组:它不需要 '\0' 终止符。

bool read_only

对于只读执行为 true

返回值

指向包含游标的门户的指针。请注意,没有错误返回约定;任何错误都将通过 elog 报告。

提交更正

如果您在文档中看到任何不正确的内容,与您对特定功能的体验不符,或者需要进一步澄清的内容,请使用此表单报告文档问题。