PostgreSQL Source Code  git master
rewriteDefine.h File Reference
Include dependency graph for rewriteDefine.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define RULE_FIRES_ON_ORIGIN   'O'
 
#define RULE_FIRES_ALWAYS   'A'
 
#define RULE_FIRES_ON_REPLICA   'R'
 
#define RULE_DISABLED   'D'
 

Functions

ObjectAddress DefineRule (RuleStmt *stmt, const char *queryString)
 
ObjectAddress DefineQueryRewrite (const char *rulename, Oid event_relid, Node *event_qual, CmdType event_type, bool is_instead, bool replace, List *action)
 
ObjectAddress RenameRewriteRule (RangeVar *relation, const char *oldName, const char *newName)
 
void setRuleCheckAsUser (Node *node, Oid userid)
 
void EnableDisableRule (Relation rel, const char *rulename, char fires_when)
 

Macro Definition Documentation

◆ RULE_DISABLED

#define RULE_DISABLED   'D'

Definition at line 24 of file rewriteDefine.h.

Referenced by ATExecCmd(), and matchLocks().

◆ RULE_FIRES_ALWAYS

#define RULE_FIRES_ALWAYS   'A'

Definition at line 22 of file rewriteDefine.h.

Referenced by ATExecCmd().

◆ RULE_FIRES_ON_ORIGIN

#define RULE_FIRES_ON_ORIGIN   'O'

Definition at line 21 of file rewriteDefine.h.

Referenced by ATExecCmd(), InsertRule(), and matchLocks().

◆ RULE_FIRES_ON_REPLICA

#define RULE_FIRES_ON_REPLICA   'R'

Definition at line 23 of file rewriteDefine.h.

Referenced by ATExecCmd(), and matchLocks().

Function Documentation

◆ DefineQueryRewrite()

ObjectAddress DefineQueryRewrite ( const char *  rulename,
Oid  event_relid,
Node event_qual,
CmdType  event_type,
bool  is_instead,
bool  replace,
List action 
)

Definition at line 233 of file rewriteDefine.c.

References AccessExclusiveLock, aclcheck_error(), ACLCHECK_NOT_OWNER, allowSystemTableMods, CatalogTupleUpdate(), checkRuleResultList(), ObjectAddress::classId, CMD_SELECT, CommandCounterIncrement(), Query::commandType, deleteDependencyRecordsFor(), DeleteSystemAttributeTuples(), DROP_RESTRICT, elog, ereport, errcode(), errhint(), errmsg(), ERROR, RewriteRule::event, ExecDropSingleTupleTableSlot(), ForwardScanDirection, get_relkind_objtype(), getInsertSelectQuery(), GetLatestSnapshot(), GETSTRUCT, GetUserId(), Query::hasModifyingCTE, heap_freetuple(), HeapTupleIsValid, i, InsertRule(), InvalidMultiXactId, InvalidOid, InvalidTransactionId, IsSystemRelation(), lfirst_node, linitial_node, list_length(), NAMEDATALEN, NIL, NoLock, RuleLock::numLocks, ObjectAddressSet, ObjectAddress::objectId, ObjectIdGetDatum, ObjectAddress::objectSubId, OidIsValid, PERFORM_DELETION_INTERNAL, performDeletion(), pg_class_ownercheck(), PRS2_NEW_VARNO, PRS2_OLD_VARNO, pstrdup(), RelationData::rd_rel, RelationData::rd_rules, RegisterSnapshot(), relation_has_policies(), RelationDropStorage(), RelationGetDescr, RelationGetRelationName, RELOID, Query::resultRelation, Query::returningList, RowExclusiveLock, RuleLock::rules, SearchSysCacheCopy1, SetRelationRuleStatus(), HeapTupleData::t_self, table_beginscan(), table_close(), table_endscan(), table_open(), table_scan_getnextslot(), table_slot_create(), Query::targetList, UnregisterSnapshot(), and ViewSelectRuleName.

Referenced by DefineRule(), and DefineViewRules().

