dest.h File Reference

#include "executor/tuptable.h"
#include "tcop/cmdtag.h"

Include dependency graph for dest.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_DestReceiver

Typedefs
typedef struct _DestReceiver	DestReceiver

Enumerations
enum	CommandDest {   DestNone , DestDebug , DestRemote , DestRemoteExecute ,   DestRemoteSimple , DestSPI , DestTuplestore , DestIntoRel ,   DestCopyOut , DestSQLFunction , DestTransientRel , DestTupleQueue ,   DestExplainSerialize }

Functions
void	BeginCommand (CommandTag commandTag, CommandDest dest)
DestReceiver *	CreateDestReceiver (CommandDest dest)
void	EndCommandExtended (const QueryCompletion *qc, CommandDest dest, bool force_undecorated_output, bool noblock)
void	EndCommand (const QueryCompletion *qc, CommandDest dest, bool force_undecorated_output)
void	EndReplicationCommand (const char *commandTag)
void	NullCommand (CommandDest dest)
void	ReadyForQuery (CommandDest dest)

Variables
PGDLLIMPORT DestReceiver *	None_Receiver

Typedef Documentation

DestReceiver

typedef struct _DestReceiver DestReceiver

Definition at line 113 of file dest.h.

Enumeration Type Documentation

CommandDest

enum CommandDest

Enumerator
DestNone
DestDebug
DestRemote
DestRemoteExecute
DestRemoteSimple
DestSPI
DestTuplestore
DestIntoRel
DestCopyOut
DestSQLFunction
DestTransientRel
DestTupleQueue
DestExplainSerialize

Definition at line 85 of file dest.h.

{
    DestNone,                   /* results are discarded */
    DestDebug,                  /* results go to debugging output */
    DestRemote,                 /* results sent to frontend process */
    DestRemoteExecute,          /* sent to frontend, in Execute command */
    DestRemoteSimple,           /* sent to frontend, w/no catalog access */
    DestSPI,                    /* results sent to SPI manager */
    DestTuplestore,             /* results sent to Tuplestore */
    DestIntoRel,                /* results sent to relation (SELECT INTO) */
    DestCopyOut,                /* results sent to COPY TO code */
    DestSQLFunction,            /* results sent to SQL-language func mgr */
    DestTransientRel,           /* results sent to transient relation */
    DestTupleQueue,             /* results sent to tuple queue */
    DestExplainSerialize,       /* results are serialized and discarded */
} CommandDest;

Function Documentation

BeginCommand()

void BeginCommand ( CommandTag  commandTag, CommandDest  dest  )

extern

Definition at line 103 of file dest.c.

{
    /* Nothing to do at present */
}

Referenced by exec_execute_message(), and exec_simple_query().

CreateDestReceiver()

DestReceiver * CreateDestReceiver ( CommandDest  dest )

extern

Definition at line 113 of file dest.c.

{
    /*
     * It's ok to cast the constness away as any modification of the none
     * receiver would be a bug (which gets easier to catch this way).
     */
 
    switch (dest)
    {
        case DestRemote:
        case DestRemoteExecute:
            return printtup_create_DR(dest);
 
        case DestRemoteSimple:
            return unconstify(DestReceiver *, &printsimpleDR);
 
        case DestNone:
            return unconstify(DestReceiver *, &donothingDR);
 
        case DestDebug:
            return unconstify(DestReceiver *, &debugtupDR);
 
        case DestSPI:
            return unconstify(DestReceiver *, &spi_printtupDR);
 
        case DestTuplestore:
            return CreateTuplestoreDestReceiver();
 
        case DestIntoRel:
            return CreateIntoRelDestReceiver(NULL);
 
        case DestCopyOut:
            return CreateCopyDestReceiver();
 
        case DestSQLFunction:
            return CreateSQLFunctionDestReceiver();
 
        case DestTransientRel:
            return CreateTransientRelDestReceiver(InvalidOid);
 
        case DestTupleQueue:
            return CreateTupleQueueDestReceiver(NULL);
 
        case DestExplainSerialize:
            return CreateExplainSerializeDestReceiver(NULL);
    }
 
    /* should never get here */
    pg_unreachable();
}

References CreateCopyDestReceiver(), CreateExplainSerializeDestReceiver(), CreateIntoRelDestReceiver(), CreateSQLFunctionDestReceiver(), CreateTransientRelDestReceiver(), CreateTupleQueueDestReceiver(), CreateTuplestoreDestReceiver(), debugtupDR, DestCopyOut, DestDebug, DestExplainSerialize, DestIntoRel, DestNone, DestRemote, DestRemoteExecute, DestRemoteSimple, DestSPI, DestSQLFunction, DestTransientRel, DestTupleQueue, DestTuplestore, donothingDR, fb(), InvalidOid, pg_unreachable, printsimpleDR, printtup_create_DR(), spi_printtupDR, and unconstify.

Referenced by _SPI_execute_plan(), BeginCopyTo(), CreateReplicationSlot(), exec_execute_message(), exec_replication_command(), exec_simple_query(), exec_stmt_return_query(), execute_sql_string(), FillPortalStore(), IdentifySystem(), PersistHoldablePortal(), postquel_start(), ReadReplicationSlot(), SendTablespaceList(), SendTimeLineHistory(), SendXlogRecPtrResult(), SPI_cursor_fetch(), SPI_scroll_cursor_fetch(), and StartReplication().

