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 "utils/array.h"
21 
22 /* commands/dropcmds.c */
23 extern void RemoveObjects(DropStmt *stmt);
24 
25 /* commands/indexcmds.c */
26 extern ObjectAddress DefineIndex(Oid relationId,
27  IndexStmt *stmt,
28  Oid indexRelationId,
29  Oid parentIndexId,
30  Oid parentConstraintId,
31  bool is_alter_table,
32  bool check_rights,
33  bool check_not_in_use,
34  bool skip_build,
35  bool quiet);
36 extern void ReindexIndex(RangeVar *indexRelation, int options);
37 extern Oid ReindexTable(RangeVar *relation, int options);
38 extern void ReindexMultipleTables(const char *objectName, ReindexObjectType objectKind,
39  int options);
40 extern char *makeObjectName(const char *name1, const char *name2,
41  const char *label);
42 extern char *ChooseRelationName(const char *name1, const char *name2,
43  const char *label, Oid namespaceid);
44 extern bool CheckIndexCompatible(Oid oldId,
45  const char *accessMethodName,
46  List *attributeList,
47  List *exclusionOpNames);
48 extern Oid GetDefaultOpClass(Oid type_id, Oid am_id);
49 extern Oid ResolveOpClass(List *opclass, Oid attrType,
50  const char *accessMethodName, Oid accessMethodId);
51 
52 /* commands/functioncmds.c */
54 extern void RemoveFunctionById(Oid funcOid);
55 extern void SetFunctionReturnType(Oid funcOid, Oid newRetType);
56 extern void SetFunctionArgType(Oid funcOid, int argIndex, Oid newArgType);
59 extern void DropCastById(Oid castOid);
61 extern void DropTransformById(Oid transformOid);
62 extern void IsThereFunctionInNamespace(const char *proname, int pronargs,
63  oidvector *proargtypes, Oid nspOid);
64 extern void ExecuteDoStmt(DoStmt *stmt, bool atomic);
65 extern void ExecuteCallStmt(CallStmt *stmt, ParamListInfo params, bool atomic);
66 extern Oid get_cast_oid(Oid sourcetypeid, Oid targettypeid, bool missing_ok);
67 extern Oid get_transform_oid(Oid type_id, Oid lang_id, bool missing_ok);
69  List *parameters,
70  Oid languageOid,
71  ObjectType objtype,
72  oidvector **parameterTypes,
73  ArrayType **allParameterTypes,
74  ArrayType **parameterModes,
75  ArrayType **parameterNames,
76  List **parameterDefaults,
77  Oid *variadicArgType,
78  Oid *requiredResultType);
79 
80 /* commands/operatorcmds.c */
81 extern ObjectAddress DefineOperator(List *names, List *parameters);
82 extern void RemoveOperatorById(Oid operOid);
84 
85 /* commands/statscmds.c */
87 extern void RemoveStatisticsById(Oid statsOid);
88 extern void UpdateStatisticsForTypeChange(Oid statsOid,
89  Oid relationOid, int attnum,
90  Oid oldColumnType, Oid newColumnType);
91 
92 /* commands/aggregatecmds.c */
93 extern ObjectAddress DefineAggregate(ParseState *pstate, List *name, List *args, bool oldstyle,
94  List *parameters);
95 
96 /* commands/opclasscmds.c */
99 extern Oid AlterOpFamily(AlterOpFamilyStmt *stmt);
100 extern void RemoveOpClassById(Oid opclassOid);
101 extern void RemoveOpFamilyById(Oid opfamilyOid);
102 extern void RemoveAmOpEntryById(Oid entryOid);
103 extern void RemoveAmProcEntryById(Oid entryOid);
104 extern void IsThereOpClassInNamespace(const char *opcname, Oid opcmethod,
105  Oid opcnamespace);
106 extern void IsThereOpFamilyInNamespace(const char *opfname, Oid opfmethod,
107  Oid opfnamespace);
108 extern Oid get_opclass_oid(Oid amID, List *opclassname, bool missing_ok);
109 extern Oid get_opfamily_oid(Oid amID, List *opfamilyname, bool missing_ok);
110 
111 /* commands/tsearchcmds.c */
112 extern ObjectAddress DefineTSParser(List *names, List *parameters);
113 extern void RemoveTSParserById(Oid prsId);
114 
115 extern ObjectAddress DefineTSDictionary(List *names, List *parameters);
116 extern void RemoveTSDictionaryById(Oid dictId);
118 
119 extern ObjectAddress DefineTSTemplate(List *names, List *parameters);
120 extern void RemoveTSTemplateById(Oid tmplId);
121 
122 extern ObjectAddress DefineTSConfiguration(List *names, List *parameters,
123  ObjectAddress *copied);
124 extern void RemoveTSConfigurationById(Oid cfgId);
126 
127 extern text *serialize_deflist(List *deflist);
128 extern List *deserialize_deflist(Datum txt);
129 
130 /* commands/foreigncmds.c */
131 extern ObjectAddress AlterForeignServerOwner(const char *name, Oid newOwnerId);
132 extern void AlterForeignServerOwner_oid(Oid, Oid newOwnerId);
133 extern ObjectAddress AlterForeignDataWrapperOwner(const char *name, Oid newOwnerId);
134 extern void AlterForeignDataWrapperOwner_oid(Oid fwdId, Oid newOwnerId);
137 extern void RemoveForeignDataWrapperById(Oid fdwId);
140 extern void RemoveForeignServerById(Oid srvId);
144 extern void RemoveUserMappingById(Oid umId);
145 extern void CreateForeignTable(CreateForeignTableStmt *stmt, Oid relid);
147 extern Datum transformGenericOptions(Oid catalogId,
148  Datum oldOptions,
149  List *options,
150  Oid fdwvalidator);
151 
152 /* commands/amcmds.c */
154 extern void RemoveAccessMethodById(Oid amOid);
155 extern Oid get_index_am_oid(const char *amname, bool missing_ok);
156 extern Oid get_am_oid(const char *amname, bool missing_ok);
157 extern char *get_am_name(Oid amOid);
158 
159 /* support routines in commands/define.c */
160 
161 extern char *defGetString(DefElem *def);
162 extern double defGetNumeric(DefElem *def);
163 extern bool defGetBoolean(DefElem *def);
164 extern int32 defGetInt32(DefElem *def);
165 extern int64 defGetInt64(DefElem *def);
166 extern List *defGetQualifiedName(DefElem *def);
167 extern TypeName *defGetTypeName(DefElem *def);
168 extern int defGetTypeLength(DefElem *def);
169 extern List *defGetStringList(DefElem *def);
170 
171 #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:1719
Oid AlterOpFamily(AlterOpFamilyStmt *stmt)
Definition: opclasscmds.c:764
Definition: c.h:544
void RemoveFunctionById(Oid funcOid)
char * makeObjectName(const char *name1, const char *name2, const char *label)
Definition: indexcmds.c:1827
Oid ResolveOpClass(List *opclass, Oid attrType, const char *accessMethodName, Oid accessMethodId)
Definition: indexcmds.c:1608
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:2178
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:2206
void ExecuteCallStmt(CallStmt *stmt, ParamListInfo params, bool atomic)
unsigned int Oid
Definition: postgres_ext.h:31
Oid get_cast_oid(Oid sourcetypeid, Oid targettypeid, bool missing_ok)
ReindexObjectType
Definition: parsenodes.h:3264
bool CheckIndexCompatible(Oid oldId, const char *accessMethodName, List *attributeList, List *exclusionOpNames)
Definition: indexcmds.c:124
Oid get_am_oid(const char *amname, bool missing_ok)
Definition: amcmds.c:193
signed int int32
Definition: c.h:302
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:392
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:319
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:862
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:1631
ObjectAddress DefineOpFamily(CreateOpFamilyStmt *stmt)
Definition: opclasscmds.c:719
ObjectAddress CreateUserMapping(CreateUserMappingStmt *stmt)
Definition: foreigncmds.c:1135
ObjectAddress CreateStatistics(CreateStatsStmt *stmt)
Definition: statscmds.c:49
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:82
void RemoveOperatorById(Oid operOid)
Definition: operatorcmds.c:340
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
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:2078
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:58
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:68
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:1907
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:351
int32 defGetInt32(DefElem *def)
Definition: define.c:166
void RemoveUserMappingById(Oid umId)
Definition: foreigncmds.c:1422
Definition: c.h:505
List * deserialize_deflist(Datum txt)
Definition: tsearchcmds.c:1561
void DropCastById(Oid castOid)
ObjectAddress AlterOperator(AlterOperatorStmt *stmt)
Definition: operatorcmds.c:385
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