PortalData Struct Reference

#include <portal.h>

Data Fields
const char *	name
const char *	prepStmtName
MemoryContext	portalContext
ResourceOwner	resowner
void(*	cleanup )(Portal portal)
SubTransactionId	createSubid
SubTransactionId	activeSubid
int	createLevel
const char *	sourceText
CommandTag	commandTag
QueryCompletion	qc
List *	stmts
CachedPlan *	cplan
ParamListInfo	portalParams
QueryEnvironment *	queryEnv
PortalStrategy	strategy
int	cursorOptions
PortalStatus	status
bool	portalPinned
bool	autoHeld
QueryDesc *	queryDesc
TupleDesc	tupDesc
int16 *	formats
Snapshot	portalSnapshot
Tuplestorestate *	holdStore
MemoryContext	holdContext
Snapshot	holdSnapshot
bool	atStart
bool	atEnd
uint64	portalPos
TimestampTz	creation_time
bool	visible

Detailed Description

Definition at line 115 of file portal.h.

Field Documentation

activeSubid

SubTransactionId PortalData::activeSubid

Definition at line 132 of file portal.h.

Referenced by AtSubAbort_Portals(), AtSubCommit_Portals(), CreatePortal(), HoldPortal(), and MarkPortalActive().

atEnd

bool PortalData::atEnd

Definition at line 199 of file portal.h.

Referenced by CreatePortal(), DoPortalRewind(), DoPortalRunFetch(), execCurrentOf(), PersistHoldablePortal(), PortalRun(), PortalRunSelect(), and PortalStart().

atStart

bool PortalData::atStart

Definition at line 198 of file portal.h.

Referenced by CreatePortal(), DoPortalRewind(), DoPortalRunFetch(), exec_execute_message(), execCurrentOf(), PortalRunSelect(), and PortalStart().

autoHeld

bool PortalData::autoHeld

Definition at line 152 of file portal.h.

Referenced by AtAbort_Portals(), AtCleanup_Portals(), HoldPinnedPortals(), PortalErrorCleanup(), and PreCommit_Portals().

cleanup

void(* PortalData::cleanup) (Portal portal)

Definition at line 122 of file portal.h.

Referenced by AtAbort_Portals(), AtCleanup_Portals(), AtSubAbort_Portals(), AtSubCleanup_Portals(), CreatePortal(), MarkPortalDone(), MarkPortalFailed(), PortalCleanup(), and PortalDrop().

commandTag

CommandTag PortalData::commandTag

Definition at line 137 of file portal.h.

Referenced by exec_bind_message(), exec_execute_message(), and PortalDefineQuery().

cplan

CachedPlan* PortalData::cplan

Definition at line 140 of file portal.h.

Referenced by PortalDefineQuery(), PortalReleaseCachedPlan(), and PortalRunUtility().

createLevel

int PortalData::createLevel

Definition at line 133 of file portal.h.

Referenced by AtSubCommit_Portals(), CreatePortal(), EnsurePortalSnapshotExists(), HoldPortal(), and PortalRunUtility().

createSubid

SubTransactionId PortalData::createSubid

Definition at line 131 of file portal.h.

Referenced by AtAbort_Portals(), AtCleanup_Portals(), AtSubAbort_Portals(), AtSubCleanup_Portals(), AtSubCommit_Portals(), CreatePortal(), HoldPortal(), PersistHoldablePortal(), and PreCommit_Portals().

creation_time

TimestampTz PortalData::creation_time

Definition at line 203 of file portal.h.

Referenced by CreatePortal(), and pg_cursor().

cursorOptions

int PortalData::cursorOptions

Definition at line 147 of file portal.h.

Referenced by CreatePortal(), DoPortalRewind(), PerformCursorOpen(), PersistHoldablePortal(), pg_cursor(), PortalCreateHoldStore(), PortalRunSelect(), PortalStart(), PreCommit_Portals(), and SPI_cursor_open_internal().

formats

int16* PortalData::formats

Definition at line 161 of file portal.h.

Referenced by exec_describe_portal_message(), PortalSetResultFormat(), and printtup_startup().

holdContext

MemoryContext PortalData::holdContext

Definition at line 177 of file portal.h.

Referenced by DoPortalRewind(), FillPortalStore(), PersistHoldablePortal(), PortalCreateHoldStore(), PortalDrop(), and RunFromStore().

holdSnapshot

Snapshot PortalData::holdSnapshot

Definition at line 187 of file portal.h.

Referenced by PersistHoldablePortal(), PortalCreateHoldStore(), PortalDrop(), PortalRunMulti(), PortalRunUtility(), and PreCommit_Portals().

holdStore

Tuplestorestate* PortalData::holdStore

Definition at line 176 of file portal.h.

Referenced by DoPortalRewind(), FillPortalStore(), PersistHoldablePortal(), PortalCreateHoldStore(), PortalDrop(), PortalRun(), PortalRunFetch(), PortalRunSelect(), and RunFromStore().

name

const char* PortalData::name

Definition at line 118 of file portal.h.

