PostgreSQL Source Code  git master
defrem.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * defrem.h
4  * POSTGRES define and remove utility definitions.
5  *
6  *
7  * Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/commands/defrem.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef DEFREM_H
15 #define DEFREM_H
16 
17 #include "catalog/objectaddress.h"
18 #include "nodes/params.h"
19 #include "nodes/parsenodes.h"
20 #include "tcop/dest.h"
21 #include "utils/array.h"
22 
23 /* commands/dropcmds.c */
24 extern void RemoveObjects(DropStmt *stmt);
25 
26 /* commands/indexcmds.c */
27 extern ObjectAddress DefineIndex(Oid relationId,
28  IndexStmt *stmt,
29  Oid indexRelationId,
30  Oid parentIndexId,
31  Oid parentConstraintId,
32  bool is_alter_table,
33  bool check_rights,
34  bool check_not_in_use,
35  bool skip_build,
36  bool quiet);
37 extern void ReindexIndex(RangeVar *indexRelation, int options);
38 extern Oid ReindexTable(RangeVar *relation, int options);
39 extern void ReindexMultipleTables(const char *objectName, ReindexObjectType objectKind,
40  int options);
41 extern char *makeObjectName(const char *name1, const char *name2,
42  const char *label);
43 extern char *ChooseRelationName(const char *name1, const char *name2,
44  const char *label, Oid namespaceid);
45 extern bool CheckIndexCompatible(Oid oldId,
46  const char *accessMethodName,
47  List *attributeList,
48  List *exclusionOpNames);
49 extern Oid GetDefaultOpClass(Oid type_id, Oid am_id);
50 extern Oid ResolveOpClass(List *opclass, Oid attrType,
51  const char *accessMethodName, Oid accessMethodId);
52 
53 /* commands/functioncmds.c */
55 extern void RemoveFunctionById(Oid funcOid);
56 extern void SetFunctionReturnType(Oid funcOid, Oid newRetType);
57 extern void SetFunctionArgType(Oid funcOid, int argIndex, Oid newArgType);
60 extern void DropCastById(Oid castOid);
62 extern void DropTransformById(Oid transformOid);
63 extern void IsThereFunctionInNamespace(const char *proname, int pronargs,
64  oidvector *proargtypes, Oid nspOid);
65 extern void ExecuteDoStmt(DoStmt *stmt, bool atomic);
66 extern void ExecuteCallStmt(CallStmt *stmt, ParamListInfo params, bool atomic, DestReceiver *dest);
67 extern Oid get_cast_oid(Oid sourcetypeid, Oid targettypeid, bool missing_ok);
68 extern Oid get_transform_oid(Oid type_id, Oid lang_id, bool missing_ok);
70  List *parameters,
71  Oid languageOid,
72  ObjectType objtype,
73  oidvector **parameterTypes,
74  ArrayType **allParameterTypes,
75  ArrayType **parameterModes,
76  ArrayType **parameterNames,
77  List **parameterDefaults,
78  Oid *variadicArgType,
79  Oid *requiredResultType);
80 
81 /* commands/operatorcmds.c */
82 extern ObjectAddress DefineOperator(List *names, List *parameters);
83 extern void RemoveOperatorById(Oid operOid);
85 
86 /* commands/statscmds.c */
88 extern void RemoveStatisticsById(Oid statsOid);
89 extern void UpdateStatisticsForTypeChange(Oid statsOid,
90  Oid relationOid, int attnum,
91  Oid oldColumnType, Oid newColumnType);
92 
93 /* commands/aggregatecmds.c */
94 extern ObjectAddress DefineAggregate(ParseState *pstate, List *name, List *args, bool oldstyle,
95  List *parameters);
96 
97 /* commands/opclasscmds.c */
100 extern Oid AlterOpFamily(AlterOpFamilyStmt *stmt);
101 extern void RemoveOpClassById(Oid opclassOid);
102 extern void RemoveOpFamilyById(Oid opfamilyOid);
103 extern void RemoveAmOpEntryById(Oid entryOid);
104 extern void RemoveAmProcEntryById(Oid entryOid);
105 extern void IsThereOpClassInNamespace(const char *opcname, Oid opcmethod,
106  Oid opcnamespace);
107 extern void IsThereOpFamilyInNamespace(const char *opfname, Oid opfmethod,
108  Oid opfnamespace);
109 extern Oid get_opclass_oid(Oid amID, List *opclassname, bool missing_ok);
110 extern Oid get_opfamily_oid(Oid amID, List *opfamilyname, bool missing_ok);
111 
112 /* commands/tsearchcmds.c */
113 extern ObjectAddress DefineTSParser(List *names, List *parameters);
114 extern void RemoveTSParserById(Oid prsId);
115 
116 extern ObjectAddress DefineTSDictionary(List *names, List *parameters);
117 extern void RemoveTSDictionaryById(Oid dictId);
119 
120 extern ObjectAddress DefineTSTemplate(List *names, List *parameters);
121 extern void RemoveTSTemplateById(Oid tmplId);
122 
123 extern ObjectAddress DefineTSConfiguration(List *names, List *parameters,
124  ObjectAddress *copied);
125 extern void RemoveTSConfigurationById(Oid cfgId);
127 
128 extern text *serialize_deflist(List *deflist);
129 extern List *deserialize_deflist(Datum txt);
130 
131 /* commands/foreigncmds.c */
132 extern ObjectAddress AlterForeignServerOwner(const char *name, Oid newOwnerId);
133 extern void AlterForeignServerOwner_oid(Oid, Oid newOwnerId);
134 extern ObjectAddress AlterForeignDataWrapperOwner(const char *name, Oid newOwnerId);
135 extern void AlterForeignDataWrapperOwner_oid(Oid fwdId, Oid newOwnerId);
138 extern void RemoveForeignDataWrapperById(Oid fdwId);
141 extern void RemoveForeignServerById(Oid srvId);
145 extern void RemoveUserMappingById(Oid umId);
146 extern void CreateForeignTable(CreateForeignTableStmt *stmt, Oid relid);
148 extern Datum transformGenericOptions(Oid catalogId,
149  Datum oldOptions,
150  List *options,
151  Oid fdwvalidator);
152 
153 /* commands/amcmds.c */
155 extern void RemoveAccessMethodById(Oid amOid);
156 extern Oid get_index_am_oid(const char *amname, bool missing_ok);
157 extern Oid get_am_oid(const char *amname, bool missing_ok);
158 extern char *get_am_name(Oid amOid);
159 
160 /* support routines in commands/define.c */
161 
162 extern char *defGetString(DefElem *def);
163 extern double defGetNumeric(DefElem *def);
164 extern bool defGetBoolean(DefElem *def);
165 extern int32 defGetInt32(DefElem *def);
166 extern int64 defGetInt64(DefElem *def);
167 extern List *defGetQualifiedName(DefElem *def);
168 extern TypeName *defGetTypeName(DefElem *def);
169 extern int defGetTypeLength(DefElem *def);
170 extern List *defGetStringList(DefElem *def);
171 
172 #endif /* DEFREM_H */
Oid RemoveUserMapping(DropUserMappingStmt *stmt)
Definition: foreigncmds.c:1345
void RemoveTSTemplateById(Oid tmplId)
Definition: tsearchcmds.c:821
List * defGetStringList(DefElem *def)
Definition: define.c:327
Oid GetDefaultOpClass(Oid type_id, Oid am_id)
Definition: indexcmds.c:1797
Oid AlterOpFamily(AlterOpFamilyStmt *stmt)
Definition: opclasscmds.c:764
Definition: c.h:555
void RemoveFunctionById(Oid funcOid)
char * makeObjectName(const char *name1, const char *name2, const char *label)
Definition: indexcmds.c:1906
Oid ResolveOpClass(List *opclass, Oid attrType, const char *accessMethodName, Oid accessMethodId)
Definition: indexcmds.c:1686
void RemoveOpClassById(Oid opclassOid)
Definition: opclasscmds.c:1603
void ImportForeignSchema(ImportForeignSchemaStmt *stmt)
Definition: foreigncmds.c:1526
void AlterForeignDataWrapperOwner_oid(Oid fwdId, Oid newOwnerId)
Definition: foreigncmds.c:312
void ExecuteDoStmt(DoStmt *stmt, bool atomic)
char * get_am_name(Oid amOid)
Definition: amcmds.c:202
void AlterForeignServerOwner_oid(Oid, Oid newOwnerId)
Definition: foreigncmds.c:447
Oid ReindexTable(RangeVar *relation, int options)
Definition: indexcmds.c:2259
ObjectAddress CreateCast(CreateCastStmt *stmt)
List * defGetQualifiedName(DefElem *def)
Definition: define.c:223
Oid get_index_am_oid(const char *amname, bool missing_ok)
Definition: amcmds.c:183
void ReindexMultipleTables(const char *objectName, ReindexObjectType objectKind, int options)
Definition: indexcmds.c:2287
int16 pronargs
Definition: pg_proc.h:80
unsigned int Oid
Definition: postgres_ext.h:31
Oid get_cast_oid(Oid sourcetypeid, Oid targettypeid, bool missing_ok)
ReindexObjectType
Definition: parsenodes.h:3274
bool CheckIndexCompatible(Oid oldId, const char *accessMethodName, List *attributeList, List *exclusionOpNames)
Definition: indexcmds.c:126
Oid get_am_oid(const char *amname, bool missing_ok)
Definition: amcmds.c:193
signed int int32
Definition: c.h:313
ObjectAddress DefineTSParser(List *names, List *parameters)
Definition: tsearchcmds.c:176
void RemoveOpFamilyById(Oid opfamilyOid)
Definition: opclasscmds.c:1584
void UpdateStatisticsForTypeChange(Oid statsOid, Oid relationOid, int attnum, Oid oldColumnType, Oid newColumnType)
Definition: statscmds.c:419
void RemoveTSParserById(Oid prsId)
Definition: tsearchcmds.c:292
double defGetNumeric(DefElem *def)
Definition: define.c:85
void RemoveAmProcEntryById(Oid entryOid)
Definition: opclasscmds.c:1651
ObjectAddress DefineIndex(Oid relationId, IndexStmt *stmt, Oid indexRelationId, Oid parentIndexId, Oid parentConstraintId, bool is_alter_table, bool check_rights, bool check_not_in_use, bool skip_build, bool quiet)
Definition: indexcmds.c:325
ObjectAddress CreateForeignDataWrapper(CreateFdwStmt *stmt)
Definition: foreigncmds.c:560
Oid get_opclass_oid(Oid amID, List *opclassname, bool missing_ok)
Definition: opclasscmds.c:221
void IsThereFunctionInNamespace(const char *proname, int pronargs, oidvector *proargtypes, Oid nspOid)
ObjectAddress DefineTSTemplate(List *names, List *parameters)
Definition: tsearchcmds.c:729
bool defGetBoolean(DefElem *def)
Definition: define.c:111
ObjectAddress AlterForeignServerOwner(const char *name, Oid newOwnerId)
Definition: foreigncmds.c:414
ObjectAddress CreateFunction(ParseState *pstate, CreateFunctionStmt *stmt)
Definition: functioncmds.c:865
ObjectAddress DefineTSConfiguration(List *names, List *parameters, ObjectAddress *copied)
Definition: tsearchcmds.c:960
int64 defGetInt64(DefElem *def)
Definition: define.c:190
void SetFunctionReturnType(Oid funcOid, Oid newRetType)
void RemoveTSDictionaryById(Oid dictId)
Definition: tsearchcmds.c:501
int defGetTypeLength(DefElem *def)
Definition: define.c:283
ObjectAddress DefineTSDictionary(List *names, List *parameters)
Definition: tsearchcmds.c:409
ObjectAddress AlterFunction(ParseState *pstate, AlterFunctionStmt *stmt)
TypeName * defGetTypeName(DefElem *def)
Definition: define.c:255
void SetFunctionArgType(Oid funcOid, int argIndex, Oid newArgType)
void DropTransformById(Oid transformOid)
ObjectType
Definition: parsenodes.h:1634
ObjectAddress DefineOpFamily(CreateOpFamilyStmt *stmt)
Definition: opclasscmds.c:719
ObjectAddress CreateUserMapping(CreateUserMappingStmt *stmt)
Definition: foreigncmds.c:1135
ObjectAddress CreateStatistics(CreateStatsStmt *stmt)
Definition: statscmds.c:55
Oid get_opfamily_oid(Oid amID, List *opfamilyname, bool missing_ok)
Definition: opclasscmds.c:142
ObjectAddress AlterForeignDataWrapperOwner(const char *name, Oid newOwnerId)
Definition: foreigncmds.c:277
uintptr_t Datum
Definition: postgres.h:365
static char * label
Definition: pg_basebackup.c:84
void RemoveOperatorById(Oid operOid)
Definition: operatorcmds.c:339
void ExecuteCallStmt(CallStmt *stmt, ParamListInfo params, bool atomic, DestReceiver *dest)
text * serialize_deflist(List *deflist)
Definition: tsearchcmds.c:1516
void CreateForeignTable(CreateForeignTableStmt *stmt, Oid relid)
Definition: foreigncmds.c:1446
void RemoveAmOpEntryById(Oid entryOid)
Definition: opclasscmds.c:1622
int16 attnum
Definition: pg_attribute.h:79
ObjectAddress AlterTSConfiguration(AlterTSConfigurationStmt *stmt)
Definition: tsearchcmds.c:1173
void RemoveTSConfigurationById(Oid cfgId)
Definition: tsearchcmds.c:1125
Oid get_transform_oid(Oid type_id, Oid lang_id, bool missing_ok)
void ReindexIndex(RangeVar *indexRelation, int options)
Definition: indexcmds.c:2159
ObjectAddress CreateTransform(CreateTransformStmt *stmt)
ObjectAddress AlterUserMapping(AlterUserMappingStmt *stmt)
Definition: foreigncmds.c:1250
void IsThereOpFamilyInNamespace(const char *opfname, Oid opfmethod, Oid opfnamespace)
Definition: opclasscmds.c:1709
ObjectAddress DefineAggregate(ParseState *pstate, List *name, List *args, bool oldstyle, List *parameters)
Definition: aggregatecmds.c:57
Datum transformGenericOptions(Oid catalogId, Datum oldOptions, List *options, Oid fdwvalidator)
Definition: foreigncmds.c:109
ObjectAddress CreateForeignServer(CreateForeignServerStmt *stmt)
Definition: foreigncmds.c:861
ObjectAddress AlterTSDictionary(AlterTSDictionaryStmt *stmt)
Definition: tsearchcmds.c:525
ObjectAddress AlterForeignServer(AlterForeignServerStmt *stmt)
Definition: foreigncmds.c:985
const char * name
Definition: encode.c:521
char * defGetString(DefElem *def)
Definition: define.c:49
ObjectAddress DefineOperator(List *names, List *parameters)
Definition: operatorcmds.c:67
ObjectAddress DefineOpClass(CreateOpClassStmt *stmt)
Definition: opclasscmds.c:324
void RemoveObjects(DropStmt *stmt)
Definition: dropcmds.c:55
char * ChooseRelationName(const char *name1, const char *name2, const char *label, Oid namespaceid)
Definition: indexcmds.c:1986
void interpret_function_parameter_list(ParseState *pstate, List *parameters, Oid languageOid, ObjectType objtype, oidvector **parameterTypes, ArrayType **allParameterTypes, ArrayType **parameterModes, ArrayType **parameterNames, List **parameterDefaults, Oid *variadicArgType, Oid *requiredResultType)
Definition: functioncmds.c:182
ObjectAddress CreateAccessMethod(CreateAmStmt *stmt)
Definition: amcmds.c:41
void RemoveStatisticsById(Oid statsOid)
Definition: statscmds.c:378
int32 defGetInt32(DefElem *def)
Definition: define.c:166
void RemoveUserMappingById(Oid umId)
Definition: foreigncmds.c:1422
Definition: c.h:516
List * deserialize_deflist(Datum txt)
Definition: tsearchcmds.c:1561
void DropCastById(Oid castOid)
ObjectAddress AlterOperator(AlterOperatorStmt *stmt)
Definition: operatorcmds.c:384
Definition: pg_list.h:45
ObjectAddress AlterForeignDataWrapper(AlterFdwStmt *stmt)
Definition: foreigncmds.c:673
void RemoveForeignDataWrapperById(Oid fdwId)
Definition: foreigncmds.c:837
void RemoveAccessMethodById(Oid amOid)
Definition: amcmds.c:115
void RemoveForeignServerById(Oid srvId)
Definition: foreigncmds.c:1084
void IsThereOpClassInNamespace(const char *opcname, Oid opcmethod, Oid opcnamespace)
Definition: opclasscmds.c:1686