PostgreSQL 16 文档: SPI_cursor_open_with_args

SPI_cursor_open_with_args
上一个	向上	47.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 的数组，描述哪些参数为 null

如果 nulls 为 NULL，则 SPI_cursor_open_with_args 假设没有参数为 null。否则，如果相应的参数值为非 null，则 nulls 数组的每个条目应为 ' '；如果相应的参数值为 null，则 nulls 数组的每个条目应为 'n'。（在后一种情况下，相应的 values 条目中的实际值无关紧要。）请注意，nulls 不是文本字符串，而只是一个数组：它不需要 '\0' 终止符。

bool read_only

true 表示只读执行

int cursorOptions

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

返回值

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