Movatterモバイル変換

Table of Contents

45.1. Interface Functions

SPI_connect— connect a C function to the SPI manager

SPI_finish— disconnect a C function from the SPI manager

SPI_execute— execute a command

SPI_exec— execute a read/write command

SPI_execute_extended— execute a command with out-of-line parameters

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_extended— 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 bySPI_prepare

SPI_getargtypeid— return the data type OID for an argument of a statement prepared bySPI_prepare

SPI_is_cursor_plan— returntrue if a statement prepared bySPI_prepare can be used withSPI_cursor_open

SPI_execute_plan— execute a statement prepared bySPI_prepare

SPI_execute_plan_extended— execute a statement prepared bySPI_prepare

SPI_execute_plan_with_paramlist— execute a statement prepared bySPI_prepare

SPI_execp— execute a statement in read/write mode

SPI_cursor_open— set up a cursor using a statement created withSPI_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_parse_open— set up a cursor using a query string and 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

45.2. Interface Support Functions

SPI_fname— determine the column name for the specified column number

SPI_fnumber— determine the column number for the specified column name

SPI_getvalue— return the string value of the specified column

SPI_getbinval— return the binary value of the specified column

SPI_gettype— return the data type name of the specified column

SPI_gettypeid— return the data typeOID of the specified column

SPI_getrelname— return the name of the specified relation

SPI_getnspname— return the namespace of the specified relation

SPI_result_code_string— return error code as string

45.3. Memory Management

SPI_palloc— allocate memory in the upper executor context

SPI_repalloc— reallocate memory in the upper executor context

SPI_pfree— free memory in the upper executor context

SPI_copytuple— make a copy of a row in the upper executor context

SPI_returntuple— prepare to return a tuple as a Datum

SPI_modifytuple— create a row by replacing selected fields of a given row

SPI_freetuple— free a row allocated in the upper executor context

SPI_freetuptable— free a row set created bySPI_execute or a similar function

SPI_freeplan— free a previously saved prepared statement

45.4. Transaction Management

SPI_commit— commit the current transaction

SPI_rollback— abort the current transaction

SPI_start_transaction— obsolete function

45.5. Visibility of Data Changes

45.6. Examples

Note

The available procedural languages provide various means to execute SQL commands from functions. Most of these facilities are based on SPI, so this documentation might be of use for users of those languages as well.