2024年9月26日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本: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 报告。

提交更正

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