Referenced by AtCleanup_Portals(), AtSubCleanup_Portals(), CreatePortal(), exec_bind_message(), exec_execute_message(), exec_stmt_forc(), exec_stmt_open(), MarkPortalActive(), pg_cursor(), plperl_spi_query(), plperl_spi_query_prepared(), PLy_cursor_plan(), PLy_cursor_query(), and PortalDrop().

portalContext

MemoryContext PortalData::portalContext

Definition at line 120 of file portal.h.

Referenced by AtAbort_Portals(), AtSubAbort_Portals(), CreatePortal(), exec_bind_message(), ExecuteQuery(), PerformCursorOpen(), PersistHoldablePortal(), PortalDrop(), PortalRun(), PortalRunFetch(), PortalRunMulti(), PortalRunUtility(), PortalSetResultFormat(), PortalStart(), and SPI_cursor_open_internal().

portalParams

ParamListInfo PortalData::portalParams

Definition at line 142 of file portal.h.

Referenced by exec_execute_message(), PortalRunMulti(), PortalRunUtility(), and PortalStart().

portalPinned

bool PortalData::portalPinned

Definition at line 151 of file portal.h.

Referenced by AtCleanup_Portals(), AtSubCleanup_Portals(), HoldPinnedPortals(), PinPortal(), PortalDrop(), PortalErrorCleanup(), PreCommit_Portals(), and UnpinPortal().

portalPos

uint64 PortalData::portalPos

Definition at line 200 of file portal.h.

Referenced by DoPortalRewind(), DoPortalRunFetch(), PersistHoldablePortal(), PortalRunSelect(), and PortalStart().

portalSnapshot

Snapshot PortalData::portalSnapshot

Definition at line 169 of file portal.h.

Referenced by EnsurePortalSnapshotExists(), ForgetPortalSnapshots(), PortalDrop(), PortalRunUtility(), and PreCommit_Portals().

prepStmtName

const char* PortalData::prepStmtName

Definition at line 119 of file portal.h.

Referenced by exec_execute_message(), and PortalDefineQuery().

qc

QueryCompletion PortalData::qc

Definition at line 138 of file portal.h.

Referenced by FillPortalStore(), PortalDefineQuery(), PortalRun(), and PortalRunMulti().

queryDesc

QueryDesc* PortalData::queryDesc

Definition at line 156 of file portal.h.

Referenced by DoPortalRewind(), execCurrentOf(), PersistHoldablePortal(), PortalCleanup(), PortalRunSelect(), and PortalStart().

queryEnv

QueryEnvironment* PortalData::queryEnv

Definition at line 143 of file portal.h.

Referenced by PortalRunMulti(), PortalRunUtility(), PortalStart(), and SPI_cursor_open_internal().

resowner

ResourceOwner PortalData::resowner

Definition at line 121 of file portal.h.

Referenced by AtAbort_Portals(), AtCleanup_Portals(), AtSubAbort_Portals(), AtSubCommit_Portals(), CreatePortal(), HoldPortal(), PersistHoldablePortal(), PortalCleanup(), PortalDrop(), PortalRun(), PortalRunFetch(), PortalStart(), and PreCommit_Portals().

sourceText

const char* PortalData::sourceText

Definition at line 136 of file portal.h.

Referenced by exec_execute_message(), function_parse_error_transpose(), pg_cursor(), PortalDefineQuery(), PortalRunMulti(), PortalRunUtility(), and PortalStart().

status

PortalStatus PortalData::status

Definition at line 150 of file portal.h.

Referenced by AtAbort_Portals(), AtCleanup_Portals(), AtSubAbort_Portals(), CreatePortal(), function_parse_error_transpose(), HoldPinnedPortals(), MarkPortalActive(), MarkPortalDone(), MarkPortalFailed(), PersistHoldablePortal(), PortalCleanup(), PortalDefineQuery(), PortalDrop(), PortalHashTableDeleteAll(), PortalRun(), PortalRunFetch(), PortalStart(), PreCommit_Portals(), and ThereAreNoReadyPortals().

stmts

List* PortalData::stmts

Definition at line 139 of file portal.h.

Referenced by exec_bind_message(), exec_execute_message(), FillPortalStore(), PortalDefineQuery(), PortalGetPrimaryStmt(), PortalReleaseCachedPlan(), PortalRunMulti(), and PortalStart().

strategy

PortalStrategy PortalData::strategy

Definition at line 146 of file portal.h.

Referenced by CreatePortal(), DoPortalRunFetch(), execCurrentOf(), FetchPortalTargetList(), FillPortalStore(), HoldPinnedPortals(), PerformCursorOpen(), PortalRun(), PortalRunFetch(), PortalStart(), and SPI_cursor_open_internal().

tupDesc

TupleDesc PortalData::tupDesc

Definition at line 159 of file portal.h.

Referenced by cursor_to_xmlschema(), exec_describe_portal_message(), PersistHoldablePortal(), PortalSetResultFormat(), PortalStart(), query_to_xml_and_xmlschema(), query_to_xmlschema(), RunFromStore(), UtilityReturnsTuples(), and UtilityTupleDescriptor().

visible

bool PortalData::visible

Definition at line 204 of file portal.h.

Referenced by CreatePortal(), exec_simple_query(), ExecuteQuery(), and pg_cursor().

---

The documentation for this struct was generated from the following file:

• src/include/utils/portal.h