选择 打开 改范围 完整检索页

pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。

受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
测试与开发版本: 19 / devel
不受支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0
历史版本PostgreSQL 9.1 已于 2016 年 10 月结束社区维护,本页译文保留供仍在使用旧版本的读者参考。新系统请看当前版本

SPI_cursor_open

SPI_cursor_open — set up a cursor using a plan created with SPI_prepare

大纲

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

描述

SPI_cursor_open 建立一个游标(在内部是一个 portal),该游标将执行由 SPI_prepare 准备好的 一个计划。参数具有和 SPI_execute_plan 的 相应参数相同的含义。

使用游标而不是直接执行该计划有两个好处。首先,可以一次只取出少量 结果行,从而避免对返回大量行的查询耗尽内存。其次,一个 portal 可以比当前的过程存活更久(实际上,它可以一直存活到当前事务结束)。 把 portal 的名称返回给该过程的调用者,就提供了一种把行集作为 结果返回的方法。

传入的参数数据会被复制到该游标的 portal 中,因此即使该游标仍然存在, 也可以释放这些参数数据。

参数

const char * name

portal 的名称,或为NULL以让系统选择名称

SPIPlanPtr plan

执行计划(由 SPI_prepare 返回)

Datum * values

一个实际参数值的数组。必须与该计划的参数个数等长。

const char * nulls

一个描述哪些参数为空值的数组。必须与该计划的参数个数等长。 n 表示空值(values 中的对应项 会被忽略);空格表示非空值(values 中的对应项 有效)。

如果 nullsNULL,则 SPI_cursor_open 假定没有参数为空值。

bool read_only

true 表示只读执行

返回值

指向包含该游标的 portal 的指针。注意这里没有错误返回约定, 任何错误都将通过elog报告。

提交更正

译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。