240 {
241  Relation event_relation;
242  ListCell *l;
243  Query *query;
244  bool RelisBecomingView = false;
245  Oid ruleId = InvalidOid;
246  ObjectAddress address;
247 
248  /*
249  * If we are installing an ON SELECT rule, we had better grab
250  * AccessExclusiveLock to ensure no SELECTs are currently running on the
251  * event relation. For other types of rules, it would be sufficient to
252  * grab ShareRowExclusiveLock to lock out insert/update/delete actions and
253  * to ensure that we lock out current CREATE RULE statements; but because
254  * of race conditions in access to catalog entries, we can't do that yet.
255  *
256  * Note that this lock level should match the one used in DefineRule.
257  */
258  event_relation = table_open(event_relid, AccessExclusiveLock);
259 
260  /*
261  * Verify relation is of a type that rules can sensibly be applied to.
262  * Internal callers can target materialized views, but transformRuleStmt()
263  * blocks them for users. Don't mention them in the error message.
264  */
265  if (event_relation->rd_rel->relkind != RELKIND_RELATION &&
266  event_relation->rd_rel->relkind != RELKIND_MATVIEW &&
267  event_relation->rd_rel->relkind != RELKIND_VIEW &&
268  event_relation->rd_rel->relkind != RELKIND_PARTITIONED_TABLE)
269  ereport(ERROR,
270  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
271  errmsg("\"%s\" is not a table or view",
272  RelationGetRelationName(event_relation))));
273 
274  if (!allowSystemTableMods && IsSystemRelation(event_relation))
275  ereport(ERROR,
276  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
277  errmsg("permission denied: \"%s\" is a system catalog",
278  RelationGetRelationName(event_relation))));
279 
280  /*
281  * Check user has permission to apply rules to this relation.
282  */
283  if (!pg_class_ownercheck(event_relid, GetUserId()))
284  aclcheck_error(ACLCHECK_NOT_OWNER, get_relkind_objtype(event_relation->rd_rel->relkind),
285  RelationGetRelationName(event_relation));
286 
287  /*
288  * No rule actions that modify OLD or NEW
289  */
290  foreach(l, action)
291  {
292  query = lfirst_node(Query, l);
293  if (query->resultRelation == 0)
294  continue;
295  /* Don't be fooled by INSERT/SELECT */
296  if (query != getInsertSelectQuery(query, NULL))
297  continue;
298  if (query->resultRelation == PRS2_OLD_VARNO)
299  ereport(ERROR,
300  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
301  errmsg("rule actions on OLD are not implemented"),
302  errhint("Use views or triggers instead.")));
303  if (query->resultRelation == PRS2_NEW_VARNO)
304  ereport(ERROR,
305  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
306  errmsg("rule actions on NEW are not implemented"),
307  errhint("Use triggers instead.")));
308  }
309 
310  if (event_type == CMD_SELECT)
311  {
312  /*
313  * Rules ON SELECT are restricted to view definitions
314  *
315  * So there cannot be INSTEAD NOTHING, ...
316  */
317  if (list_length(action) == 0)
318  ereport(ERROR,
319  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
320  errmsg("INSTEAD NOTHING rules on SELECT are not implemented"),
321  errhint("Use views instead.")));
322 
323  /*
324  * ... there cannot be multiple actions, ...
325  */
326  if (list_length(action) > 1)
327  ereport(ERROR,
328  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
329  errmsg("multiple actions for rules on SELECT are not implemented")));
330 
331  /*
332  * ... the one action must be a SELECT, ...
333  */
334  query = linitial_node(Query, action);
335  if (!is_instead ||
336  query->commandType != CMD_SELECT)
337  ereport(ERROR,
338  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
339  errmsg("rules on SELECT must have action INSTEAD SELECT")));
340 
341  /*
342  * ... it cannot contain data-modifying WITH ...
343  */
344  if (query->hasModifyingCTE)
345  ereport(ERROR,
346  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
347  errmsg("rules on SELECT must not contain data-modifying statements in WITH")));
348 
349  /*
350  * ... there can be no rule qual, ...
351  */
352  if (event_qual != NULL)
353  ereport(ERROR,
354  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
355  errmsg("event qualifications are not implemented for rules on SELECT")));
356 
357  /*
358  * ... the targetlist of the SELECT action must exactly match the
359  * event relation, ...
360  */
362  RelationGetDescr(event_relation),
363  true,
364  event_relation->rd_rel->relkind !=
365  RELKIND_MATVIEW);
366 
367  /*
368  * ... there must not be another ON SELECT rule already ...
369  */
370  if (!replace && event_relation->rd_rules != NULL)
371  {
372  int i;
373 
374  for (i = 0; i < event_relation->rd_rules->numLocks; i++)
375  {
376  RewriteRule *rule;
377 
378  rule = event_relation->rd_rules->rules[i];
379  if (rule->event == CMD_SELECT)
380  ereport(ERROR,
381  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
382  errmsg("\"%s\" is already a view",
383  RelationGetRelationName(event_relation))));
384  }
385  }
386 
387  /*
388  * ... and finally the rule must be named _RETURN.
389  */
390  if (strcmp(rulename, ViewSelectRuleName) != 0)
391  {
392  /*
393  * In versions before 7.3, the expected name was _RETviewname. For
394  * backwards compatibility with old pg_dump output, accept that
395  * and silently change it to _RETURN. Since this is just a quick
396  * backwards-compatibility hack, limit the number of characters
397  * checked to a few less than NAMEDATALEN; this saves having to
398  * worry about where a multibyte character might have gotten
399  * truncated.
400  */
401  if (strncmp(rulename, "_RET", 4) != 0 ||
402  strncmp(rulename + 4, RelationGetRelationName(event_relation),
403  NAMEDATALEN - 4 - 4) != 0)
404  ereport(ERROR,
405  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
406  errmsg("view rule for \"%s\" must be named \"%s\"",
407  RelationGetRelationName(event_relation),
409  rulename = pstrdup(ViewSelectRuleName);
410  }
411 
412  /*
413  * Are we converting a relation to a view?
414  *
415  * If so, check that the relation is empty because the storage for the
416  * relation is going to be deleted. Also insist that the rel not have
417  * any triggers, indexes, child tables, policies, or RLS enabled.
418  * (Note: these tests are too strict, because they will reject
419  * relations that once had such but don't anymore. But we don't
420  * really care, because this whole business of converting relations to
421  * views is just a kluge to allow dump/reload of views that
422  * participate in circular dependencies.)
423  */
424  if (event_relation->rd_rel->relkind != RELKIND_VIEW &&
425  event_relation->rd_rel->relkind != RELKIND_MATVIEW)
426  {
427  TableScanDesc scanDesc;
428  Snapshot snapshot;
429  TupleTableSlot *slot;
430 
431  if (event_relation->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
432  ereport(ERROR,
433  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
434  errmsg("cannot convert partitioned table \"%s\" to a view",
435  RelationGetRelationName(event_relation))));
436 
437  if (event_relation->rd_rel->relispartition)
438  ereport(ERROR,
439  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
440  errmsg("cannot convert partition \"%s\" to a view",
441  RelationGetRelationName(event_relation))));
442 
443  snapshot = RegisterSnapshot(GetLatestSnapshot());
444  scanDesc = table_beginscan(event_relation, snapshot, 0, NULL);
445  slot = table_slot_create(event_relation, NULL);
446  if (table_scan_getnextslot(scanDesc, ForwardScanDirection, slot))
447  ereport(ERROR,
448  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
449  errmsg("could not convert table \"%s\" to a view because it is not empty",
450  RelationGetRelationName(event_relation))));
452  table_endscan(scanDesc);
453  UnregisterSnapshot(snapshot);
454 
455  if (event_relation->rd_rel->relhastriggers)
456  ereport(ERROR,
457  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
458  errmsg("could not convert table \"%s\" to a view because it has triggers",
459  RelationGetRelationName(event_relation)),
460  errhint("In particular, the table cannot be involved in any foreign key relationships.")));
461 
462  if (event_relation->rd_rel->relhasindex)
463  ereport(ERROR,
464  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
465  errmsg("could not convert table \"%s\" to a view because it has indexes",
466  RelationGetRelationName(event_relation))));
467 
468  if (event_relation->rd_rel->relhassubclass)
469  ereport(ERROR,
470  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
471  errmsg("could not convert table \"%s\" to a view because it has child tables",
472  RelationGetRelationName(event_relation))));
473 
474  if (event_relation->rd_rel->relrowsecurity)
475  ereport(ERROR,
476  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
477  errmsg("could not convert table \"%s\" to a view because it has row security enabled",
478  RelationGetRelationName(event_relation))));
479 
480  if (relation_has_policies(event_relation))
481  ereport(ERROR,
482  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
483  errmsg("could not convert table \"%s\" to a view because it has row security policies",
484  RelationGetRelationName(event_relation))));
485 
486  RelisBecomingView = true;
487  }
488  }
489  else
490  {
491  /*
492  * For non-SELECT rules, a RETURNING list can appear in at most one of
493  * the actions ... and there can't be any RETURNING list at all in a
494  * conditional or non-INSTEAD rule. (Actually, there can be at most
495  * one RETURNING list across all rules on the same event, but it seems
496  * best to enforce that at rule expansion time.) If there is a
497  * RETURNING list, it must match the event relation.
498  */
499  bool haveReturning = false;
500 
501  foreach(l, action)
502  {
503  query = lfirst_node(Query, l);
504 
505  if (!query->returningList)
506  continue;
507  if (haveReturning)
508  ereport(ERROR,
509  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
510  errmsg("cannot have multiple RETURNING lists in a rule")));
511  haveReturning = true;
512  if (event_qual != NULL)
513  ereport(ERROR,
514  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
515  errmsg("RETURNING lists are not supported in conditional rules")));
516  if (!is_instead)
517  ereport(ERROR,
518  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
519  errmsg("RETURNING lists are not supported in non-INSTEAD rules")));
521  RelationGetDescr(event_relation),
522  false, false);
523  }
524  }
525 
526  /*
527  * This rule is allowed - prepare to install it.
528  */
529 
530  /* discard rule if it's null action and not INSTEAD; it's a no-op */
531  if (action != NIL || is_instead)
532  {
533  ruleId = InsertRule(rulename,
534  event_type,
535  event_relid,
536  is_instead,
537  event_qual,
538  action,
539  replace);
540 
541  /*
542  * Set pg_class 'relhasrules' field true for event relation.
543  *
544  * Important side effect: an SI notice is broadcast to force all
545  * backends (including me!) to update relcache entries with the new
546  * rule.
547  */
548  SetRelationRuleStatus(event_relid, true);
549  }
550 
551  /* ---------------------------------------------------------------------
552  * If the relation is becoming a view:
553  * - delete the associated storage files
554  * - get rid of any system attributes in pg_attribute; a view shouldn't
555  * have any of those
556  * - remove the toast table; there is no need for it anymore, and its
557  * presence would make vacuum slightly more complicated
558  * - set relkind to RELKIND_VIEW, and adjust other pg_class fields
559  * to be appropriate for a view
560  *
561  * NB: we had better have AccessExclusiveLock to do this ...
562  * ---------------------------------------------------------------------
563  */
564  if (RelisBecomingView)
565  {
566  Relation relationRelation;
567  Oid toastrelid;
568  HeapTuple classTup;
569  Form_pg_class classForm;
570 
571  relationRelation = table_open(RelationRelationId, RowExclusiveLock);
572  toastrelid = event_relation->rd_rel->reltoastrelid;
573 
574  /* drop storage while table still looks like a table */
575  RelationDropStorage(event_relation);
576  DeleteSystemAttributeTuples(event_relid);
577 
578  /*
579  * Drop the toast table if any. (This won't take care of updating the
580  * toast fields in the relation's own pg_class entry; we handle that
581  * below.)
582  */
583  if (OidIsValid(toastrelid))
584  {
585  ObjectAddress toastobject;
586 
587  /*
588  * Delete the dependency of the toast relation on the main
589  * relation so we can drop the former without dropping the latter.
590  */
591  deleteDependencyRecordsFor(RelationRelationId, toastrelid,
592  false);
593 
594  /* Make deletion of dependency record visible */
596 
597  /* Now drop toast table, including its index */
598  toastobject.classId = RelationRelationId;
599  toastobject.objectId = toastrelid;
600  toastobject.objectSubId = 0;
601  performDeletion(&toastobject, DROP_RESTRICT,
603  }
604 
605  /*
606  * SetRelationRuleStatus may have updated the pg_class row, so we must
607  * advance the command counter before trying to update it again.
608  */
610 
611  /*
612  * Fix pg_class entry to look like a normal view's, including setting
613  * the correct relkind and removal of reltoastrelid of the toast table
614  * we potentially removed above.
615  */
616  classTup = SearchSysCacheCopy1(RELOID, ObjectIdGetDatum(event_relid));
617  if (!HeapTupleIsValid(classTup))
618  elog(ERROR, "cache lookup failed for relation %u", event_relid);
619  classForm = (Form_pg_class) GETSTRUCT(classTup);
620 
621  classForm->relam = InvalidOid;
622  classForm->reltablespace = InvalidOid;
623  classForm->relpages = 0;
624  classForm->reltuples = 0;
625  classForm->relallvisible = 0;
626  classForm->reltoastrelid = InvalidOid;
627  classForm->relhasindex = false;
628  classForm->relkind = RELKIND_VIEW;
629  classForm->relfrozenxid = InvalidTransactionId;
630  classForm->relminmxid = InvalidMultiXactId;
631  classForm->relreplident = REPLICA_IDENTITY_NOTHING;
632 
633  CatalogTupleUpdate(relationRelation, &classTup->t_self, classTup);
634 
635  heap_freetuple(classTup);
636  table_close(relationRelation, RowExclusiveLock);
637  }
638 
639  ObjectAddressSet(address, RewriteRelationId, ruleId);
640 
641  /* Close rel, but keep lock till commit... */
642  table_close(event_relation, NoLock);
643 
644  return address;
645 }
TupleTableSlot * table_slot_create(Relation relation, List **reglist)
Definition: tableam.c:77
#define NIL
Definition: pg_list.h:65
Query * getInsertSelectQuery(Query *parsetree, Query ***subquery_ptr)
Definition: rewriteManip.c:921
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
int errhint(const char *fmt,...)
Definition: elog.c:974
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
int numLocks
Definition: prs2lock.h:42
bool IsSystemRelation(Relation relation)
Definition: catalog.c:70
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:865
#define RelationGetDescr(relation)
Definition: rel.h:445
Oid GetUserId(void)
Definition: miscinit.c:380
char * pstrdup(const char *in)
Definition: mcxt.c:1186
int resultRelation
Definition: parsenodes.h:122
long deleteDependencyRecordsFor(Oid classId, Oid objectId, bool skipExtensionDeps)
Definition: pg_depend.c:190
int errcode(int sqlerrcode)
Definition: elog.c:570
static void checkRuleResultList(List *targetList, TupleDesc resultDesc, bool isSelect, bool requireColumnNameMatch)
#define ViewSelectRuleName
static bool table_scan_getnextslot(TableScanDesc sscan, ScanDirection direction, TupleTableSlot *slot)
Definition: tableam.h:872
Form_pg_class rd_rel
Definition: rel.h:83
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
unsigned int Oid
Definition: postgres_ext.h:31
#define linitial_node(type, l)
Definition: pg_list.h:198
#define OidIsValid(objectId)
Definition: c.h:638
void SetRelationRuleStatus(Oid relationId, bool relHasRules)
Definition: localtime.c:79
List * targetList
Definition: parsenodes.h:140
#define NAMEDATALEN
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition: aclchk.c:3353
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
static TableScanDesc table_beginscan(Relation rel, Snapshot snapshot, int nkeys, struct ScanKeyData *key)
Definition: tableam.h:736
ItemPointerData t_self
Definition: htup.h:65
#define lfirst_node(type, lc)
Definition: pg_list.h:193
#define NoLock
Definition: lockdefs.h:34
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1219
#define RowExclusiveLock
Definition: lockdefs.h:38
CmdType event
Definition: prs2lock.h:27
void performDeletion(const ObjectAddress *object, DropBehavior behavior, int flags)
Definition: dependency.c:315
#define InvalidTransactionId
Definition: transam.h:31
#define RelationGetRelationName(relation)
Definition: rel.h:453
RewriteRule ** rules
Definition: prs2lock.h:43
List * returningList
Definition: parsenodes.h:146
#define ereport(elevel, rest)
Definition: elog.h:141
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:907
#define PRS2_OLD_VARNO
Definition: primnodes.h:164
void RelationDropStorage(Relation rel)
Definition: storage.c:148
void CommandCounterIncrement(void)
Definition: xact.c:1003
#define InvalidMultiXactId
Definition: multixact.h:23
bool allowSystemTableMods
Definition: globals.c:120
#define InvalidOid
Definition: postgres_ext.h:36
CmdType commandType
Definition: parsenodes.h:112
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
bool pg_class_ownercheck(Oid class_oid, Oid roleid)
Definition: aclchk.c:4755
RuleLock * rd_rules
Definition: rel.h:87
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
static int list_length(const List *l)
Definition: pg_list.h:169
Snapshot GetLatestSnapshot(void)
Definition: snapmgr.c:381
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:831
FormData_pg_class * Form_pg_class
Definition: pg_class.h:150
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
#define AccessExclusiveLock
Definition: lockdefs.h:45
bool relation_has_policies(Relation rel)
Definition: policy.c:1378
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
static Oid InsertRule(const char *rulname, int evtype, Oid eventrel_oid, bool evinstead, Node *event_qual, List *action, bool replace)
Definition: rewriteDefine.c:59
void DeleteSystemAttributeTuples(Oid relid)
Definition: heap.c:1538
int i
ObjectType get_relkind_objtype(char relkind)
bool hasModifyingCTE
Definition: parsenodes.h:131
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define PRS2_NEW_VARNO
Definition: primnodes.h:165
#define PERFORM_DELETION_INTERNAL
Definition: dependency.h:134

