| Server IP : 103.119.228.120 / Your IP : 3.137.169.14 Web Server : Apache System : Linux v8.techscape8.com 3.10.0-1160.119.1.el7.tuxcare.els2.x86_64 #1 SMP Mon Jul 15 12:09:18 UTC 2024 x86_64 User : nobody ( 99) PHP Version : 5.6.40 Disable Function : shell_exec,symlink,system,exec,proc_get_status,proc_nice,proc_terminate,define_syslog_variables,syslog,openlog,closelog,escapeshellcmd,passthru,ocinum cols,ini_alter,leak,listen,chgrp,apache_note,apache_setenv,debugger_on,debugger_off,ftp_exec,dl,dll,myshellexec,proc_open,socket_bind,proc_close,escapeshellarg,parse_ini_filepopen,fpassthru,exec,passthru,escapeshellarg,escapeshellcmd,proc_close,proc_open,ini_alter,popen,show_source,proc_nice,proc_terminate,proc_get_status,proc_close,pfsockopen,leak,apache_child_terminate,posix_kill,posix_mkfifo,posix_setpgid,posix_setsid,posix_setuid,dl,symlink,shell_exec,system,dl,passthru,escapeshellarg,escapeshellcmd,myshellexec,c99_buff_prepare,c99_sess_put,fpassthru,getdisfunc,fx29exec,fx29exec2,is_windows,disp_freespace,fx29sh_getupdate,fx29_buff_prepare,fx29_sess_put,fx29shexit,fx29fsearch,fx29ftpbrutecheck,fx29sh_tools,fx29sh_about,milw0rm,imagez,sh_name,myshellexec,checkproxyhost,dosyayicek,c99_buff_prepare,c99_sess_put,c99getsource,c99sh_getupdate,c99fsearch,c99shexit,view_perms,posix_getpwuid,posix_getgrgid,posix_kill,parse_perms,parsesort,view_perms_color,set_encoder_input,ls_setcheckboxall,ls_reverse_all,rsg_read,rsg_glob,selfURL,dispsecinfo,unix2DosTime,addFile,system,get_users,view_size,DirFiles,DirFilesWide,DirPrintHTMLHeaders,GetFilesTotal,GetTitles,GetTimeTotal,GetMatchesCount,GetFileMatchesCount,GetResultFiles,fs_copy_dir,fs_copy_obj,fs_move_dir,fs_move_obj,fs_rmdir,SearchText,getmicrotime MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/postgresql-9.2.24/html/ |
Upload File : |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_cursor_open</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.2.24 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Interface Functions"
HREF="spi-interface.html"><LINK
REL="PREVIOUS"
TITLE="SPI_execp"
HREF="spi-spi-execp.html"><LINK
REL="NEXT"
TITLE="SPI_cursor_open_with_args"
HREF="spi-spi-cursor-open-with-args.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2017-11-06T22:43:11"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.2.24 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="SPI_execp"
HREF="spi-spi-execp.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="SPI_cursor_open_with_args"
HREF="spi-spi-cursor-open-with-args.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-CURSOR-OPEN"
></A
>SPI_cursor_open</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN61014"
></A
><H2
>Name</H2
>SPI_cursor_open -- set up a cursor using a statement created with <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
></DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN61020"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>Portal SPI_cursor_open(const char * <TT
CLASS="PARAMETER"
>name</TT
>, SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
>,
Datum * <TT
CLASS="PARAMETER"
>values</TT
>, const char * <TT
CLASS="PARAMETER"
>nulls</TT
>,
bool <TT
CLASS="PARAMETER"
>read_only</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61027"
></A
><H2
>Description</H2
><P
> <CODE
CLASS="FUNCTION"
>SPI_cursor_open</CODE
> sets up a cursor (internally,
a portal) that will execute a statement prepared by
<CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>. The parameters have the same
meanings as the corresponding parameters to
<CODE
CLASS="FUNCTION"
>SPI_execute_plan</CODE
>.
</P
><P
> Using a cursor instead of executing the statement directly has two
benefits. First, the result rows can be retrieved a few at a time,
avoiding memory overrun for queries that return many rows. Second,
a portal can outlive the current procedure (it can, in fact, live
to the end of the current transaction). Returning the portal name
to the procedure's caller provides a way of returning a row set as
result.
</P
><P
> The passed-in parameter data will be copied into the cursor's portal, so it
can be freed while the cursor still exists.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61035"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>const char * <TT
CLASS="PARAMETER"
>name</TT
></TT
></DT
><DD
><P
> name for portal, or <TT
CLASS="SYMBOL"
>NULL</TT
> to let the system
select a name
</P
></DD
><DT
><TT
CLASS="LITERAL"
>SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
></TT
></DT
><DD
><P
> prepared statement (returned by <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>)
</P
></DD
><DT
><TT
CLASS="LITERAL"
>Datum * <TT
CLASS="PARAMETER"
>values</TT
></TT
></DT
><DD
><P
> An array of actual parameter values. Must have same length as the
statement's number of arguments.
</P
></DD
><DT
><TT
CLASS="LITERAL"
>const char * <TT
CLASS="PARAMETER"
>nulls</TT
></TT
></DT
><DD
><P
> An array describing which parameters are null. Must have same length as
the statement's number of arguments.
<TT
CLASS="LITERAL"
>n</TT
> indicates a null value (entry in
<TT
CLASS="PARAMETER"
>values</TT
> will be ignored); a space indicates a
nonnull value (entry in <TT
CLASS="PARAMETER"
>values</TT
> is valid).
</P
><P
> If <TT
CLASS="PARAMETER"
>nulls</TT
> is <TT
CLASS="SYMBOL"
>NULL</TT
> then
<CODE
CLASS="FUNCTION"
>SPI_cursor_open</CODE
> assumes that no parameters are
null.
</P
></DD
><DT
><TT
CLASS="LITERAL"
>bool <TT
CLASS="PARAMETER"
>read_only</TT
></TT
></DT
><DD
><P
><TT
CLASS="LITERAL"
>true</TT
> for read-only execution</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61078"
></A
><H2
>Return Value</H2
><P
> Pointer to portal containing the cursor. Note there is no error
return convention; any error will be reported via <CODE
CLASS="FUNCTION"
>elog</CODE
>.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-spi-execp.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="spi-spi-cursor-open-with-args.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_execp</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SPI_cursor_open_with_args</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>