#include "postgres.h"
#include "miscadmin.h"
#include "tcop/cmdtag.h"
#include "utils/builtins.h"
#include "tcop/cmdtaglist.h"

Include dependency graph for cmdtag.c:

Go to the source code of this file.

Data Structures
struct	CommandTagBehavior

Macros
#define	PG_CMDTAG(tag, name, evtrgok, rwrok, rowcnt) { name, (uint8) (sizeof(name) - 1), evtrgok, rwrok, rowcnt },

Typedefs
typedef struct CommandTagBehavior	CommandTagBehavior

Functions
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)

Variables
static const CommandTagBehavior	tag_behavior [COMMAND_TAG_NEXTTAG]

Macro Definition Documentation

◆ PG_CMDTAG

#define PG_CMDTAG	(	tag,
		name,
		evtrgok,
		rwrok,
		rowcnt
	)	{ name, (uint8) (sizeof(name) - 1), evtrgok, rwrok, rowcnt },

Definition at line 31 of file cmdtag.c.

Typedef Documentation

◆ CommandTagBehavior

typedef struct CommandTagBehavior CommandTagBehavior

Function Documentation

◆ BuildQueryCompletionString()

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

Definition at line 122 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, GetCommandTagNameAndLen(), MAXINT8LEN, QueryCompletion::nprocessed, and pg_ulltoa_n().

Referenced by EndCommand().

◆ command_tag_display_rowcount()

bool command_tag_display_rowcount ( CommandTag commandTag )

Definition at line 61 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 )

Definition at line 67 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 )

Definition at line 73 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().

◆ GetCommandTagEnum()

CommandTag GetCommandTagEnum ( const char * commandname )

Definition at line 84 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 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 )

Definition at line 48 of file cmdtag.c.

 {
     return tag_behavior[commandTag].name;
 }

References CommandTagBehavior::name, and tag_behavior.

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

◆ GetCommandTagNameAndLen()

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

Definition at line 54 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().

◆ InitializeQueryCompletion()

void InitializeQueryCompletion ( QueryCompletion * qc )

Definition at line 41 of file cmdtag.c.

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

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

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

Variable Documentation

◆ tag_behavior

const CommandTagBehavior tag_behavior[COMMAND_TAG_NEXTTAG]

static

Initial value:

= {

}

Definition at line 34 of file cmdtag.c.

Referenced by command_tag_display_rowcount(), command_tag_event_trigger_ok(), command_tag_table_rewrite_ok(), GetCommandTagEnum(), GetCommandTagName(), and GetCommandTagNameAndLen().

Data Structures

Macros

Typedefs

Functions

Variables