◆ DefineRule()

ObjectAddress DefineRule ( RuleStmt stmt,
const char *  queryString 
)

Definition at line 199 of file rewriteDefine.c.

References AccessExclusiveLock, DefineQueryRewrite(), RuleStmt::event, RuleStmt::instead, RangeVarGetRelid, RuleStmt::relation, RuleStmt::replace, RuleStmt::rulename, and transformRuleStmt().

Referenced by ProcessUtilitySlow().

200 {
201  List *actions;
202  Node *whereClause;
203  Oid relId;
204 
205  /* Parse analysis. */
206  transformRuleStmt(stmt, queryString, &actions, &whereClause);
207 
208  /*
209  * Find and lock the relation. Lock level should match
210  * DefineQueryRewrite.
211  */
212  relId = RangeVarGetRelid(stmt->relation, AccessExclusiveLock, false);
213 
214  /* ... and execute */
215  return DefineQueryRewrite(stmt->rulename,
216  relId,
217  whereClause,
218  stmt->event,
219  stmt->instead,
220  stmt->replace,
221  actions);
222 }
#define RangeVarGetRelid(relation, lockmode, missing_ok)
Definition: namespace.h:63
Definition: nodes.h:525
unsigned int Oid
Definition: postgres_ext.h:31
bool instead
Definition: parsenodes.h:2966
bool replace
Definition: parsenodes.h:2968
char * rulename
Definition: parsenodes.h:2963
CmdType event
Definition: parsenodes.h:2965
#define AccessExclusiveLock
Definition: lockdefs.h:45
RangeVar * relation
Definition: parsenodes.h:2962
Definition: pg_list.h:50
ObjectAddress DefineQueryRewrite(const char *rulename, Oid event_relid, Node *event_qual, CmdType event_type, bool is_instead, bool replace, List *action)
void transformRuleStmt(RuleStmt *stmt, const char *queryString, List **actions, Node **whereClause)

