PostgreSQL: Documentation: 10: 46.1. Interface Functions

September 4, 2025: PostgreSQL 18 RC 1 Released!

Supported Versions: Current (17) / 16 / 15 / 14 / 13

Development Versions: 18 / devel

Unsupported versions: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2

This documentation is for an unsupported version of PostgreSQL.
You may want to view the same page for the current version, or one of the other supported versions listed above instead.

46.1. Interface Functions
Prev	Up	Chapter 46. Server Programming Interface	Home	Next

46.1. Interface Functions

SPI_connect — connect a procedure to the SPI manager
SPI_finish — disconnect a procedure from the SPI manager
SPI_execute — execute a command
SPI_exec — execute a read/write command
SPI_execute_with_args — execute a command with out-of-line parameters
SPI_prepare — prepare a statement, without executing it yet
SPI_prepare_cursor — prepare a statement, without executing it yet
SPI_prepare_params — prepare a statement, without executing it yet
SPI_getargcount — return the number of arguments needed by a statement prepared by SPI_prepare
SPI_getargtypeid — return the data type OID for an argument of a statement prepared by SPI_prepare
SPI_is_cursor_plan — return true if a statement prepared by SPI_prepare can be used with SPI_cursor_open
SPI_execute_plan — execute a statement prepared by SPI_prepare
SPI_execute_plan_with_paramlist — execute a statement prepared by SPI_prepare
SPI_execp — execute a statement in read/write mode
SPI_cursor_open — set up a cursor using a statement created with SPI_prepare
SPI_cursor_open_with_args — set up a cursor using a query and parameters
SPI_cursor_open_with_paramlist — set up a cursor using parameters
SPI_cursor_find — find an existing cursor by name
SPI_cursor_fetch — fetch some rows from a cursor
SPI_cursor_move — move a cursor
SPI_scroll_cursor_fetch — fetch some rows from a cursor
SPI_scroll_cursor_move — move a cursor
SPI_cursor_close — close a cursor
SPI_keepplan — save a prepared statement
SPI_saveplan — save a prepared statement
SPI_register_relation — make an ephemeral named relation available by name in SPI queries
SPI_unregister_relation — remove an ephemeral named relation from the registry
SPI_register_trigger_data — make ephemeral trigger data available in SPI queries

Prev	Up	Next
Chapter 46. Server Programming Interface	Home	SPI_connect