PostgreSQL 17 文档: SPI_cursor_open_with_args

SPI_cursor_open_with_args
上一个	向上	45.1. 界面函数	主页	下一个

SPI_cursor_open_with_args

SPI_cursor_open_with_args — 使用查询和参数设置游标

概要

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

说明

SPI_cursor_open_with_args 设置游标（在内部，为门户），该游标将执行指定的查询。大多数参数的含义与 SPI_prepare_cursor 和 SPI_cursor_open 的相应参数意义相同。

对于一次性查询执行，此函数应该优先于 SPI_prepare_cursor，后跟 SPI_cursor_open。如果要使用许多不同的参数执行相同命令，根据重新规划的成本与自定义规划的收益，这两种方法都可能更快。

输入的参数数据将复制到游标的门户中，以便在游标仍然存在时释放数据。

此函数现已被弃用，取而代之的是 SPI_cursor_parse_open，它使用较现代的 API 处理查询参数以提供同等功能。

参数

const char * name

门户名称，或 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

游标选项的整数位掩码；零会产生默认行为

返回值

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