Search PostgreSQL documentation

DescriptionManual ChaptersPG18Description SPI_getbinval returns the value of the specified column in the internal form (as type Datum). This function does not allocate new space for the datum. In the case of a pass-by-re…Description DescriptionManual ChaptersPG18Description SPI_getnspname returns a copy of the name of the namespace that the specified Relation belongs to. This is equivalent to the relation's schema. You should pfree the return value …Description DescriptionManual ChaptersPG18Description SPI_getrelname returns a copy of the name of the specified relation. (You can use pfree to release the copy of the name when you don't need it anymore.)Description DescriptionManual ChaptersPG18Description SPI_gettype returns a copy of the data type name of the specified column. (You can use pfree to release the copy of the name when you don't need it anymore.)Description DescriptionManual ChaptersPG18Description SPI_gettypeid returns the OID of the data type of the specified column.Description DescriptionManual ChaptersPG18Description SPI_getvalue returns the string representation of the value of the specified column. The result is returned in memory allocated using palloc. (You can use pfree to release the me…Description DescriptionManual ChaptersPG18Description SPI_is_cursor_plan returns true if a statement prepared by SPI_prepare can be passed as an argument to SPI_cursor_open, or false if that is not the case. The criteria are that th…Description DescriptionManual ChaptersPG18Description SPI_keepplan saves a passed statement (prepared by SPI_prepare) so that it will not be freed by SPI_finish nor by the transaction manager. This gives you the ability to reuse pre…Description DescriptionManual ChaptersPG18Description SPI_modifytuple creates a new row by substituting new values for selected columns, copying the original row's columns at other positions. The input row is not modified. The new r…Description DescriptionManual ChaptersPG18Description SPI_palloc allocates memory in the upper executor context. This function can only be used while connected to SPI. Otherwise, it throws an error.Description DescriptionManual ChaptersPG18Description SPI_pfree frees memory previously allocated using SPI_palloc or SPI_repalloc. This function is no longer different from plain pfree. It's kept just for backward compatibility of …Description DescriptionManual ChaptersPG18Description SPI_prepare_cursor is identical to SPI_prepare, except that it also allows specification of the planner's “cursor options” parameter. This is a bit mask having the values shown i…Description DescriptionManual ChaptersPG18Description SPI_prepare_extended creates and returns a prepared statement for the specified command, but doesn't execute the command. This function is equivalent to SPI_prepare, with the add…Description DescriptionManual ChaptersPG18Description SPI_prepare_params creates and returns a prepared statement for the specified command, but doesn't execute the command. This function is equivalent to SPI_prepare_cursor, with th…Description DescriptionManual ChaptersPG18Description SPI_prepare creates and returns a prepared statement for the specified command, but doesn't execute the command. The prepared statement can later be executed repeatedly using SPI…Description DescriptionManual ChaptersPG18Description SPI_register_relation makes an ephemeral named relation, with associated information, available to queries planned and executed through the current SPI connection.Description DescriptionManual ChaptersPG18Description SPI_register_trigger_data makes any ephemeral relations captured by a trigger available to queries planned and executed through the current SPI connection. Currently, this means …Description DescriptionManual ChaptersPG18Description SPI_result_code_string returns a string representation of the result code returned by various SPI functions or stored in SPI_result.Description DescriptionManual ChaptersPG18Description SPI_returntuple makes a copy of a row in the upper executor context, returning it in the form of a row type Datum. The returned pointer need only be converted to Datum via Pointe…Description DescriptionManual ChaptersPG18Description SPI_rollback rolls back the current transaction. It is approximately equivalent to running the SQL command ROLLBACK. After the transaction is rolled back, a new transaction is au…Description DescriptionManual ChaptersPG18Description SPI_saveplan copies a passed statement (prepared by SPI_prepare) into memory that will not be freed by SPI_finish nor by the transaction manager, and returns a pointer to the cop…Description DescriptionManual ChaptersPG18Description SPI_scroll_cursor_fetch fetches some rows from a cursor. This is equivalent to the SQL command FETCH.Description DescriptionManual ChaptersPG18Description SPI_scroll_cursor_move skips over some number of rows in a cursor. This is equivalent to the SQL command MOVE.Description DescriptionManual ChaptersPG18Description SPI_start_transaction does nothing, and exists only for code compatibility with earlier PostgreSQL releases. It used to be required after calling SPI_commit or SPI_rollback, but …Description DescriptionManual ChaptersPG18Description SPI_unregister_relation removes an ephemeral named relation from the registry for the current connection.Description DescriptionManual ChaptersPG18Description ABORT rolls back the current transaction and causes all the updates made by the transaction to be discarded. This command is identical in behavior to the standard SQL command ROL…Description DescriptionManual ChaptersPG18Description ALTER AGGREGATE changes the definition of an aggregate function. You must own the aggregate function to use ALTER AGGREGATE. To change the schema of an aggregate function, you mu…Description DescriptionManual ChaptersPG18Description ALTER COLLATION changes the definition of a collation. You must own the collation to use ALTER COLLATION. To alter the owner, you must be able to SET ROLE to the new owning role,…Description DescriptionManual ChaptersPG18Description ALTER CONVERSION changes the definition of a conversion. You must own the conversion to use ALTER CONVERSION. To alter the owner, you must be able to SET ROLE to the new owning r…Description DescriptionManual ChaptersPG18Description ALTER DATABASE changes the attributes of a database. The first form changes certain per-database settings. (See below for details.) Only the database owner or a superuser can cha…Description DescriptionManual ChaptersPG18Description ALTER DEFAULT PRIVILEGES allows you to set the privileges that will be applied to objects created in the future. (It does not affect privileges assigned to already-existing objec…Description DescriptionManual ChaptersPG18Description ALTER DOMAIN changes the definition of an existing domain. There are several sub-forms: SET/DROP DEFAULT These forms set or remove the default value for a domain. Note that defau…Description DescriptionManual ChaptersPG18Description ALTER EVENT TRIGGER changes properties of an existing event trigger. You must be superuser to alter an event trigger.Description DescriptionManual ChaptersPG18Description ALTER EXTENSION changes the definition of an installed extension. There are several subforms: UPDATE This form updates the extension to a newer version. The extension must supply…Description DescriptionManual ChaptersPG18Description ALTER FOREIGN DATA WRAPPER changes the definition of a foreign-data wrapper. The first form of the command changes the support functions or the generic options of the foreign-dat…Description DescriptionManual ChaptersPG18Description ALTER FOREIGN TABLE changes the definition of an existing foreign table. There are several subforms: ADD [ COLUMN ] [ IF NOT EXISTS ] This form adds a new column to the foreign t…Description DescriptionManual ChaptersPG18Description ALTER FUNCTION changes the definition of a function. You must own the function to use ALTER FUNCTION. To change a function's schema, you must also have CREATE privilege on the ne…Description DescriptionManual ChaptersPG18Description ALTER GROUP changes the attributes of a user group. This is an obsolete command, though still accepted for backwards compatibility, because groups (and users too) have been super…Description DescriptionManual ChaptersPG18Description ALTER INDEX changes the definition of an existing index. There are several subforms described below. Note that the lock level required may differ for each subform. An ACCESS EXCL…Description DescriptionManual ChaptersPG18Description ALTER LANGUAGE changes the definition of a procedural language. The only functionality is to rename the language or assign a new owner. You must be superuser or owner of the lang…Description