cmdtag.h File Reference

#include "tcop/cmdtaglist.h"

Include dependency graph for cmdtag.h:

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

Go to the source code of this file.

Data Structures
struct	QueryCompletion

Macros
#define	COMPLETION_TAG_BUFSIZE   64
#define	PG_CMDTAG(tag, name, evtrgok, rwrok, rowcnt)    tag,

Typedefs
typedef enum CommandTag	CommandTag
typedef struct QueryCompletion	QueryCompletion

Enumerations
enum	CommandTag

Functions
static void	SetQueryCompletion (QueryCompletion *qc, CommandTag commandTag, uint64 nprocessed)
static void	CopyQueryCompletion (QueryCompletion *dst, const QueryCompletion *src)
void	InitializeQueryCompletion (QueryCompletion *qc)
const char *	GetCommandTagName (CommandTag commandTag)
const char *	GetCommandTagNameAndLen (CommandTag commandTag, Size *len)
bool	command_tag_display_rowcount (CommandTag commandTag)
bool	command_tag_event_trigger_ok (CommandTag commandTag)
bool	command_tag_table_rewrite_ok (CommandTag commandTag)
CommandTag	GetCommandTagEnum (const char *commandname)
Size	BuildQueryCompletionString (char *buff, const QueryCompletion *qc, bool nameonly)

Macro Definition Documentation

COMPLETION_TAG_BUFSIZE

#define COMPLETION_TAG_BUFSIZE   64

Definition at line 17 of file cmdtag.h.

PG_CMDTAG

#define PG_CMDTAG	(		tag,
			name,
			evtrgok,
			rwrok,
			rowcnt
	)		tag,

Definition at line 19 of file cmdtag.h.

{
#include "tcop/cmdtaglist.h"
} CommandTag;
 
#undef PG_CMDTAG
 
typedef struct QueryCompletion
{
    CommandTag  commandTag;
    uint64      nprocessed;
} QueryCompletion;
 
 
static inline void
SetQueryCompletion(QueryCompletion *qc, CommandTag commandTag,
                   uint64 nprocessed)
{
    qc->commandTag = commandTag;
    qc->nprocessed = nprocessed;
}
 
static inline void
CopyQueryCompletion(QueryCompletion *dst, const QueryCompletion *src)
{
    dst->commandTag = src->commandTag;
    dst->nprocessed = src->nprocessed;
}
 
 
extern void InitializeQueryCompletion(QueryCompletion *qc);
extern const char *GetCommandTagName(CommandTag commandTag);
extern const char *GetCommandTagNameAndLen(CommandTag commandTag, Size *len);
extern bool command_tag_display_rowcount(CommandTag commandTag);
extern bool command_tag_event_trigger_ok(CommandTag commandTag);
extern bool command_tag_table_rewrite_ok(CommandTag commandTag);
extern CommandTag GetCommandTagEnum(const char *commandname);
extern Size BuildQueryCompletionString(char *buff, const QueryCompletion *qc,
                                       bool nameonly);
 
#endif                          /* CMDTAG_H */

Typedef Documentation

CommandTag

typedef enum CommandTag CommandTag

QueryCompletion

typedef struct QueryCompletion QueryCompletion

Enumeration Type Documentation

CommandTag

enum CommandTag

Definition at line 22 of file cmdtag.h.

{
#include "tcop/cmdtaglist.h"
} CommandTag;

Function Documentation

BuildQueryCompletionString()

Size BuildQueryCompletionString ( char *  buff, const QueryCompletion *  qc, bool  nameonly  )

extern

Definition at line 121 of file cmdtag.c.

{
    CommandTag  tag = qc->commandTag;
    Size        taglen;
    const char *tagname = GetCommandTagNameAndLen(tag, &taglen);
    char       *bufp;
 
    /*
     * We assume the tagname is plain ASCII and therefore requires no encoding
     * conversion.
     */
    memcpy(buff, tagname, taglen);
    bufp = buff + taglen;
 
    /* ensure that the tagname isn't long enough to overrun the buffer */
    Assert(taglen <= COMPLETION_TAG_BUFSIZE - MAXINT8LEN - 4);
 
    /*
     * In PostgreSQL versions 11 and earlier, it was possible to create a
     * table WITH OIDS.  When inserting into such a table, INSERT used to
     * include the Oid of the inserted record in the completion tag.  To
     * maintain compatibility in the wire protocol, we now write a "0" (for
     * InvalidOid) in the location where we once wrote the new record's Oid.
     */
    if (command_tag_display_rowcount(tag) && !nameonly)
    {
        if (tag == CMDTAG_INSERT)
        {
            *bufp++ = ' ';
            *bufp++ = '0';
        }
        *bufp++ = ' ';
        bufp += pg_ulltoa_n(qc->nprocessed, bufp);
    }
 
    /* and finally, NUL terminate the string */
    *bufp = '\0';
 
    Assert((bufp - buff) == strlen(buff));
 
    return bufp - buff;
}

