D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
proc
/
self
/
root
/
opt
/
alt
/
postgresql11
/
usr
/
share
/
man
/
man3
/
Filename :
SPI_cursor_open_with_args.3
back
Copy
'\" t .\" Title: SPI_cursor_open_with_args .\" Author: The PostgreSQL Global Development Group .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> .\" Date: 2017-11-06 .\" Manual: PostgreSQL 9.2.24 Documentation .\" Source: PostgreSQL 9.2.24 .\" Language: English .\" .TH "SPI_CURSOR_OPEN_WITH_ARGS" "3" "2017-11-06" "PostgreSQL 9.2.24" "PostgreSQL 9.2.24 Documentation" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" SPI_cursor_open_with_args \- set up a cursor using a query and parameters .\" SPI_cursor_open_with_args .SH "SYNOPSIS" .sp .nf Portal SPI_cursor_open_with_args(const char *\fIname\fR, const char *\fIcommand\fR, int \fInargs\fR, Oid *\fIargtypes\fR, Datum *\fIvalues\fR, const char *\fInulls\fR, bool \fIread_only\fR, int \fIcursorOptions\fR) .fi .SH "DESCRIPTION" .PP \fBSPI_cursor_open_with_args\fR sets up a cursor (internally, a portal) that will execute the specified query\&. Most of the parameters have the same meanings as the corresponding parameters to \fBSPI_prepare_cursor\fR and \fBSPI_cursor_open\fR\&. .PP For one\-time query execution, this function should be preferred over \fBSPI_prepare_cursor\fR followed by \fBSPI_cursor_open\fR\&. If the same command is to be executed with many different parameters, either method might be faster, depending on the cost of re\-planning versus the benefit of custom plans\&. .PP The passed\-in parameter data will be copied into the cursor\*(Aqs portal, so it can be freed while the cursor still exists\&. .SH "ARGUMENTS" .PP const char * \fIname\fR .RS 4 name for portal, or NULL to let the system select a name .RE .PP const char * \fIcommand\fR .RS 4 command string .RE .PP int \fInargs\fR .RS 4 number of input parameters ($1, $2, etc\&.) .RE .PP Oid * \fIargtypes\fR .RS 4 an array containing the OIDs of the data types of the parameters .RE .PP Datum * \fIvalues\fR .RS 4 an array of actual parameter values .RE .PP const char * \fInulls\fR .RS 4 an array describing which parameters are null .sp If \fInulls\fR is NULL then \fBSPI_cursor_open_with_args\fR assumes that no parameters are null\&. .RE .PP bool \fIread_only\fR .RS 4 true for read\-only execution .RE .PP int \fIcursorOptions\fR .RS 4 integer bit mask of cursor options; zero produces default behavior .RE .SH "RETURN VALUE" .PP Pointer to portal containing the cursor\&. Note there is no error return convention; any error will be reported via \fBelog\fR\&.