Search PostgreSQL documentation

Return ValueManual ChaptersPG18Return Value If the execution of the command was successful then one of the following (nonnegative) values will be returned: SPI_OK_SELECT if a SELECT (but not SELECT INTO) was executed SPI_…Return Value Return ValueManual ChaptersPG18Return Value SPI_OK_FINISH if properly disconnected SPI_ERROR_UNCONNECTED if called from an unconnected C functionReturn Value Return ValueManual ChaptersPG18Return Value The column name; NULL if colnumber is out of range. SPI_result set to SPI_ERROR_NOATTRIBUTE on error.Return Value Return ValueManual ChaptersPG18Return Value Column number (count starts at 1 for user-defined columns), or SPI_ERROR_NOATTRIBUTE if the named column was not found.Return Value Return ValueManual ChaptersPG18Return Value 0 on success; SPI_ERROR_ARGUMENT if plan is NULL or invalidReturn Value Return ValueManual ChaptersPG18Return Value The count of expected arguments for the plan. If the plan is NULL or invalid, SPI_result is set to SPI_ERROR_ARGUMENT and -1 is returned.Return Value Return ValueManual ChaptersPG18Return Value The type OID of the argument at the given index. If the plan is NULL or invalid, or argIndex is less than 0 or not less than the number of arguments declared for the plan, SPI_r…Return Value Return ValueManual ChaptersPG18Return Value The binary value of the column is returned. The variable pointed to by isnull is set to true if the column is null, else to false. SPI_result is set to SPI_ERROR_NOATTRIBUTE on …Return Value Return ValueManual ChaptersPG18Return Value The name of the specified relation's namespace.Return Value Return ValueManual ChaptersPG18Return Value The name of the specified relation.Return Value Return ValueManual ChaptersPG18Return Value The data type name of the specified column, or NULL on error. SPI_result is set to SPI_ERROR_NOATTRIBUTE on error.Return Value Return ValueManual ChaptersPG18Return Value The OID of the data type of the specified column or InvalidOid on error. On error, SPI_result is set to SPI_ERROR_NOATTRIBUTE.Return Value Return ValueManual ChaptersPG18Return Value Column value, or NULL if the column is null, colnumber is out of range (SPI_result is set to SPI_ERROR_NOATTRIBUTE), or no output function is available (SPI_result is set to SPI…Return Value Return ValueManual ChaptersPG18Return Value true or false to indicate if the plan can produce a cursor or not, with SPI_result set to zero. If it is not possible to determine the answer (for example, if the plan is NULL o…Return Value Return ValueManual ChaptersPG18Return Value 0 on success; SPI_ERROR_ARGUMENT if plan is NULL or invalidReturn Value Return ValueManual ChaptersPG18Return Value new row with modifications, allocated in the upper executor context, or NULL on error (see SPI_result for an error indication) On error, SPI_result is set as follows: SPI_ERROR_…Return Value Return ValueManual ChaptersPG18Return Value pointer to new storage space of the specified sizeReturn Value Return ValueManual ChaptersPG18Return Value SPI_prepare_cursor has the same return conventions as SPI_prepare.Return Value Return ValueManual ChaptersPG18Return Value SPI_prepare_extended has the same return conventions as SPI_prepare.Return Value Return ValueManual ChaptersPG18Return Value SPI_prepare_params has the same return conventions as SPI_prepare.Return Value Return ValueManual ChaptersPG18Return Value SPI_prepare returns a non-null pointer to an SPIPlan, which is an opaque struct representing a prepared statement. On error, NULL will be returned, and SPI_result will be set to…Return Value Return ValueManual ChaptersPG18Return Value If the execution of the command was successful then the following (nonnegative) value will be returned: SPI_OK_REL_REGISTER if the relation has been successfully registered by n…Return Value Return ValueManual ChaptersPG18Return Value If the execution of the command was successful then the following (nonnegative) value will be returned: SPI_OK_TD_REGISTER if the captured trigger data (if any) has been success…Return Value Return ValueManual ChaptersPG18Return Value A string representation of the result code.Return Value Return ValueManual ChaptersPG18Return Value HeapTupleHeader pointing to copied row, or NULL on error (see SPI_result for an error indication)Return Value Return ValueManual ChaptersPG18Return Value Pointer to the copied statement; or NULL if unsuccessful. On error, SPI_result is set thus: SPI_ERROR_ARGUMENT if plan is NULL or invalid SPI_ERROR_UNCONNECTED if called from an…Return Value Return ValueManual ChaptersPG18Return Value SPI_processed and SPI_tuptable are set as in SPI_execute if successful.Return Value Return ValueManual ChaptersPG18Return Value SPI_processed is set as in SPI_execute if successful. SPI_tuptable is set to NULL, since no rows are returned by this function.Return Value Return ValueManual ChaptersPG18Return Value If the execution of the command was successful then the following (nonnegative) value will be returned: SPI_OK_REL_UNREGISTER if the tuplestore has been successfully removed fro…Return Value Returning CursorsManual ChaptersPG1841.7.3.5. Returning Cursors PL/pgSQL functions can return cursors to the caller. This is useful to return multiple rows or columns, especially with very large result sets. To do this, the fu…Returning Cursors Returning Data from Modified RowsManual ChaptersPG186.4. Returning Data from Modified Rows Sometimes it is useful to obtain data from modified rows while they are being manipulated. The INSERT, UPDATE, DELETE, and MERGE commands all have an o…Returning Data from Modified Rows Returning from a FunctionManual ChaptersPG1841.6.1. Returning from a Function There are two commands available that allow you to return data from a function: RETURN and RETURN NEXT.Returning from a Function Returning from a ProcedureManual ChaptersPG1841.6.2. Returning from a Procedure A procedure does not have a return value. A procedure can therefore end without a RETURN statement. If you wish to use a RETURN statement to exit the code …Returning from a Procedure Returning Rows (Composite Types)Manual ChaptersPG1836.10.8. Returning Rows (Composite Types) To return a row or composite-type value from a C-language function, you can use a special API that provides macros and functions to hide most of the…Returning Rows (Composite Types) Returning SetsManual ChaptersPG1836.10.9. Returning Sets C-language functions have two options for returning sets (multiple rows). In one method, called ValuePerCall mode, a set-returning function is called repeatedly (pass…Returning Sets REVOKEManual ChaptersPG18REVOKE REVOKE — remove access privileges Synopsis REVOKE [ GRANT OPTION FOR ] { { SELECT | INSERT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER | MAINTAIN } [, ...] | ALL [ PRIVILEGES …REVOKE Role AttributesManual ChaptersPG1821.2. Role Attributes A database role can have a number of attributes that define its privileges and interact with the client authentication system. login privilege Only roles that have the …Role Attributes Role MembershipManual ChaptersPG1821.3. Role Membership It is frequently convenient to group users together to ease management of privileges: that way, privileges can be granted to, or revoked from, a group as a whole. In Po…Role Membership role_column_grantsManual ChaptersPG1835.35. role_column_grants The view role_column_grants identifies all privileges granted on columns where the grantor or grantee is a currently enabled role. Further information can be found …role_column_grants role_routine_grantsManual ChaptersPG1835.36. role_routine_grants The view role_routine_grants identifies all privileges granted on functions where the grantor or grantee is a currently enabled role. Further information can be fo…role_routine_grants