diff options
Diffstat (limited to 'doc/src/sgml/spi.sgml')
| -rw-r--r-- | doc/src/sgml/spi.sgml | 176 |
1 files changed, 88 insertions, 88 deletions
diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml index 079a4571fb..d8af07e5d2 100644 --- a/doc/src/sgml/spi.sgml +++ b/doc/src/sgml/spi.sgml @@ -63,6 +63,8 @@ <title>Interface Functions</title> <refentry id="spi-spi-connect"> + <indexterm><primary>SPI_connect</primary></indexterm> + <refmeta> <refentrytitle>SPI_connect</refentrytitle> <manvolnum>3</manvolnum> @@ -73,8 +75,6 @@ <refpurpose>connect a procedure to the SPI manager</refpurpose> </refnamediv> - <indexterm><primary>SPI_connect</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_connect(void) @@ -135,6 +135,8 @@ int SPI_connect(void) <!-- *********************************************** --> <refentry id="spi-spi-finish"> + <indexterm><primary>SPI_finish</primary></indexterm> + <refmeta> <refentrytitle>SPI_finish</refentrytitle> <manvolnum>3</manvolnum> @@ -145,8 +147,6 @@ int SPI_connect(void) <refpurpose>disconnect a procedure from the SPI manager</refpurpose> </refnamediv> - <indexterm><primary>SPI_finish</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_finish(void) @@ -201,6 +201,8 @@ int SPI_finish(void) <!-- *********************************************** --> <refentry id="spi-spi-push"> + <indexterm><primary>SPI_push</primary></indexterm> + <refmeta> <refentrytitle>SPI_push</refentrytitle> <manvolnum>3</manvolnum> @@ -211,8 +213,6 @@ int SPI_finish(void) <refpurpose>push SPI stack to allow recursive SPI usage</refpurpose> </refnamediv> - <indexterm><primary>SPI_push</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_push(void) @@ -249,6 +249,8 @@ void SPI_push(void) <!-- *********************************************** --> <refentry id="spi-spi-pop"> + <indexterm><primary>SPI_pop</primary></indexterm> + <refmeta> <refentrytitle>SPI_pop</refentrytitle> <manvolnum>3</manvolnum> @@ -259,8 +261,6 @@ void SPI_push(void) <refpurpose>pop SPI stack to return from recursive SPI usage</refpurpose> </refnamediv> - <indexterm><primary>SPI_pop</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_pop(void) @@ -281,6 +281,8 @@ void SPI_pop(void) <!-- *********************************************** --> <refentry id="spi-spi-execute"> + <indexterm><primary>SPI_execute</primary></indexterm> + <refmeta> <refentrytitle>SPI_execute</refentrytitle> <manvolnum>3</manvolnum> @@ -291,8 +293,6 @@ void SPI_pop(void) <refpurpose>execute a command</refpurpose> </refnamediv> - <indexterm><primary>SPI_execute</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_execute(const char * <parameter>command</parameter>, bool <parameter>read_only</parameter>, long <parameter>count</parameter>) @@ -637,6 +637,8 @@ typedef struct <!-- *********************************************** --> <refentry id="spi-spi-exec"> + <indexterm><primary>SPI_exec</primary></indexterm> + <refmeta> <refentrytitle>SPI_exec</refentrytitle> <manvolnum>3</manvolnum> @@ -647,8 +649,6 @@ typedef struct <refpurpose>execute a read/write command</refpurpose> </refnamediv> - <indexterm><primary>SPI_exec</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_exec(const char * <parameter>command</parameter>, long <parameter>count</parameter>) @@ -703,6 +703,8 @@ int SPI_exec(const char * <parameter>command</parameter>, long <parameter>count< <!-- *********************************************** --> <refentry id="spi-spi-execute-with-args"> + <indexterm><primary>SPI_execute_with_args</primary></indexterm> + <refmeta> <refentrytitle>SPI_execute_with_args</refentrytitle> <manvolnum>3</manvolnum> @@ -713,8 +715,6 @@ int SPI_exec(const char * <parameter>command</parameter>, long <parameter>count< <refpurpose>execute a command with out-of-line parameters</refpurpose> </refnamediv> - <indexterm><primary>SPI_execute_with_args</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_execute_with_args(const char *<parameter>command</parameter>, @@ -856,6 +856,8 @@ int SPI_execute_with_args(const char *<parameter>command</parameter>, <!-- *********************************************** --> <refentry id="spi-spi-prepare"> + <indexterm><primary>SPI_prepare</primary></indexterm> + <refmeta> <refentrytitle>SPI_prepare</refentrytitle> <manvolnum>3</manvolnum> @@ -866,8 +868,6 @@ int SPI_execute_with_args(const char *<parameter>command</parameter>, <refpurpose>prepare a statement, without executing it yet</refpurpose> </refnamediv> - <indexterm><primary>SPI_prepare</primary></indexterm> - <refsynopsisdiv> <synopsis> SPIPlanPtr SPI_prepare(const char * <parameter>command</parameter>, int <parameter>nargs</parameter>, Oid * <parameter>argtypes</parameter>) @@ -1018,6 +1018,8 @@ SPIPlanPtr SPI_prepare(const char * <parameter>command</parameter>, int <paramet <!-- *********************************************** --> <refentry id="spi-spi-prepare-cursor"> + <indexterm><primary>SPI_prepare_cursor</primary></indexterm> + <refmeta> <refentrytitle>SPI_prepare_cursor</refentrytitle> <manvolnum>3</manvolnum> @@ -1028,8 +1030,6 @@ SPIPlanPtr SPI_prepare(const char * <parameter>command</parameter>, int <paramet <refpurpose>prepare a statement, without executing it yet</refpurpose> </refnamediv> - <indexterm><primary>SPI_prepare_cursor</primary></indexterm> - <refsynopsisdiv> <synopsis> SPIPlanPtr SPI_prepare_cursor(const char * <parameter>command</parameter>, int <parameter>nargs</parameter>, @@ -1120,6 +1120,8 @@ SPIPlanPtr SPI_prepare_cursor(const char * <parameter>command</parameter>, int < <!-- *********************************************** --> <refentry id="spi-spi-prepare-params"> + <indexterm><primary>SPI_prepare_params</primary></indexterm> + <refmeta> <refentrytitle>SPI_prepare_params</refentrytitle> <manvolnum>3</manvolnum> @@ -1130,8 +1132,6 @@ SPIPlanPtr SPI_prepare_cursor(const char * <parameter>command</parameter>, int < <refpurpose>prepare a statement, without executing it yet</refpurpose> </refnamediv> - <indexterm><primary>SPI_prepare_params</primary></indexterm> - <refsynopsisdiv> <synopsis> SPIPlanPtr SPI_prepare_params(const char * <parameter>command</parameter>, @@ -1208,6 +1208,8 @@ SPIPlanPtr SPI_prepare_params(const char * <parameter>command</parameter>, <!-- *********************************************** --> <refentry id="spi-spi-getargcount"> + <indexterm><primary>SPI_getargcount</primary></indexterm> + <refmeta> <refentrytitle>SPI_getargcount</refentrytitle> <manvolnum>3</manvolnum> @@ -1219,8 +1221,6 @@ SPIPlanPtr SPI_prepare_params(const char * <parameter>command</parameter>, prepared by <function>SPI_prepare</function></refpurpose> </refnamediv> - <indexterm><primary>SPI_getargcount</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_getargcount(SPIPlanPtr <parameter>plan</parameter>) @@ -1265,6 +1265,8 @@ int SPI_getargcount(SPIPlanPtr <parameter>plan</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-getargtypeid"> + <indexterm><primary>SPI_getargtypeid</primary></indexterm> + <refmeta> <refentrytitle>SPI_getargtypeid</refentrytitle> <manvolnum>3</manvolnum> @@ -1276,8 +1278,6 @@ int SPI_getargcount(SPIPlanPtr <parameter>plan</parameter>) a statement prepared by <function>SPI_prepare</function></refpurpose> </refnamediv> - <indexterm><primary>SPI_getargtypeid</primary></indexterm> - <refsynopsisdiv> <synopsis> Oid SPI_getargtypeid(SPIPlanPtr <parameter>plan</parameter>, int <parameter>argIndex</parameter>) @@ -1335,6 +1335,8 @@ Oid SPI_getargtypeid(SPIPlanPtr <parameter>plan</parameter>, int <parameter>argI <!-- *********************************************** --> <refentry id="spi-spi-is-cursor-plan"> + <indexterm><primary>SPI_is_cursor_plan</primary></indexterm> + <refmeta> <refentrytitle>SPI_is_cursor_plan</refentrytitle> <manvolnum>3</manvolnum> @@ -1347,8 +1349,6 @@ Oid SPI_getargtypeid(SPIPlanPtr <parameter>plan</parameter>, int <parameter>argI <function>SPI_cursor_open</function></refpurpose> </refnamediv> - <indexterm><primary>SPI_is_cursor_plan</primary></indexterm> - <refsynopsisdiv> <synopsis> bool SPI_is_cursor_plan(SPIPlanPtr <parameter>plan</parameter>) @@ -1404,6 +1404,8 @@ bool SPI_is_cursor_plan(SPIPlanPtr <parameter>plan</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-execute-plan"> + <indexterm><primary>SPI_execute_plan</primary></indexterm> + <refmeta> <refentrytitle>SPI_execute_plan</refentrytitle> <manvolnum>3</manvolnum> @@ -1414,8 +1416,6 @@ bool SPI_is_cursor_plan(SPIPlanPtr <parameter>plan</parameter>) <refpurpose>execute a statement prepared by <function>SPI_prepare</function></refpurpose> </refnamediv> - <indexterm><primary>SPI_execute_plan</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_execute_plan(SPIPlanPtr <parameter>plan</parameter>, Datum * <parameter>values</parameter>, const char * <parameter>nulls</parameter>, @@ -1540,6 +1540,8 @@ int SPI_execute_plan(SPIPlanPtr <parameter>plan</parameter>, Datum * <parameter> <!-- *********************************************** --> <refentry id="spi-spi-execute-plan-with-paramlist"> + <indexterm><primary>SPI_execute_plan_with_paramlist</primary></indexterm> + <refmeta> <refentrytitle>SPI_execute_plan_with_paramlist</refentrytitle> <manvolnum>3</manvolnum> @@ -1550,8 +1552,6 @@ int SPI_execute_plan(SPIPlanPtr <parameter>plan</parameter>, Datum * <parameter> <refpurpose>execute a statement prepared by <function>SPI_prepare</function></refpurpose> </refnamediv> - <indexterm><primary>SPI_execute_plan_with_paramlist</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_execute_plan_with_paramlist(SPIPlanPtr <parameter>plan</parameter>, @@ -1635,6 +1635,8 @@ int SPI_execute_plan_with_paramlist(SPIPlanPtr <parameter>plan</parameter>, <!-- *********************************************** --> <refentry id="spi-spi-execp"> + <indexterm><primary>SPI_execp</primary></indexterm> + <refmeta> <refentrytitle>SPI_execp</refentrytitle> <manvolnum>3</manvolnum> @@ -1645,8 +1647,6 @@ int SPI_execute_plan_with_paramlist(SPIPlanPtr <parameter>plan</parameter>, <refpurpose>execute a statement in read/write mode</refpurpose> </refnamediv> - <indexterm><primary>SPI_execp</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_execp(SPIPlanPtr <parameter>plan</parameter>, Datum * <parameter>values</parameter>, const char * <parameter>nulls</parameter>, long <parameter>count</parameter>) @@ -1739,6 +1739,8 @@ int SPI_execp(SPIPlanPtr <parameter>plan</parameter>, Datum * <parameter>values< <!-- *********************************************** --> <refentry id="spi-spi-cursor-open"> + <indexterm><primary>SPI_cursor_open</primary></indexterm> + <refmeta> <refentrytitle>SPI_cursor_open</refentrytitle> <manvolnum>3</manvolnum> @@ -1749,8 +1751,6 @@ int SPI_execp(SPIPlanPtr <parameter>plan</parameter>, Datum * <parameter>values< <refpurpose>set up a cursor using a statement created with <function>SPI_prepare</function></refpurpose> </refnamediv> - <indexterm><primary>SPI_cursor_open</primary></indexterm> - <refsynopsisdiv> <synopsis> Portal SPI_cursor_open(const char * <parameter>name</parameter>, SPIPlanPtr <parameter>plan</parameter>, @@ -1863,6 +1863,8 @@ Portal SPI_cursor_open(const char * <parameter>name</parameter>, SPIPlanPtr <par <!-- *********************************************** --> <refentry id="spi-spi-cursor-open-with-args"> + <indexterm><primary>SPI_cursor_open_with_args</primary></indexterm> + <refmeta> <refentrytitle>SPI_cursor_open_with_args</refentrytitle> <manvolnum>3</manvolnum> @@ -1873,8 +1875,6 @@ Portal SPI_cursor_open(const char * <parameter>name</parameter>, SPIPlanPtr <par <refpurpose>set up a cursor using a query and parameters</refpurpose> </refnamediv> - <indexterm><primary>SPI_cursor_open_with_args</primary></indexterm> - <refsynopsisdiv> <synopsis> Portal SPI_cursor_open_with_args(const char *<parameter>name</parameter>, @@ -2016,6 +2016,8 @@ Portal SPI_cursor_open_with_args(const char *<parameter>name</parameter>, <!-- *********************************************** --> <refentry id="spi-spi-cursor-open-with-paramlist"> + <indexterm><primary>SPI_cursor_open_with_paramlist</primary></indexterm> + <refmeta> <refentrytitle>SPI_cursor_open_with_paramlist</refentrytitle> <manvolnum>3</manvolnum> @@ -2026,8 +2028,6 @@ Portal SPI_cursor_open_with_args(const char *<parameter>name</parameter>, <refpurpose>set up a cursor using parameters</refpurpose> </refnamediv> - <indexterm><primary>SPI_cursor_open_with_paramlist</primary></indexterm> - <refsynopsisdiv> <synopsis> Portal SPI_cursor_open_with_paramlist(const char *<parameter>name</parameter>, @@ -2112,6 +2112,8 @@ Portal SPI_cursor_open_with_paramlist(const char *<parameter>name</parameter>, <!-- *********************************************** --> <refentry id="spi-spi-cursor-find"> + <indexterm><primary>SPI_cursor_find</primary></indexterm> + <refmeta> <refentrytitle>SPI_cursor_find</refentrytitle> <manvolnum>3</manvolnum> @@ -2122,8 +2124,6 @@ Portal SPI_cursor_open_with_paramlist(const char *<parameter>name</parameter>, <refpurpose>find an existing cursor by name</refpurpose> </refnamediv> - <indexterm><primary>SPI_cursor_find</primary></indexterm> - <refsynopsisdiv> <synopsis> Portal SPI_cursor_find(const char * <parameter>name</parameter>) @@ -2168,6 +2168,8 @@ Portal SPI_cursor_find(const char * <parameter>name</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-cursor-fetch"> + <indexterm><primary>SPI_cursor_fetch</primary></indexterm> + <refmeta> <refentrytitle>SPI_cursor_fetch</refentrytitle> <manvolnum>3</manvolnum> @@ -2178,8 +2180,6 @@ Portal SPI_cursor_find(const char * <parameter>name</parameter>) <refpurpose>fetch some rows from a cursor</refpurpose> </refnamediv> - <indexterm><primary>SPI_cursor_fetch</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_cursor_fetch(Portal <parameter>portal</parameter>, bool <parameter>forward</parameter>, long <parameter>count</parameter>) @@ -2253,6 +2253,8 @@ void SPI_cursor_fetch(Portal <parameter>portal</parameter>, bool <parameter>forw <!-- *********************************************** --> <refentry id="spi-spi-cursor-move"> + <indexterm><primary>SPI_cursor_move</primary></indexterm> + <refmeta> <refentrytitle>SPI_cursor_move</refentrytitle> <manvolnum>3</manvolnum> @@ -2263,8 +2265,6 @@ void SPI_cursor_fetch(Portal <parameter>portal</parameter>, bool <parameter>forw <refpurpose>move a cursor</refpurpose> </refnamediv> - <indexterm><primary>SPI_cursor_move</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_cursor_move(Portal <parameter>portal</parameter>, bool <parameter>forward</parameter>, long <parameter>count</parameter>) @@ -2328,6 +2328,8 @@ void SPI_cursor_move(Portal <parameter>portal</parameter>, bool <parameter>forwa <!-- *********************************************** --> <refentry id="spi-spi-scroll-cursor-fetch"> + <indexterm><primary>SPI_scroll_cursor_fetch</primary></indexterm> + <refmeta> <refentrytitle>SPI_scroll_cursor_fetch</refentrytitle> <manvolnum>3</manvolnum> @@ -2338,8 +2340,6 @@ void SPI_cursor_move(Portal <parameter>portal</parameter>, bool <parameter>forwa <refpurpose>fetch some rows from a cursor</refpurpose> </refnamediv> - <indexterm><primary>SPI_scroll_cursor_fetch</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_scroll_cursor_fetch(Portal <parameter>portal</parameter>, FetchDirection <parameter>direction</parameter>, @@ -2427,6 +2427,8 @@ void SPI_scroll_cursor_fetch(Portal <parameter>portal</parameter>, FetchDirectio <!-- *********************************************** --> <refentry id="spi-spi-scroll-cursor-move"> + <indexterm><primary>SPI_scroll_cursor_move</primary></indexterm> + <refmeta> <refentrytitle>SPI_scroll_cursor_move</refentrytitle> <manvolnum>3</manvolnum> @@ -2437,8 +2439,6 @@ void SPI_scroll_cursor_fetch(Portal <parameter>portal</parameter>, FetchDirectio <refpurpose>move a cursor</refpurpose> </refnamediv> - <indexterm><primary>SPI_scroll_cursor_move</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_scroll_cursor_move(Portal <parameter>portal</parameter>, FetchDirection <parameter>direction</parameter>, @@ -2528,6 +2528,8 @@ void SPI_scroll_cursor_move(Portal <parameter>portal</parameter>, FetchDirection <!-- *********************************************** --> <refentry id="spi-spi-cursor-close"> + <indexterm><primary>SPI_cursor_close</primary></indexterm> + <refmeta> <refentrytitle>SPI_cursor_close</refentrytitle> <manvolnum>3</manvolnum> @@ -2538,8 +2540,6 @@ void SPI_scroll_cursor_move(Portal <parameter>portal</parameter>, FetchDirection <refpurpose>close a cursor</refpurpose> </refnamediv> - <indexterm><primary>SPI_cursor_close</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_cursor_close(Portal <parameter>portal</parameter>) @@ -2580,6 +2580,8 @@ void SPI_cursor_close(Portal <parameter>portal</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-keepplan"> + <indexterm><primary>SPI_keepplan</primary></indexterm> + <refmeta> <refentrytitle>SPI_keepplan</refentrytitle> <manvolnum>3</manvolnum> @@ -2590,8 +2592,6 @@ void SPI_cursor_close(Portal <parameter>portal</parameter>) <refpurpose>save a prepared statement</refpurpose> </refnamediv> - <indexterm><primary>SPI_keepplan</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_keepplan(SPIPlanPtr <parameter>plan</parameter>) @@ -2649,6 +2649,8 @@ int SPI_keepplan(SPIPlanPtr <parameter>plan</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-saveplan"> + <indexterm><primary>SPI_saveplan</primary></indexterm> + <refmeta> <refentrytitle>SPI_saveplan</refentrytitle> <manvolnum>3</manvolnum> @@ -2659,8 +2661,6 @@ int SPI_keepplan(SPIPlanPtr <parameter>plan</parameter>) <refpurpose>save a prepared statement</refpurpose> </refnamediv> - <indexterm><primary>SPI_saveplan</primary></indexterm> - <refsynopsisdiv> <synopsis> SPIPlanPtr SPI_saveplan(SPIPlanPtr <parameter>plan</parameter>) @@ -2760,6 +2760,8 @@ SPIPlanPtr SPI_saveplan(SPIPlanPtr <parameter>plan</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-fname"> + <indexterm><primary>SPI_fname</primary></indexterm> + <refmeta> <refentrytitle>SPI_fname</refentrytitle> <manvolnum>3</manvolnum> @@ -2770,8 +2772,6 @@ SPIPlanPtr SPI_saveplan(SPIPlanPtr <parameter>plan</parameter>) <refpurpose>determine the column name for the specified column number</refpurpose> </refnamediv> - <indexterm><primary>SPI_fname</primary></indexterm> - <refsynopsisdiv> <synopsis> char * SPI_fname(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>) @@ -2827,6 +2827,8 @@ char * SPI_fname(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnum <!-- *********************************************** --> <refentry id="spi-spi-fnumber"> + <indexterm><primary>SPI_fnumber</primary></indexterm> + <refmeta> <refentrytitle>SPI_fnumber</refentrytitle> <manvolnum>3</manvolnum> @@ -2837,8 +2839,6 @@ char * SPI_fname(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnum <refpurpose>determine the column number for the specified column name</refpurpose> </refnamediv> - <indexterm><primary>SPI_fnumber</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_fnumber(TupleDesc <parameter>rowdesc</parameter>, const char * <parameter>colname</parameter>) @@ -2901,6 +2901,8 @@ int SPI_fnumber(TupleDesc <parameter>rowdesc</parameter>, const char * <paramete <!-- *********************************************** --> <refentry id="spi-spi-getvalue"> + <indexterm><primary>SPI_getvalue</primary></indexterm> + <refmeta> <refentrytitle>SPI_getvalue</refentrytitle> <manvolnum>3</manvolnum> @@ -2911,8 +2913,6 @@ int SPI_fnumber(TupleDesc <parameter>rowdesc</parameter>, const char * <paramete <refpurpose>return the string value of the specified column</refpurpose> </refnamediv> - <indexterm><primary>SPI_getvalue</primary></indexterm> - <refsynopsisdiv> <synopsis> char * SPI_getvalue(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>) @@ -2985,6 +2985,8 @@ char * SPI_getvalue(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>r <!-- *********************************************** --> <refentry id="spi-spi-getbinval"> + <indexterm><primary>SPI_getbinval</primary></indexterm> + <refmeta> <refentrytitle>SPI_getbinval</refentrytitle> <manvolnum>3</manvolnum> @@ -2995,8 +2997,6 @@ char * SPI_getvalue(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>r <refpurpose>return the binary value of the specified column</refpurpose> </refnamediv> - <indexterm><primary>SPI_getbinval</primary></indexterm> - <refsynopsisdiv> <synopsis> Datum SPI_getbinval(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>, @@ -3080,6 +3080,8 @@ Datum SPI_getbinval(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>r <!-- *********************************************** --> <refentry id="spi-spi-gettype"> + <indexterm><primary>SPI_gettype</primary></indexterm> + <refmeta> <refentrytitle>SPI_gettype</refentrytitle> <manvolnum>3</manvolnum> @@ -3090,8 +3092,6 @@ Datum SPI_getbinval(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>r <refpurpose>return the data type name of the specified column</refpurpose> </refnamediv> - <indexterm><primary>SPI_gettype</primary></indexterm> - <refsynopsisdiv> <synopsis> char * SPI_gettype(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>) @@ -3146,6 +3146,8 @@ char * SPI_gettype(TupleDesc <parameter>rowdesc</parameter>, int <parameter>coln <!-- *********************************************** --> <refentry id="spi-spi-gettypeid"> + <indexterm><primary>SPI_gettypeid</primary></indexterm> + <refmeta> <refentrytitle>SPI_gettypeid</refentrytitle> <manvolnum>3</manvolnum> @@ -3156,8 +3158,6 @@ char * SPI_gettype(TupleDesc <parameter>rowdesc</parameter>, int <parameter>coln <refpurpose>return the data type <acronym>OID</acronym> of the specified column</refpurpose> </refnamediv> - <indexterm><primary>SPI_gettypeid</primary></indexterm> - <refsynopsisdiv> <synopsis> Oid SPI_gettypeid(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>) @@ -3212,6 +3212,8 @@ Oid SPI_gettypeid(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnu <!-- *********************************************** --> <refentry id="spi-spi-getrelname"> + <indexterm><primary>SPI_getrelname</primary></indexterm> + <refmeta> <refentrytitle>SPI_getrelname</refentrytitle> <manvolnum>3</manvolnum> @@ -3222,8 +3224,6 @@ Oid SPI_gettypeid(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnu <refpurpose>return the name of the specified relation</refpurpose> </refnamediv> - <indexterm><primary>SPI_getrelname</primary></indexterm> - <refsynopsisdiv> <synopsis> char * SPI_getrelname(Relation <parameter>rel</parameter>) @@ -3265,6 +3265,8 @@ char * SPI_getrelname(Relation <parameter>rel</parameter>) </refentry> <refentry id="spi-spi-getnspname"> + <indexterm><primary>SPI_getnspname</primary></indexterm> + <refmeta> <refentrytitle>SPI_getnspname</refentrytitle> <manvolnum>3</manvolnum> @@ -3275,8 +3277,6 @@ char * SPI_getrelname(Relation <parameter>rel</parameter>) <refpurpose>return the namespace of the specified relation</refpurpose> </refnamediv> - <indexterm><primary>SPI_getnspname</primary></indexterm> - <refsynopsisdiv> <synopsis> char * SPI_getnspname(Relation <parameter>rel</parameter>) @@ -3400,6 +3400,8 @@ char * SPI_getnspname(Relation <parameter>rel</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-palloc"> + <indexterm><primary>SPI_palloc</primary></indexterm> + <refmeta> <refentrytitle>SPI_palloc</refentrytitle> <manvolnum>3</manvolnum> @@ -3410,8 +3412,6 @@ char * SPI_getnspname(Relation <parameter>rel</parameter>) <refpurpose>allocate memory in the upper executor context</refpurpose> </refnamediv> - <indexterm><primary>SPI_palloc</primary></indexterm> - <refsynopsisdiv> <synopsis> void * SPI_palloc(Size <parameter>size</parameter>) @@ -3454,6 +3454,8 @@ void * SPI_palloc(Size <parameter>size</parameter>) <!-- *********************************************** --> <refentry id="spi-realloc"> + <indexterm><primary>SPI_repalloc</primary></indexterm> + <refmeta> <refentrytitle>SPI_repalloc</refentrytitle> <manvolnum>3</manvolnum> @@ -3464,8 +3466,6 @@ void * SPI_palloc(Size <parameter>size</parameter>) <refpurpose>reallocate memory in the upper executor context</refpurpose> </refnamediv> - <indexterm><primary>SPI_repalloc</primary></indexterm> - <refsynopsisdiv> <synopsis> void * SPI_repalloc(void * <parameter>pointer</parameter>, Size <parameter>size</parameter>) @@ -3524,6 +3524,8 @@ void * SPI_repalloc(void * <parameter>pointer</parameter>, Size <parameter>size< <!-- *********************************************** --> <refentry id="spi-spi-pfree"> + <indexterm><primary>SPI_pfree</primary></indexterm> + <refmeta> <refentrytitle>SPI_pfree</refentrytitle> <manvolnum>3</manvolnum> @@ -3534,8 +3536,6 @@ void * SPI_repalloc(void * <parameter>pointer</parameter>, Size <parameter>size< <refpurpose>free memory in the upper executor context</refpurpose> </refnamediv> - <indexterm><primary>SPI_pfree</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_pfree(void * <parameter>pointer</parameter>) @@ -3577,6 +3577,8 @@ void SPI_pfree(void * <parameter>pointer</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-copytuple"> + <indexterm><primary>SPI_copytuple</primary></indexterm> + <refmeta> <refentrytitle>SPI_copytuple</refentrytitle> <manvolnum>3</manvolnum> @@ -3587,8 +3589,6 @@ void SPI_pfree(void * <parameter>pointer</parameter>) <refpurpose>make a copy of a row in the upper executor context</refpurpose> </refnamediv> - <indexterm><primary>SPI_copytuple</primary></indexterm> - <refsynopsisdiv> <synopsis> HeapTuple SPI_copytuple(HeapTuple <parameter>row</parameter>) @@ -3634,6 +3634,8 @@ HeapTuple SPI_copytuple(HeapTuple <parameter>row</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-returntuple"> + <indexterm><primary>SPI_returntuple</primary></indexterm> + <refmeta> <refentrytitle>SPI_returntuple</refentrytitle> <manvolnum>3</manvolnum> @@ -3644,8 +3646,6 @@ HeapTuple SPI_copytuple(HeapTuple <parameter>row</parameter>) <refpurpose>prepare to return a tuple as a Datum</refpurpose> </refnamediv> - <indexterm><primary>SPI_returntuple</primary></indexterm> - <refsynopsisdiv> <synopsis> HeapTupleHeader SPI_returntuple(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>rowdesc</parameter>) @@ -3709,6 +3709,8 @@ HeapTupleHeader SPI_returntuple(HeapTuple <parameter>row</parameter>, TupleDesc <!-- *********************************************** --> <refentry id="spi-spi-modifytuple"> + <indexterm><primary>SPI_modifytuple</primary></indexterm> + <refmeta> <refentrytitle>SPI_modifytuple</refentrytitle> <manvolnum>3</manvolnum> @@ -3719,8 +3721,6 @@ HeapTupleHeader SPI_returntuple(HeapTuple <parameter>row</parameter>, TupleDesc <refpurpose>create a row by replacing selected fields of a given row</refpurpose> </refnamediv> - <indexterm><primary>SPI_modifytuple</primary></indexterm> - <refsynopsisdiv> <synopsis> HeapTuple SPI_modifytuple(Relation <parameter>rel</parameter>, HeapTuple <parameter>row</parameter>, int <parameter>ncols</parameter>, @@ -3857,6 +3857,8 @@ HeapTuple SPI_modifytuple(Relation <parameter>rel</parameter>, HeapTuple <parame <!-- *********************************************** --> <refentry id="spi-spi-freetuple"> + <indexterm><primary>SPI_freetuple</primary></indexterm> + <refmeta> <refentrytitle>SPI_freetuple</refentrytitle> <manvolnum>3</manvolnum> @@ -3867,8 +3869,6 @@ HeapTuple SPI_modifytuple(Relation <parameter>rel</parameter>, HeapTuple <parame <refpurpose>free a row allocated in the upper executor context</refpurpose> </refnamediv> - <indexterm><primary>SPI_freetuple</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_freetuple(HeapTuple <parameter>row</parameter>) @@ -3909,6 +3909,8 @@ void SPI_freetuple(HeapTuple <parameter>row</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-freetupletable"> + <indexterm><primary>SPI_freetuptable</primary></indexterm> + <refmeta> <refentrytitle>SPI_freetuptable</refentrytitle> <manvolnum>3</manvolnum> @@ -3920,8 +3922,6 @@ void SPI_freetuple(HeapTuple <parameter>row</parameter>) function</refpurpose> </refnamediv> - <indexterm><primary>SPI_freetuptable</primary></indexterm> - <refsynopsisdiv> <synopsis> void SPI_freetuptable(SPITupleTable * <parameter>tuptable</parameter>) @@ -3976,6 +3976,8 @@ void SPI_freetuptable(SPITupleTable * <parameter>tuptable</parameter>) <!-- *********************************************** --> <refentry id="spi-spi-freeplan"> + <indexterm><primary>SPI_freeplan</primary></indexterm> + <refmeta> <refentrytitle>SPI_freeplan</refentrytitle> <manvolnum>3</manvolnum> @@ -3986,8 +3988,6 @@ void SPI_freetuptable(SPITupleTable * <parameter>tuptable</parameter>) <refpurpose>free a previously saved prepared statement</refpurpose> </refnamediv> - <indexterm><primary>SPI_freeplan</primary></indexterm> - <refsynopsisdiv> <synopsis> int SPI_freeplan(SPIPlanPtr <parameter>plan</parameter>) |