SPI_cursor_open_with_args

支持中的版本：当前版本 (18) / 17 / 16 / 15 / 14

开发中的版本： 19 / 20devel

已结束支持的版本： 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4

预发布版本文档。 PostgreSQL 19beta4 为测试版本，最终发布内容可能有所不同。

SPI_cursor_open_with_args
上一页	上一级	45.1. 接口函数	起始页	下一页

SPI_cursor_open_with_args — 使用一个查询和参数建立一个游标

大纲

Portal SPI_cursor_open_with_args(const char *name,
                                 const char *command,
                                 int nargs, Oid *argtypes,
                                 const Datum *values, const char *nulls,
                                 bool read_only, int cursorOptions)

描述

SPI_cursor_open_with_args 建立一个将执行指定查询的游标（在内部是一个 portal）。大部分参数具有和 SPI_prepare_cursor 和 SPI_cursor_open 中相应参数相同的含义。

对于一次性查询执行，应优先使用此函数，而不是先调用 SPI_prepare_cursor 再调用 SPI_cursor_open。如果同一条命令要用许多不同参数执行，哪种方法更快取决于重新规划的代价与定制计划收益之间的权衡。

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

此函数现已弃用，推荐改用 SPI_cursor_parse_open，它提供了等价的功能，并使用更现代的查询参数处理 API。

参数

const char * name

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

const char * command

命令字符串

int nargs

输入参数的数量（$1、$2 等）

Oid * argtypes

一个长度为 nargs 的数组，包含参数数据类型的 OID

Datum * values

一个长度为 nargs 的数组，包含实际参数值

const char * nulls

一个长度为 nargs 的数组，用于描述哪些参数为空值

如果 nulls 为 NULL，则 SPI_cursor_open_with_args 会假定没有参数为空值。否则，如果对应参数值非空值，则 nulls 数组中的对应项应为 ' '；如果对应参数值为空值，则对应项应为 'n'。（后一种情况下，对应 values 项中的实际值无关紧要。）注意，nulls 不是文本字符串，而只是一个数组，因此不需要 '\0' 终止符。

bool read_only

true 表示只读执行

int cursorOptions

整数形式的游标选项位掩码，零会导致默认行为

返回值

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

上一页	上一级	下一页
SPI_cursor_open	起始页	SPI_cursor_open_with_paramlist

报告文档问题

阅读上游文档. 反馈更正前请先核对当前版本手册.