SPI\_execute\_plan

|        SPI\_execute\_plan         |                        |                         |                  |                                           |
|:---------------------------------:|------------------------|-------------------------|------------------|-------------------------------------------|
|[Prev](spi-spi-is-cursor-plan.html)|[Up](spi-interface.html)|47.1. Interface Functions|[Home](index.html)| [Next](spi-spi-execute-plan-extended.html)|

---

[]()

## SPI\_execute\_plan

SPI\_execute\_plan — execute a statement prepared by `SPI_prepare`

## Synopsis

```
int SPI_execute_plan(SPIPlanPtr plan, Datum * values, const char * nulls,
                     bool read_only, long count)

```

## Description

`SPI_execute_plan` executes a statement prepared by `SPI_prepare` or one of its siblings. *`read_only`* and *`count`* have the same interpretation as in `SPI_execute`.

## Arguments

`SPIPlanPtr *`plan`*`

 prepared statement (returned by `SPI_prepare`)

`Datum * *`values`*`

 An array of actual parameter values. Must have same length as the statement's number of arguments.

`const char * *`nulls`*`

 An array describing which parameters are null. Must have same length as the statement's number of arguments.

 If *`nulls`* is `NULL` then `SPI_execute_plan` assumes that no parameters are null. Otherwise, each entry of the *`nulls`* array should be `' '` if the corresponding parameter value is non-null, or `'n'` if the corresponding parameter value is null. (In the latter case, the actual value in the corresponding *`values`* entry doesn't matter.) Note that *`nulls`* is not a text string, just an array: it does not need a `'\0'` terminator.

`bool *`read_only`*`

`true` for read-only execution

`long *`count`*`

 maximum number of rows to return, or `0` for no limit

## Return Value

 The return value is the same as for `SPI_execute`, with the following additional possible error (negative) results:

`SPI_ERROR_ARGUMENT`

 if *`plan`* is `NULL` or invalid, or *`count`* is less than 0

`SPI_ERROR_PARAM`

 if *`values`* is `NULL` and *`plan`* was prepared with some parameters

`SPI_processed` and `SPI_tuptable` are set as in `SPI_execute` if successful.

---

|[Prev](spi-spi-is-cursor-plan.html)|[Up](spi-interface.html)| [Next](spi-spi-execute-plan-extended.html)|
|:----------------------------------|:----------------------:|------------------------------------------:|
|       SPI\_is\_cursor\_plan       |   [Home](index.html)   |        SPI\_execute\_plan\_extended       |

 // \<![CDATA[ \<-- For SVG support if ('WebSocket' in window) { (function() { function refreshCSS() { var sheets = [].slice.call(document.getElementsByTagName("link")); var head = document.getElementsByTagName("head")[0]; for (var i = 0; i \< sheets.length; ++i) { var elem = sheets[i]; head.removeChild(elem); var rel = elem.rel; if (elem.href && typeof rel != "string" || rel.length == 0 || rel.toLowerCase() == "stylesheet") { var url = elem.href.replace(/(&|\\?)\_cacheOverride=\\d+/, ''); elem.href = url + (url.indexOf('?') \>= 0 ? '&' : '?') + '\_cacheOverride=' + (new Date().valueOf()); } head.appendChild(elem); } } var protocol = window.location.protocol === 'http:' ? 'ws://' : 'wss://'; var address = protocol + window.location.host + window.location.pathname + '/ws'; var socket = new WebSocket(address); socket.onmessage = function(msg) { if (msg.data == 'reload') window.location.reload(); else if (msg.data == 'refreshcss') refreshCSS(); }; console.log('Live reload enabled.'); })(); } // ]]\>