◆ EnableDisableRule()

void EnableDisableRule ( Relation  rel,
const char *  rulename,
char  fires_when 
)

Definition at line 846 of file rewriteDefine.c.

References aclcheck_error(), ACLCHECK_NOT_OWNER, Assert, CacheInvalidateRelcache(), CatalogTupleUpdate(), CharGetDatum, DatumGetChar, ereport, errcode(), errmsg(), ERROR, get_rel_name(), get_rel_relkind(), get_relkind_objtype(), GETSTRUCT, GetUserId(), heap_freetuple(), HeapTupleIsValid, InvokeObjectPostAlterHook, ObjectIdGetDatum, pg_class_ownercheck(), PointerGetDatum, RelationGetRelid, RowExclusiveLock, RULERELNAME, SearchSysCacheCopy2, HeapTupleData::t_self, table_close(), and table_open().

Referenced by ATExecEnableDisableRule().

848 {
849  Relation pg_rewrite_desc;
850  Oid owningRel = RelationGetRelid(rel);
851  Oid eventRelationOid;
852  HeapTuple ruletup;
853  Form_pg_rewrite ruleform;
854  bool changed = false;
855 
856  /*
857  * Find the rule tuple to change.
858  */
859  pg_rewrite_desc = table_open(RewriteRelationId, RowExclusiveLock);
861  ObjectIdGetDatum(owningRel),
862  PointerGetDatum(rulename));
863  if (!HeapTupleIsValid(ruletup))
864  ereport(ERROR,
865  (errcode(ERRCODE_UNDEFINED_OBJECT),
866  errmsg("rule \"%s\" for relation \"%s\" does not exist",
867  rulename, get_rel_name(owningRel))));
868 
869  ruleform = (Form_pg_rewrite) GETSTRUCT(ruletup);
870 
871  /*
872  * Verify that the user has appropriate permissions.
873  */
874  eventRelationOid = ruleform->ev_class;
875  Assert(eventRelationOid == owningRel);
876  if (!pg_class_ownercheck(eventRelationOid, GetUserId()))
878  get_rel_name(eventRelationOid));
879 
880  /*
881  * Change ev_enabled if it is different from the desired new state.
882  */
883  if (DatumGetChar(ruleform->ev_enabled) !=
884  fires_when)
885  {
886  ruleform->ev_enabled = CharGetDatum(fires_when);
887  CatalogTupleUpdate(pg_rewrite_desc, &ruletup->t_self, ruletup);
888 
889  changed = true;
890  }
891 
892  InvokeObjectPostAlterHook(RewriteRelationId, ruleform->oid, 0);
893 
894  heap_freetuple(ruletup);
895  table_close(pg_rewrite_desc, RowExclusiveLock);
896 
897  /*
898  * If we changed anything, broadcast a SI inval message to force each
899  * backend (including our own!) to rebuild relation's relcache entry.
900  * Otherwise they will fail to apply the change promptly.
901  */
902  if (changed)
904 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
Oid GetUserId(void)
Definition: miscinit.c:380
#define PointerGetDatum(X)
Definition: postgres.h:556
char get_rel_relkind(Oid relid)
Definition: lsyscache.c:1805
int errcode(int sqlerrcode)
Definition: elog.c:570
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
unsigned int Oid
Definition: postgres_ext.h:31
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition: aclchk.c:3353
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
ItemPointerData t_self
Definition: htup.h:65
#define RowExclusiveLock
Definition: lockdefs.h:38
#define ereport(elevel, rest)
Definition: elog.h:141
#define InvokeObjectPostAlterHook(classId, objectId, subId)
Definition: objectaccess.h:163
#define DatumGetChar(X)
Definition: postgres.h:409
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:732
bool pg_class_ownercheck(Oid class_oid, Oid roleid)
Definition: aclchk.c:4755
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
#define CharGetDatum(X)
Definition: postgres.h:416
FormData_pg_rewrite * Form_pg_rewrite
Definition: pg_rewrite.h:52
void CacheInvalidateRelcache(Relation relation)
Definition: inval.c:1270
int errmsg(const char *fmt,...)
Definition: elog.c:784
ObjectType get_relkind_objtype(char relkind)
#define SearchSysCacheCopy2(cacheId, key1, key2)
Definition: syscache.h:176
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
char * get_rel_name(Oid relid)
Definition: lsyscache.c:1730
#define RelationGetRelid(relation)
Definition: rel.h:419

