# SPI_光标_解析_打开

SPI_光标_解析_open — 使用查询字符串和参数设置游标

# 概要

Portal SPI_cursor_parse_open(const char *name,
                             const char *command,
                             const SPIParseOpenOptions * options)

# 描述

SPI_cursor_parse_open设置将执行指定查询字符串的游标(内部为门户)。这相当于SPI_prepare_cursor其次是SPI_cursor_open_with_paramlist, 除了查询字符串中的参数引用完全通过提供参数列表信息目的。

对于一次性查询执行,此功能应优先于SPI_prepare_cursor其次是SPI_cursor_open_with_paramlist.如果要使用许多不同的参数执行相同的命令,则任何一种方法都可能更快,这取决于重新计划的成本与自定义计划的好处。

这*选项->参数*对象通常应该用PARAM_FLAG_CONST标志,因为查询始终使用一次性计划。

传入的参数数据将被复制到游标的门户中,因此可以在游标仍然存在时将其释放。

# 论据

常量字符 * *姓名*

门户名称,或空值让系统选择一个名字

常量字符 * *命令*

命令字符串

常量 SPIParseOpenOptions * *选项*

包含可选参数的结构

来电者应始终将整个内容归零*选项struct,然后填写他们想要设置的任何字段。这确保了代码的前向兼容性,因为将来添加到结构中的任何字段都将被定义为向后兼容,如果它们为零。目前可用的选项*字段是:

参数列表信息 *参数*

包含查询参数类型和值的数据结构;如果没有则为 NULL

整数 *光标选项*

光标选项的整数位掩码;零产生默认行为

布尔 *只读*

真的用于只读执行

# 返回值

指向包含光标的门户的指针。注意没有错误返回约定;任何错误都会通过elog.