src/include/commands/comment.h

   1 /*
   2  * $PostgreSQL$
   3  *
   4  *-------------------------------------------------------------------------
   5  *
   6  * comment.h
   7  *
   8  * Prototypes for functions in commands/comment.c
   9  *
  10  * Copyright (c) 1999-2009, PostgreSQL Global Development Group
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14
  15 #ifndef COMMENT_H
  16 #define COMMENT_H
  17
  18 #include "nodes/parsenodes.h"
  19
  20 /*------------------------------------------------------------------
  21  * Function Prototypes --
  22  *
  23  * The following prototypes define the public functions of the comment
  24  * related routines.  CommentObject() implements the SQL "COMMENT ON"
  25  * command.  DeleteComments() deletes all comments for an object.
  26  * CreateComments creates (or deletes, if comment is NULL) a comment
  27  * for a specific key.  There are versions of these two methods for
  28  * both normal and shared objects.
  29  *------------------------------------------------------------------
  30  */
  31
  32 extern void CommentObject(CommentStmt *stmt);
  33
  34 extern void DeleteComments(Oid oid, Oid classoid, int32 subid);
  35
  36 extern void CreateComments(Oid oid, Oid classoid, int32 subid, char *comment);
  37
  38 extern void DeleteSharedComments(Oid oid, Oid classoid);
  39
  40 extern void CreateSharedComments(Oid oid, Oid classoid, char *comment);
  41
  42 #endif   /* COMMENT_H */