← Back to branch summary

~ubuntu-branches/debian/sid/postgresql-9.3/sid

« back to all changes in this revision

Viewing changes to doc/src/sgml/man3/SPI_finish.3

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2013-05-08 05:39:52 UTC
  • Revision ID: package-import@ubuntu.com-20130508053952-1j7uilp7mjtrvq8q
Tags: upstream-9.3~beta1
Import upstream version 9.3~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/man3/SPI_finish.3
 
1
'\" t
 
2
.\"     Title: SPI_finish
 
3
.\"    Author: The PostgreSQL Global Development Group
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
 
5
.\"      Date: 2013-05-06
 
6
.\"    Manual: PostgreSQL 9.3beta1 Documentation
 
7
.\"    Source: PostgreSQL 9.3beta1
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "SPI_FINISH" "3" "2013-05-06" "PostgreSQL 9.3beta1" "PostgreSQL 9.3beta1 Documentation"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * Define some portability stuff
 
13
.\" -----------------------------------------------------------------
 
14
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
15
.\" http://bugs.debian.org/507673
 
16
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 
17
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
18
.ie \n(.g .ds Aq \(aq
 
19
.el       .ds Aq '
 
20
.\" -----------------------------------------------------------------
 
21
.\" * set default formatting
 
22
.\" -----------------------------------------------------------------
 
23
.\" disable hyphenation
 
24
.nh
 
25
.\" disable justification (adjust text to left margin only)
 
26
.ad l
 
27
.\" -----------------------------------------------------------------
 
28
.\" * MAIN CONTENT STARTS HERE *
 
29
.\" -----------------------------------------------------------------
 
30
.SH "NAME"
 
31
SPI_finish \- disconnect a procedure from the SPI manager
 
32
.\" SPI_finish
 
33
.SH "SYNOPSIS"
 
34
.sp
 
35
.nf
 
36
int SPI_finish(void)
 
37
.fi
 
38
.SH "DESCRIPTION"
 
39
.PP
 
40
 
 
41
\fBSPI_finish\fR
 
42
closes an existing connection to the SPI manager\&. You must call this function after completing the SPI operations needed during your procedure\*(Aqs current invocation\&. You do not need to worry about making this happen, however, if you abort the transaction via
 
43
elog(ERROR)\&. In that case SPI will clean itself up automatically\&.
 
44
.PP
 
45
If
 
46
\fBSPI_finish\fR
 
47
is called without having a valid connection, it will return
 
48
SPI_ERROR_UNCONNECTED\&. There is no fundamental problem with this; it means that the SPI manager has nothing to do\&.
 
49
.SH "RETURN VALUE"
 
50
.PP
 
51
SPI_OK_FINISH
 
52
.RS 4
 
53
if properly disconnected
 
54
.RE
 
55
.PP
 
56
SPI_ERROR_UNCONNECTED
 
57
.RS 4
 
58
if called from an unconnected procedure
 
59
.RE