References Assert, command_tag_display_rowcount(), QueryCompletion::commandTag, COMPLETION_TAG_BUFSIZE, fb(), GetCommandTagNameAndLen(), MAXINT8LEN, QueryCompletion::nprocessed, and pg_ulltoa_n().

Referenced by EndCommand().

command_tag_display_rowcount()

bool command_tag_display_rowcount ( CommandTag  commandTag )

extern

Definition at line 60 of file cmdtag.c.

{
    return tag_behavior[commandTag].display_rowcount;
}

References CommandTagBehavior::display_rowcount, and tag_behavior.

Referenced by BuildQueryCompletionString().

command_tag_event_trigger_ok()

bool command_tag_event_trigger_ok ( CommandTag  commandTag )

extern

Definition at line 66 of file cmdtag.c.

{
    return tag_behavior[commandTag].event_trigger_ok;
}

References CommandTagBehavior::event_trigger_ok, and tag_behavior.

Referenced by EventTriggerCommonSetup(), and validate_ddl_tags().

command_tag_table_rewrite_ok()

bool command_tag_table_rewrite_ok ( CommandTag  commandTag )

extern

Definition at line 72 of file cmdtag.c.

{
    return tag_behavior[commandTag].table_rewrite_ok;
}

References CommandTagBehavior::table_rewrite_ok, and tag_behavior.

Referenced by EventTriggerCommonSetup(), and validate_table_rewrite_tags().

CopyQueryCompletion()

static void CopyQueryCompletion ( QueryCompletion *  dst, const QueryCompletion *  src  )

inlinestatic

Definition at line 45 of file cmdtag.h.

{
    dst->commandTag = src->commandTag;
    dst->nprocessed = src->nprocessed;
}

References QueryCompletion::commandTag, fb(), and QueryCompletion::nprocessed.

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

GetCommandTagEnum()

CommandTag GetCommandTagEnum ( const char *  commandname )

extern

Definition at line 83 of file cmdtag.c.

{
    const CommandTagBehavior *base,
               *last,
               *position;
    int         result;
 
    if (commandname == NULL || *commandname == '\0')
        return CMDTAG_UNKNOWN;
 
    base = tag_behavior;
    last = tag_behavior + lengthof(tag_behavior) - 1;
    while (last >= base)
    {
        position = base + ((last - base) >> 1);
        result = pg_strcasecmp(commandname, position->name);
        if (result == 0)
            return (CommandTag) (position - tag_behavior);
        else if (result < 0)
            last = position - 1;
        else
            base = position + 1;
    }
    return CMDTAG_UNKNOWN;
}

References fb(), lengthof, CommandTagBehavior::name, pg_strcasecmp(), and tag_behavior.

Referenced by DecodeTextArrayToBitmapset(), validate_ddl_tags(), and validate_table_rewrite_tags().

GetCommandTagName()

const char * GetCommandTagName ( CommandTag  commandTag )

extern

Definition at line 47 of file cmdtag.c.

{
    return tag_behavior[commandTag].name;
}

References CommandTagBehavior::name, and tag_behavior.

Referenced by _SPI_execute_plan(), CreateCommandName(), EventTriggerCommonSetup(), interpret_AS_clause(), plperl_event_trigger_build_args(), plpgsql_fulfill_promise(), pltcl_event_trigger_handler(), PLy_exec_event_trigger(), REGRESS_utility_command(), SPI_cursor_open_internal(), and standard_ProcessUtility().

GetCommandTagNameAndLen()

const char * GetCommandTagNameAndLen ( CommandTag  commandTag, Size *  len  )

extern

Definition at line 53 of file cmdtag.c.

{
    *len = (Size) tag_behavior[commandTag].namelen;
    return tag_behavior[commandTag].name;
}

References len, CommandTagBehavior::name, and tag_behavior.

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

InitializeQueryCompletion()

void InitializeQueryCompletion ( QueryCompletion *  qc )

extern

Definition at line 40 of file cmdtag.c.

{
    qc->commandTag = CMDTAG_UNKNOWN;
    qc->nprocessed = 0;
}

References QueryCompletion::commandTag, fb(), and QueryCompletion::nprocessed.

Referenced by _SPI_execute_plan(), FillPortalStore(), and PortalRun().

SetQueryCompletion()

static void SetQueryCompletion ( QueryCompletion *  qc, CommandTag  commandTag, uint64  nprocessed  )

inlinestatic

Definition at line 37 of file cmdtag.h.

{
    qc->commandTag = commandTag;
    qc->nprocessed = nprocessed;
}

References QueryCompletion::commandTag, and QueryCompletion::nprocessed.

Referenced by ExecCreateTableAs(), PerformPortalFetch(), ProcessQuery(), RefreshMatViewByOid(), standard_ProcessUtility(), StartLogicalReplication(), and WalSndDone().