Search PostgreSQL documentation

SPI_getrelnameManual ChaptersPG18SPI_getrelname SPI_getrelname — return the name of the specified relation Synopsis char * SPI_getrelname(Relation rel)SPI_getrelname SPI_gettypeManual ChaptersPG18SPI_gettype SPI_gettype — return the data type name of the specified column Synopsis char * SPI_gettype(TupleDesc rowdesc, int colnumber)SPI_gettype SPI_gettypeidManual ChaptersPG18SPI_gettypeid SPI_gettypeid — return the data type OID of the specified column Synopsis Oid SPI_gettypeid(TupleDesc rowdesc, int colnumber)SPI_gettypeid SPI_getvalueManual ChaptersPG18SPI_getvalue SPI_getvalue — return the string value of the specified column Synopsis char * SPI_getvalue(HeapTuple row, TupleDesc rowdesc, int colnumber)SPI_getvalue SPI_is_cursor_planManual ChaptersPG18SPI_is_cursor_plan SPI_is_cursor_plan — return true if a statement prepared by SPI_prepare can be used with SPI_cursor_open Synopsis bool SPI_is_cursor_plan(SPIPlanPtr plan)SPI_is_cursor_plan SPI_keepplanManual ChaptersPG18SPI_keepplan SPI_keepplan — save a prepared statement Synopsis int SPI_keepplan(SPIPlanPtr plan)SPI_keepplan SPI_modifytupleManual ChaptersPG18SPI_modifytuple SPI_modifytuple — create a row by replacing selected fields of a given row Synopsis HeapTuple SPI_modifytuple(Relation rel, HeapTuple row, int ncols, int * colnum, Datum * va…SPI_modifytuple SPI_pallocManual ChaptersPG18SPI_palloc SPI_palloc — allocate memory in the upper executor context Synopsis void * SPI_palloc(Size size)SPI_palloc SPI_pfreeManual ChaptersPG18SPI_pfree SPI_pfree — free memory in the upper executor context Synopsis void SPI_pfree(void * pointer)SPI_pfree SPI_prepareManual ChaptersPG18SPI_prepare SPI_prepare — prepare a statement, without executing it yet Synopsis SPIPlanPtr SPI_prepare(const char * command, int nargs, Oid * argtypes)SPI_prepare SPI_prepare_cursorManual ChaptersPG18SPI_prepare_cursor SPI_prepare_cursor — prepare a statement, without executing it yet Synopsis SPIPlanPtr SPI_prepare_cursor(const char * command, int nargs, Oid * argtypes, int cursorOption…SPI_prepare_cursor SPI_prepare_extendedManual ChaptersPG18SPI_prepare_extended SPI_prepare_extended — prepare a statement, without executing it yet Synopsis SPIPlanPtr SPI_prepare_extended(const char * command, const SPIPrepareOptions * options)SPI_prepare_extended SPI_prepare_paramsManual ChaptersPG18SPI_prepare_params SPI_prepare_params — prepare a statement, without executing it yet Synopsis SPIPlanPtr SPI_prepare_params(const char * command, ParserSetupHook parserSetup, void * parserS…SPI_prepare_params SPI_register_relationManual ChaptersPG18SPI_register_relation SPI_register_relation — make an ephemeral named relation available by name in SPI queries Synopsis int SPI_register_relation(EphemeralNamedRelation enr)SPI_register_relation SPI_register_trigger_dataManual ChaptersPG18SPI_register_trigger_data SPI_register_trigger_data — make ephemeral trigger data available in SPI queries Synopsis int SPI_register_trigger_data(TriggerData *tdata)SPI_register_trigger_data SPI_repallocManual ChaptersPG18SPI_repalloc SPI_repalloc — reallocate memory in the upper executor context Synopsis void * SPI_repalloc(void * pointer, Size size)SPI_repalloc SPI_result_code_stringManual ChaptersPG18SPI_result_code_string SPI_result_code_string — return error code as string Synopsis const char * SPI_result_code_string(int code);SPI_result_code_string SPI_returntupleManual ChaptersPG18SPI_returntuple SPI_returntuple — prepare to return a tuple as a Datum Synopsis HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc rowdesc)SPI_returntuple SPI_rollbackManual ChaptersPG18SPI_rollback SPI_rollback, SPI_rollback_and_chain — abort the current transaction Synopsis void SPI_rollback(void) void SPI_rollback_and_chain(void)SPI_rollback SPI_saveplanManual ChaptersPG18SPI_saveplan SPI_saveplan — save a prepared statement Synopsis SPIPlanPtr SPI_saveplan(SPIPlanPtr plan)SPI_saveplan SPI_scroll_cursor_fetchManual ChaptersPG18SPI_scroll_cursor_fetch SPI_scroll_cursor_fetch — fetch some rows from a cursor Synopsis void SPI_scroll_cursor_fetch(Portal portal, FetchDirection direction, long count)SPI_scroll_cursor_fetch SPI_scroll_cursor_moveManual ChaptersPG18SPI_scroll_cursor_move SPI_scroll_cursor_move — move a cursor Synopsis void SPI_scroll_cursor_move(Portal portal, FetchDirection direction, long count)SPI_scroll_cursor_move SPI_start_transactionManual ChaptersPG18SPI_start_transaction SPI_start_transaction — obsolete function Synopsis void SPI_start_transaction(void)SPI_start_transaction SPI_unregister_relationManual ChaptersPG18SPI_unregister_relation SPI_unregister_relation — remove an ephemeral named relation from the registry Synopsis int SPI_unregister_relation(const char * name)SPI_unregister_relation SQL CommandsManual ChaptersPG18SQL Commands This part contains reference information for the SQL commands supported by PostgreSQL. By “SQL” the language in general is meant; information about the standards conformance and…SQL Commands SQL ConformanceManual ChaptersPG18Appendix D. SQL Conformance This section attempts to outline to what extent PostgreSQL conforms to the current SQL standard. The following information is not a full statement of conformance,…SQL Conformance SQL DumpManual ChaptersPG1825.1. SQL Dump The idea behind this dump method is to generate a file with SQL commands that, when fed back to the server, will recreate the database in the same state as it was at the time …SQL Dump SQL Functions as Table SourcesManual ChaptersPG1836.5.8. SQL Functions as Table Sources All SQL functions can be used in the FROM clause of a query, but it is particularly useful for functions returning composite types. If the function is …SQL Functions as Table Sources SQL Functions on Base TypesManual ChaptersPG1836.5.2. SQL Functions on Base Types The simplest possible SQL function has no arguments and simply returns a base type, such as integer: CREATE FUNCTION one() RETURNS integer AS $$ SELECT 1 …SQL Functions on Base Types SQL Functions on Composite TypesManual ChaptersPG1836.5.3. SQL Functions on Composite Types When writing functions with arguments of composite types, we must not only specify which argument we want but also the desired attribute (field) of t…SQL Functions on Composite Types SQL Functions Returning SetsManual ChaptersPG1836.5.9. SQL Functions Returning Sets When an SQL function is declared as returning SETOF sometype, the function's final query is executed to completion, and each row it outputs is returned a…SQL Functions Returning Sets SQL Functions Returning TABLEManual ChaptersPG1836.5.10. SQL Functions Returning TABLE There is another way to declare a function as returning a set, which is to use the syntax RETURNS TABLE(columns). This is equivalent to using one or mo…SQL Functions Returning TABLE SQL Functions with CollationsManual ChaptersPG1836.5.12. SQL Functions with Collations When an SQL function has one or more parameters of collatable data types, a collation is identified for each function call depending on the collations …SQL Functions with Collations SQL Functions with Default Values for ArgumentsManual ChaptersPG1836.5.7. SQL Functions with Default Values for Arguments Functions can be declared with default values for some or all input arguments. The default values are inserted whenever the function i…SQL Functions with Default Values for Arguments SQL Functions with Output ParametersManual ChaptersPG1836.5.4. SQL Functions with Output Parameters An alternative way of describing a function's results is to define it with output parameters, as in this example: CREATE FUNCTION add_em (IN x in…SQL Functions with Output Parameters SQL Functions with Variable Numbers of ArgumentsManual ChaptersPG1836.5.6. SQL Functions with Variable Numbers of Arguments SQL functions can be declared to accept variable numbers of arguments, so long as all the “optional” arguments are of the same data t…SQL Functions with Variable Numbers of Arguments SQL InterpolationManual ChaptersPG18SQL Interpolation A key feature of psql variables is that you can substitute (“interpolate”) them into regular SQL statements, as well as the arguments of meta-commands. Furthermore, psql pr…SQL Interpolation SQL Key WordsManual ChaptersPG18Appendix C. SQL Key Words Table C.1 lists all tokens that are key words in the SQL standard and in PostgreSQL 18.6. Background information can be found in Section 4.1.1. (For space reasons, …SQL Key Words SQL Procedures with Output ParametersManual ChaptersPG1836.5.5. SQL Procedures with Output Parameters Output parameters are also supported in procedures, but they work a bit differently from functions. In CALL commands, output parameters must be …SQL Procedures with Output Parameters SQL SyntaxManual ChaptersPG18Chapter 4. SQL Syntax This chapter describes the syntax of SQL. It forms the foundation for understanding the following chapters which will go into detail about how SQL commands are applied …SQL Syntax