Postgresql 中文操作指南

SPI_cursor_open_with_args

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

Synopsis

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)

Description

SPI_cursor_open_with_args 设置将执行指定查询的游标（在内部，一个门户）。大部分参数具有与 SPI_prepare_cursor 和 SPI_cursor_open 中相应参数相同的含义。

对于一次性查询执行，此函数应优于 SPI_prepare_cursor ，后跟 SPI_cursor_open 。如果使用许多不同的参数执行同一个命令，任何一个方法都可能更快，具体取决于重新规划的成本与自定义规划的好处。

传入的参数数据将被复制到光标的门户中，因此可在光标仍然存在时释放它。

此函数目前已弃用，因为 SPI_cursor_parse_open 取而代之，它使用更现代的 API 来处理查询参数，提供等效的功能。

Arguments

  • const char * _name_

    • * 门户名称，或 NULL 以让系统选择名称

  • const char * _command_

    • command string

  • int _nargs_

    • 输入参数数（ $1 、 $2 等）

  • Oid * _argtypes_

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

  • Datum * _values_

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

  • const char * _nulls_

    • 长度为 nargs 的数组，描述哪些参数为 null

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

  • bool _read_only_

    • true for read-only execution

  • int _cursorOptions_

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

Return Value

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