Search PostgreSQL documentation

DescriptionManual ChaptersPG18Description SET CONNECTION sets the “current” database connection, which is the one that all commands use unless overridden.Description DescriptionManual ChaptersPG18Description SET DESCRIPTOR populates an SQL descriptor area with values. The descriptor area is then typically used to bind parameters in a prepared query execution. This command has two for…Description DescriptionManual ChaptersPG18Description The TYPE command defines a new C type. It is equivalent to putting a typedef into a declare section. This command is only recognized when ecpg is run with the -c option.Description DescriptionManual ChaptersPG18Description The VAR command assigns a new C data type to a host variable. The host variable must be previously declared in a declare section.Description DescriptionManual ChaptersPG18Description Define a behavior which is called on the special cases (Rows not found, SQL warnings or errors) in the result of SQL execution.Description DescriptionManual ChaptersPG18Description oid2name is a utility program that helps administrators to examine the file structure used by PostgreSQL. To make use of it, you need to be familiar with the database file struct…Description DescriptionManual ChaptersPG18Description pg_archivecleanup is designed to be used as an archive_cleanup_command to clean up WAL file archives when running as a standby server (see Section 26.2). pg_archivecleanup can al…Description DescriptionManual ChaptersPG18Description pgbench is a simple program for running benchmark tests on PostgreSQL. It runs the same sequence of SQL commands over and over, possibly in multiple concurrent database sessions,…Description DescriptionManual ChaptersPG18Description pg_test_fsync is intended to give you a reasonable idea of what the fastest wal_sync_method is on your specific system, as well as supplying diagnostic information in the event o…Description DescriptionManual ChaptersPG18Description pg_test_timing is a tool to measure the timing overhead on your system and confirm that the system time never moves backwards. Systems that are slow to collect timing data can gi…Description DescriptionManual ChaptersPG18Description pg_upgrade (formerly called pg_migrator) allows data stored in PostgreSQL data files to be upgraded to a later PostgreSQL major version without the data dump/restore typically re…Description DescriptionManual ChaptersPG18Description pg_waldump displays the write-ahead log (WAL) and is mainly useful for debugging or educational purposes. This utility can only be run by the user who installed the server, becau…Description DescriptionManual ChaptersPG18Description SPI_repalloc changes the size of a memory segment previously allocated using SPI_palloc. This function is no longer different from plain repalloc. It's kept just for backward com…Description DescriptionManual ChaptersPG18Description SPI_commit commits the current transaction. It is approximately equivalent to running the SQL command COMMIT. After the transaction is committed, a new transaction is automatical…Description DescriptionManual ChaptersPG18Description SPI_connect opens a connection from a C function invocation to the SPI manager. You must call this function if you want to execute commands through SPI. Some utility SPI function…Description DescriptionManual ChaptersPG18Description SPI_copytuple makes a copy of a row in the upper executor context. This is normally used to return a modified row from a trigger. In a function declared to return a composite typ…Description DescriptionManual ChaptersPG18Description SPI_cursor_close closes a previously created cursor and releases its portal storage. All open cursors are closed automatically at the end of a transaction. SPI_cursor_close need …Description DescriptionManual ChaptersPG18Description SPI_cursor_fetch fetches some rows from a cursor. This is equivalent to a subset of the SQL command FETCH (see SPI_scroll_cursor_fetch for more functionality).Description DescriptionManual ChaptersPG18Description SPI_cursor_find finds an existing portal by name. This is primarily useful to resolve a cursor name returned as text by some other function.Description DescriptionManual ChaptersPG18Description SPI_cursor_move skips over some number of rows in a cursor. This is equivalent to a subset of the SQL command MOVE (see SPI_scroll_cursor_move for more functionality).Description DescriptionManual ChaptersPG18Description SPI_cursor_open_with_args sets up a cursor (internally, a portal) that will execute the specified query. Most of the parameters have the same meanings as the corresponding parame…Description DescriptionManual ChaptersPG18Description SPI_cursor_open_with_paramlist sets up a cursor (internally, a portal) that will execute a statement prepared by SPI_prepare. This function is equivalent to SPI_cursor_open excep…Description DescriptionManual ChaptersPG18Description SPI_cursor_open sets up a cursor (internally, a portal) that will execute a statement prepared by SPI_prepare. The parameters have the same meanings as the corresponding paramete…Description DescriptionManual ChaptersPG18Description SPI_cursor_parse_open sets up a cursor (internally, a portal) that will execute the specified query string. This is comparable to SPI_prepare_cursor followed by SPI_cursor_open_w…Description DescriptionManual ChaptersPG18Description SPI_exec is the same as SPI_execute, with the latter's read_only parameter always taken as false.Description DescriptionManual ChaptersPG18Description SPI_execp is the same as SPI_execute_plan, with the latter's read_only parameter always taken as false.Description DescriptionManual ChaptersPG18Description SPI_execute_extended executes a command that might include references to externally supplied parameters. The command text refers to a parameter as $n, and the options->params obj…Description DescriptionManual ChaptersPG18Description SPI_execute_plan_extended executes a statement prepared by SPI_prepare or one of its siblings. This function is equivalent to SPI_execute_plan, except that information about the …Description DescriptionManual ChaptersPG18Description SPI_execute_plan_with_paramlist executes a statement prepared by SPI_prepare. This function is equivalent to SPI_execute_plan except that information about the parameter values t…Description DescriptionManual ChaptersPG18Description SPI_execute_plan executes a statement prepared by SPI_prepare or one of its siblings. read_only and count have the same interpretation as in SPI_execute.Description DescriptionManual ChaptersPG18Description SPI_execute_with_args executes a command that might include references to externally supplied parameters. The command text refers to a parameter as $n, and the call specifies dat…Description DescriptionManual ChaptersPG18Description SPI_execute executes the specified SQL command for count rows. If read_only is true, the command must be read-only, and execution overhead is somewhat reduced. This function can …Description DescriptionManual ChaptersPG18Description SPI_finish closes an existing connection to the SPI manager. You must call this function after completing the SPI operations needed during your C function's current invocation. Y…Description DescriptionManual ChaptersPG18Description SPI_fname returns a copy of the column 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_fnumber returns the column number for the column with the specified name. If colname refers to a system column (e.g., ctid) then the appropriate negative column number will b…Description DescriptionManual ChaptersPG18Description SPI_freeplan releases a prepared statement previously returned by SPI_prepare or saved by SPI_keepplan or SPI_saveplan.Description DescriptionManual ChaptersPG18Description SPI_freetuple frees a row previously allocated in the upper executor context. This function is no longer different from plain heap_freetuple. It's kept just for backward compatib…Description DescriptionManual ChaptersPG18Description SPI_freetuptable frees a row set created by a prior SPI command execution function, such as SPI_execute. Therefore, this function is often called with the global variable SPI_tup…Description DescriptionManual ChaptersPG18Description SPI_getargcount returns the number of arguments needed to execute a statement prepared by SPI_prepare.Description DescriptionManual ChaptersPG18Description SPI_getargtypeid returns the OID representing the type for the argIndex'th argument of a statement prepared by SPI_prepare. First argument is at index zero.Description