org.postgresql.pljava.internal
Class Portal
java.lang.Object
org.postgresql.pljava.internal.Portal
public class Portal
extends java.lang.Object
The Portal
correspons to the internal PostgreSQL
Portal
type.
void | close() - Invalidates this structure and frees up memory using the
internal function
SPI_cursor_close
|
int | fetch(boolean forward, int count) - Performs an
SPI_cursor_fetch .
|
String | getName() - Returns the name of this Portal.
|
int | getPortalPos() - Returns the value of the
portalPos attribute.
|
TupleDesc | getTupleDesc() - Returns the TupleDesc that describes the row Tuples for this
Portal.
|
boolean | isAtEnd() - Returns the value of the
atEnd attribute.
|
boolean | isAtStart() - Returns the value of the
atStart attribute.
|
boolean | isPosOverflow() - Returns the value of the
posOverflow attribute.
|
boolean | isValid() - Checks if the portal is still active.
|
int | move(boolean forward, int count) - Performs an
SPI_cursor_move .
|
close
public void close()
Invalidates this structure and frees up memory using the
internal function SPI_cursor_close
fetch
public int fetch(boolean forward,
int count)
throws SQLException
Performs an SPI_cursor_fetch
.
forward
- Set to true
for forward, false
for backward.count
- Maximum number of rows to fetch.
- The actual number of fetched rows.
getName
public String getName()
throws SQLException
Returns the name of this Portal.
getPortalPos
public int getPortalPos()
throws SQLException
Returns the value of the portalPos
attribute.
getTupleDesc
public TupleDesc getTupleDesc()
throws SQLException
Returns the TupleDesc that describes the row Tuples for this
Portal.
isAtEnd
public boolean isAtEnd()
throws SQLException
Returns the value of the atEnd
attribute.
isAtStart
public boolean isAtStart()
throws SQLException
Returns the value of the atStart
attribute.
isPosOverflow
public boolean isPosOverflow()
throws SQLException
Returns the value of the posOverflow
attribute.
isValid
public boolean isValid()
Checks if the portal is still active. I can be closed either explicitly
using the
close()
mehtod or implicitly due to a pop of invocation
context.
move
public int move(boolean forward,
int count)
throws SQLException
Performs an SPI_cursor_move
.
forward
- Set to true
for forward, false
for backward.count
- Maximum number of rows to fetch.
- The value of the global variable
SPI_result
.
Copyright (c) 2003, 2004, 2005 TADA AB - Taby Sweden. \
Distributed under the terms shown in COPYRIGHT