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-2019, 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
33extern ObjectAddress CommentObject(CommentStmt *stmt);
34
35extern void DeleteComments(Oid oid, Oid classoid, int32 subid);
36
37extern void CreateComments(Oid oid, Oid classoid, int32 subid, const char *comment);
38
39extern void DeleteSharedComments(Oid oid, Oid classoid);
40
41extern void CreateSharedComments(Oid oid, Oid classoid, const char *comment);
42
43extern char *GetComment(Oid oid, Oid classoid, int32 subid);
44
45#endif /* COMMENT_H */
46