Postgresql 中文操作指南

SPI_cursor_open

SPI_cursor_open——使用通过 SPI_prepare 创建的语句设置一个游标

Synopsis

Portal SPI_cursor_open(const char * name, SPIPlanPtr plan,
                       Datum * values, const char * nulls,
                       bool read_only)

Description

SPI_cursor_open 设置一个游标（在内部，一个门户）用于执行 SPI_prepare 准备的语句。这些参数与 SPI_execute_plan 的对应参数意义相同。

使用游标而不是直接执行语句有两个好处。首先，可以一次检索少量结果行，避免为返回多数行的查询导致内存溢出。其次，一个门户在当前 C 函数完成后仍然有效（实际上，它可以在当前事务结束时仍然有效）。将门户名称返回到 C 函数的调用者提供了一种以结果的方式返回一组行。

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

Arguments

  • const char * _name_

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

  • SPIPlanPtr _plan_

    • * 已准备好的语句（由 SPI_prepare 返回）

  • Datum * _values_

    • 实际参数值的数组。其长度必须与语句的参数数量相同。

  • const char * _nulls_

    • 描述为 null 的参数的数组。其长度必须与语句的参数数量相同。

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

  • bool _read_only_

    • true for read-only execution

Return Value

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