◆ RenameRewriteRule()

ObjectAddress RenameRewriteRule ( RangeVar relation,
const char *  oldName,
const char *  newName 
)

Definition at line 947 of file rewriteDefine.c.

References AccessExclusiveLock, CacheInvalidateRelcache(), CatalogTupleUpdate(), CMD_SELECT, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg(), ERROR, GETSTRUCT, heap_freetuple(), HeapTupleIsValid, IsDefinedRewriteRule(), namestrcpy(), NoLock, ObjectAddressSet, ObjectIdGetDatum, PointerGetDatum, RangeVarCallbackForRenameRule(), RangeVarGetRelidExtended(), relation_close(), relation_open(), RelationGetRelationName, RowExclusiveLock, RULERELNAME, SearchSysCacheCopy2, HeapTupleData::t_self, table_close(), and table_open().

Referenced by ExecRenameStmt().

949 {
950  Oid relid;
951  Relation targetrel;
952  Relation pg_rewrite_desc;
953  HeapTuple ruletup;
954  Form_pg_rewrite ruleform;
955  Oid ruleOid;
956  ObjectAddress address;
957 
958  /*
959  * Look up name, check permissions, and acquire lock (which we will NOT
960  * release until end of transaction).
961  */
963  0,
965  NULL);
966 
967  /* Have lock already, so just need to build relcache entry. */
968  targetrel = relation_open(relid, NoLock);
969 
970  /* Prepare to modify pg_rewrite */
971  pg_rewrite_desc = table_open(RewriteRelationId, RowExclusiveLock);
972 
973  /* Fetch the rule's entry (it had better exist) */
975  ObjectIdGetDatum(relid),
976  PointerGetDatum(oldName));
977  if (!HeapTupleIsValid(ruletup))
978  ereport(ERROR,
979  (errcode(ERRCODE_UNDEFINED_OBJECT),
980  errmsg("rule \"%s\" for relation \"%s\" does not exist",
981  oldName, RelationGetRelationName(targetrel))));
982  ruleform = (Form_pg_rewrite) GETSTRUCT(ruletup);
983  ruleOid = ruleform->oid;
984 
985  /* rule with the new name should not already exist */
986  if (IsDefinedRewriteRule(relid, newName))
987  ereport(ERROR,
989  errmsg("rule \"%s\" for relation \"%s\" already exists",
990  newName, RelationGetRelationName(targetrel))));
991 
992  /*
993  * We disallow renaming ON SELECT rules, because they should always be
994  * named "_RETURN".
995  */
996  if (ruleform->ev_type == CMD_SELECT + '0')
997  ereport(ERROR,
998  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
999  errmsg("renaming an ON SELECT rule is not allowed")));
1000 
1001  /* OK, do the update */
1002  namestrcpy(&(ruleform->rulename), newName);
1003 
1004  CatalogTupleUpdate(pg_rewrite_desc, &ruletup->t_self, ruletup);
1005 
1006  heap_freetuple(ruletup);
1007  table_close(pg_rewrite_desc, RowExclusiveLock);
1008 
1009  /*
1010  * Invalidate relation's relcache entry so that other backends (and this
1011  * one too!) are sent SI message to make them rebuild relcache entries.
1012  * (Ideally this should happen automatically...)
1013  */
1014  CacheInvalidateRelcache(targetrel);
1015 
1016  ObjectAddressSet(address, RewriteRelationId, ruleOid);
1017 
1018  /*
1019  * Close rel, but keep exclusive lock!
1020  */
1021  relation_close(targetrel, NoLock);
1022 
1023  return address;
1024 }
bool IsDefinedRewriteRule(Oid owningRel, const char *ruleName)
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define PointerGetDatum(X)
Definition: postgres.h:556
int errcode(int sqlerrcode)
Definition: elog.c:570
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
unsigned int Oid
Definition: postgres_ext.h:31
int namestrcpy(Name name, const char *str)
Definition: name.c:250
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
ItemPointerData t_self
Definition: htup.h:65
#define NoLock
Definition: lockdefs.h:34
#define RowExclusiveLock
Definition: lockdefs.h:38
#define RelationGetRelationName(relation)
Definition: rel.h:453
Oid RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode, uint32 flags, RangeVarGetRelidCallback callback, void *callback_arg)
Definition: namespace.c:228
#define ereport(elevel, rest)
Definition: elog.h:141
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:206
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:224
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
FormData_pg_rewrite * Form_pg_rewrite
Definition: pg_rewrite.h:52
void CacheInvalidateRelcache(Relation relation)
Definition: inval.c:1270
#define AccessExclusiveLock
Definition: lockdefs.h:45
int errmsg(const char *fmt,...)
Definition: elog.c:784
static void RangeVarCallbackForRenameRule(const RangeVar *rv, Oid relid, Oid oldrelid, void *arg)
#define SearchSysCacheCopy2(cacheId, key1, key2)
Definition: syscache.h:176
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define ERRCODE_DUPLICATE_OBJECT
Definition: streamutil.c:33

◆ setRuleCheckAsUser()

void setRuleCheckAsUser ( Node node,
Oid  userid 
)

Definition at line 789 of file rewriteDefine.c.

References setRuleCheckAsUser_walker().

Referenced by get_row_security_policies(), and RelationBuildRuleLock().

790 {
791  (void) setRuleCheckAsUser_walker(node, &userid);
792 }
static bool setRuleCheckAsUser_walker(Node *node, Oid *context)