EndCommand()

void EndCommand ( const QueryCompletion *  qc, CommandDest  dest, bool  force_undecorated_output  )

extern

Definition at line 205 of file dest.c.

{
    EndCommandExtended(qc, dest, force_undecorated_output, false);
}

References EndCommandExtended(), and fb().

Referenced by exec_execute_message(), exec_simple_query(), and StartLogicalReplication().

EndCommandExtended()

void EndCommandExtended ( const QueryCompletion *  qc, CommandDest  dest, bool  force_undecorated_output, bool  noblock  )

extern

Definition at line 170 of file dest.c.

{
    char        completionTag[COMPLETION_TAG_BUFSIZE];
    Size        len;
 
    switch (dest)
    {
        case DestRemote:
        case DestRemoteExecute:
        case DestRemoteSimple:
 
            len = BuildQueryCompletionString(completionTag, qc,
                                             force_undecorated_output);
            if (noblock)
                pq_putmessage_noblock(PqMsg_CommandComplete, completionTag, len + 1);
            else
                pq_putmessage(PqMsg_CommandComplete, completionTag, len + 1);
            break;
 
        case DestNone:
        case DestDebug:
        case DestSPI:
        case DestTuplestore:
        case DestIntoRel:
        case DestCopyOut:
        case DestSQLFunction:
        case DestTransientRel:
        case DestTupleQueue:
        case DestExplainSerialize:
            break;
    }
}

References BuildQueryCompletionString(), COMPLETION_TAG_BUFSIZE, DestCopyOut, DestDebug, DestExplainSerialize, DestIntoRel, DestNone, DestRemote, DestRemoteExecute, DestRemoteSimple, DestSPI, DestSQLFunction, DestTransientRel, DestTupleQueue, DestTuplestore, fb(), len, pq_putmessage, pq_putmessage_noblock, and PqMsg_CommandComplete.

Referenced by EndCommand(), WalSndDone(), and WalSndDoneImmediate().

EndReplicationCommand()

void EndReplicationCommand ( const char *  commandTag )

extern

Definition at line 217 of file dest.c.

{
    pq_putmessage(PqMsg_CommandComplete, commandTag, strlen(commandTag) + 1);
}

References fb(), pq_putmessage, and PqMsg_CommandComplete.

Referenced by exec_replication_command(), and StartReplication().

NullCommand()

void NullCommand ( CommandDest  dest )

extern

Definition at line 230 of file dest.c.

{
    switch (dest)
    {
        case DestRemote:
        case DestRemoteExecute:
        case DestRemoteSimple:
 
            /* Tell the FE that we saw an empty query string */
            pq_putemptymessage(PqMsg_EmptyQueryResponse);
            break;
 
        case DestNone:
        case DestDebug:
        case DestSPI:
        case DestTuplestore:
        case DestIntoRel:
        case DestCopyOut:
        case DestSQLFunction:
        case DestTransientRel:
        case DestTupleQueue:
        case DestExplainSerialize:
            break;
    }
}

References DestCopyOut, DestDebug, DestExplainSerialize, DestIntoRel, DestNone, DestRemote, DestRemoteExecute, DestRemoteSimple, DestSPI, DestSQLFunction, DestTransientRel, DestTupleQueue, DestTuplestore, pq_putemptymessage(), and PqMsg_EmptyQueryResponse.

Referenced by exec_execute_message(), and exec_simple_query().

ReadyForQuery()

void ReadyForQuery ( CommandDest  dest )

extern

Definition at line 268 of file dest.c.

{
    switch (dest)
    {
        case DestRemote:
        case DestRemoteExecute:
        case DestRemoteSimple:
            {
                StringInfoData buf;
 
                pq_beginmessage(&buf, PqMsg_ReadyForQuery);
                pq_sendbyte(&buf, TransactionBlockStatusCode());
                pq_endmessage(&buf);
            }
            /* Flush output at end of cycle in any case. */
            pq_flush();
            break;
 
        case DestNone:
        case DestDebug:
        case DestSPI:
        case DestTuplestore:
        case DestIntoRel:
        case DestCopyOut:
        case DestSQLFunction:
        case DestTransientRel:
        case DestTupleQueue:
        case DestExplainSerialize:
            break;
    }
}

References buf, DestCopyOut, DestDebug, DestExplainSerialize, DestIntoRel, DestNone, DestRemote, DestRemoteExecute, DestRemoteSimple, DestSPI, DestSQLFunction, DestTransientRel, DestTupleQueue, DestTuplestore, pq_beginmessage(), pq_endmessage(), pq_flush, pq_sendbyte(), PqMsg_ReadyForQuery, and TransactionBlockStatusCode().

Referenced by PostgresMain().

Variable Documentation

None_Receiver

PGDLLIMPORT DestReceiver* None_Receiver

extern

Definition at line 96 of file dest.c.

Referenced by CreateSchemaCommand(), DoPortalRunFetch(), ExplainOnePlan(), FillPortalStore(), ImportForeignSchema(), PerformPortalFetch(), PortalRunMulti(), PortalStart(), postquel_start(), ProcessUtilityForAlterTable(), ProcessUtilitySlow(), SPI_cursor_move(), and SPI_scroll_cursor_move().