PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
comment.h
Go to the documentation of this file.
1 /*
2  * src/include/commands/comment.h
3  *
4  *-------------------------------------------------------------------------
5  *
6  * comment.h
7  *
8  * Prototypes for functions in commands/comment.c
9  *
10  * Copyright (c) 1999-2017, PostgreSQL Global Development Group
11  *
12  *-------------------------------------------------------------------------
13  */
14 
15 #ifndef COMMENT_H
16 #define COMMENT_H
17 
18 #include "catalog/objectaddress.h"
19 #include "nodes/parsenodes.h"
20 
21 /*------------------------------------------------------------------
22  * Function Prototypes --
23  *
24  * The following prototypes define the public functions of the comment
25  * related routines. CommentObject() implements the SQL "COMMENT ON"
26  * command. DeleteComments() deletes all comments for an object.
27  * CreateComments creates (or deletes, if comment is NULL) a comment
28  * for a specific key. There are versions of these two methods for
29  * both normal and shared objects.
30  *------------------------------------------------------------------
31  */
32 
34 
35 extern void DeleteComments(Oid oid, Oid classoid, int32 subid);
36 
37 extern void CreateComments(Oid oid, Oid classoid, int32 subid, char *comment);
38 
39 extern void DeleteSharedComments(Oid oid, Oid classoid);
40 
41 extern void CreateSharedComments(Oid oid, Oid classoid, char *comment);
42 
43 extern char *GetComment(Oid oid, Oid classoid, int32 subid);
44 
45 #endif /* COMMENT_H */
void DeleteComments(Oid oid, Oid classoid, int32 subid)
Definition: comment.c:324
unsigned int Oid
Definition: postgres_ext.h:31
signed int int32
Definition: c.h:256
ObjectAddress CommentObject(CommentStmt *stmt)
Definition: comment.c:40
void CreateComments(Oid oid, Oid classoid, int32 subid, char *comment)
Definition: comment.c:141
void CreateSharedComments(Oid oid, Oid classoid, char *comment)
Definition: comment.c:236
char * GetComment(Oid oid, Oid classoid, int32 subid)
Definition: comment.c:408
void DeleteSharedComments(Oid oid, Oid classoid)
Definition: comment.c:372