#include "nodes/primnodes.h"
#include "storage/lockdefs.h"
#include "utils/relcache.h"

Include dependency graph for relation.h:

This graph shows which files directly or indirectly include this file:

Functions
Relation	relation_open (Oid relationId, LOCKMODE lockmode)

Relation	try_relation_open (Oid relationId, LOCKMODE lockmode)

Relation	relation_openrv (const RangeVar *relation, LOCKMODE lockmode)

Relation	relation_openrv_extended (const RangeVar *relation, LOCKMODE lockmode, bool missing_ok)

void	relation_close (Relation relation, LOCKMODE lockmode)

Function Documentation

◆ relation_close()

void relation_close	(	Relation	relation,
		LOCKMODE	lockmode
	)

Definition at line 205 of file relation.c.

 {
     LockRelId   relid = relation->rd_lockInfo.lockRelId;
  
     Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);
  
     /* The relcache does the real work... */
     RelationClose(relation);
  
     if (lockmode != NoLock)
         UnlockRelationId(&relid, lockmode);
 }

References Assert, LockInfoData::lockRelId, MAX_LOCKMODES, NoLock, RelationData::rd_lockInfo, RelationClose(), and UnlockRelationId().

Referenced by AlterExtensionNamespace(), AlterObjectNamespace_oid(), AlterPolicy(), AlterSeqNamespaces(), AlterTableNamespace(), analyze_rel(), ATController(), ATExecAlterColumnType(), ATExecAttachPartitionIdx(), ATExecChangeOwner(), ATExecSetTableSpace(), ATPostAlterTypeParse(), ATPrepAlterColumnType(), ATPrepChangePersistence(), ATRewriteCatalogs(), ATSimpleRecursion(), ATTypedTableRecursion(), autoprewarm_database_main(), binary_upgrade_add_sub_rel_state(), brin_desummarize_range(), brin_summarize_range(), bt_metap(), bt_multi_page_stats(), bt_page_items_internal(), bt_page_stats_internal(), BuildEventTriggerCache(), calculate_indexes_size(), calculate_toast_table_size(), change_owner_recurse_to_sequences(), check_of_type(), CheckAttributeType(), cluster_rel(), collect_corrupt_items(), collect_visibility_data(), CommentObject(), CreatePolicy(), CreateStatistics(), dblink_build_sql_delete(), dblink_build_sql_insert(), dblink_build_sql_update(), dblink_get_pkey(), DefineRelation(), DefineVirtualRelation(), dropconstraint_internal(), ExecAlterExtensionContentsStmt(), ExecSecLabelStmt(), ExecuteTruncateGuts(), expandRelation(), find_composite_type_dependencies(), finish_heap_swap(), generate_partition_qual(), get_attr_stat_type(), get_object_address_attrdef(), get_object_address_attribute(), get_object_address_publication_rel(), get_partition_qual_relid(), get_raw_page_internal(), get_rels_with_domain(), get_tables_to_cluster(), gist_page_items(), heap_drop_with_catalog(), heap_force_common(), index_concurrently_swap(), IndexSetParentIndex(), load_typcache_tupdesc(), pg_freespace(), pg_get_expr_worker(), pg_get_object_address(), pg_indexes_size(), pg_prewarm(), pg_relation_size(), pg_relpages_impl(), pg_table_size(), pg_total_relation_size(), pg_truncate_visibility_map(), pg_visibility(), pg_visibility_map(), pg_visibility_map_summary(), pgstat_heap(), pgstat_index(), pgstatginindex_internal(), pgstatindex_impl(), pgstattuple_approx_internal(), process_owned_by(), relation_is_updatable(), RelationNameGetTupleDesc(), RemoveAttrDefaultById(), RemoveAttributeById(), rename_constraint_internal(), rename_policy(), renameatt_internal(), RenameRelationInternal(), RenameRewriteRule(), renametrig(), satisfies_hash_partition(), sequence_close(), set_relation_column_names(), stats_lock_check_privileges(), swap_relation_files(), table_close(), transformAlterTableStmt(), transformIndexConstraint(), tuple_data_split_internal(), vacuum_rel(), validatePartitionedIndex(), and verify_heapam().

◆ relation_open()

Relation relation_open	(	Oid	relationId,
		LOCKMODE	lockmode
	)

Definition at line 47 of file relation.c.

 {
     Relation    r;
  
     Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);
  
     /* Get the lock before trying to open the relcache entry */
     if (lockmode != NoLock)
         LockRelationOid(relationId, lockmode);
  
     /* The relcache does all the real work... */
     r = RelationIdGetRelation(relationId);
  
     if (!RelationIsValid(r))
         elog(ERROR, "could not open relation with OID %u", relationId);
  
     /*
      * If we didn't get the lock ourselves, assert that caller holds one,
      * except in bootstrap mode where no locks are used.
      */
     Assert(lockmode != NoLock ||
            IsBootstrapProcessingMode() ||
            CheckRelationLockedByMe(r, AccessShareLock, true));
  
     /* Make note that we've accessed a temporary relation */
     if (RelationUsesLocalBuffers(r))
         MyXactFlags |= XACT_FLAGS_ACCESSEDTEMPNAMESPACE;
  
     pgstat_init_relation(r);
  
     return r;
 }

References AccessShareLock, Assert, CheckRelationLockedByMe(), elog, ERROR, IsBootstrapProcessingMode, LockRelationOid(), MAX_LOCKMODES, MyXactFlags, NoLock, pgstat_init_relation(), RelationIdGetRelation(), RelationIsValid, RelationUsesLocalBuffers, and XACT_FLAGS_ACCESSEDTEMPNAMESPACE.

Referenced by AlterObjectNamespace_oid(), AlterPolicy(), AlterSeqNamespaces(), AlterTable(), AlterTableInternal(), AlterTableNamespace(), ATExecAttachPartitionIdx(), ATExecChangeOwner(), ATExecSetTableSpace(), ATPostAlterTypeParse(), ATPrepAlterColumnType(), ATPrepChangePersistence(), ATRewriteCatalogs(), ATSimpleRecursion(), ATTypedTableRecursion(), binary_upgrade_add_sub_rel_state(), bt_multi_page_stats(), BuildEventTriggerCache(), calculate_indexes_size(), calculate_toast_table_size(), change_owner_recurse_to_sequences(), check_of_type(), CheckAttributeType(), collect_corrupt_items(), collect_visibility_data(), CreatePolicy(), DefineRelation(), DefineVirtualRelation(), dropconstraint_internal(), EnableDisableTrigger(), ExecuteTruncateGuts(), expandRelation(), expandTableLikeClause(), find_composite_type_dependencies(), generate_partition_qual(), get_attr_stat_type(), get_partition_qual_relid(), get_rels_with_domain(), hash_bitmap_info(), heap_drop_with_catalog(), heap_force_common(), index_concurrently_swap(), index_open(), IndexSetParentIndex(), load_typcache_tupdesc(), pg_freespace(), pg_prewarm(), pg_relpagesbyid(), pg_relpagesbyid_v1_5(), pg_truncate_visibility_map(), pg_visibility(), pg_visibility_map(), pg_visibility_map_summary(), pgstatginindex_internal(), pgstathashindex(), pgstatindexbyid(), pgstatindexbyid_v1_5(), pgstattuple_approx_internal(), pgstattuplebyid(), pgstattuplebyid_v1_5(), relation_openrv(), relation_openrv_extended(), RemoveAttrDefaultById(), RemoveAttributeById(), rename_constraint_internal(), rename_policy(), renameatt_internal(), RenameRelationInternal(), RenameRewriteRule(), renametrig(), satisfies_hash_partition(), sequence_open(), set_relation_column_names(), stats_lock_check_privileges(), swap_relation_files(), table_open(), transformAlterTableStmt(), transformIndexStmt(), transformStatsStmt(), tuple_data_split_internal(), validatePartitionedIndex(), and verify_heapam().

◆ relation_openrv()

Relation relation_openrv	(	const RangeVar *	relation,
		LOCKMODE	lockmode
	)

Definition at line 137 of file relation.c.

 {
     Oid         relOid;
  
     /*
      * Check for shared-cache-inval messages before trying to open the
      * relation.  This is needed even if we already hold a lock on the
      * relation, because GRANT/REVOKE are executed without taking any lock on
      * the target relation, and we want to be sure we see current ACL
      * information.  We can skip this if asked for NoLock, on the assumption
      * that such a call is not the first one in the current command, and so we
      * should be reasonably up-to-date already.  (XXX this all could stand to
      * be redesigned, but for the moment we'll keep doing this like it's been
      * done historically.)
      */
     if (lockmode != NoLock)
         AcceptInvalidationMessages();
  
     /* Look up and lock the appropriate relation using namespace search */
     relOid = RangeVarGetRelid(relation, lockmode, false);
  
     /* Let relation_open do the rest */
     return relation_open(relOid, NoLock);
 }

References AcceptInvalidationMessages(), NoLock, RangeVarGetRelid, and relation_open().

Referenced by bt_metap(), bt_multi_page_stats(), bt_page_items_internal(), bt_page_stats_internal(), CreateStatistics(), expandTableLikeClause(), get_object_address_attrdef(), get_object_address_attribute(), get_raw_page_internal(), pg_relpages(), pg_relpages_v1_5(), pgrowlocks(), pgstatindex(), pgstatindex_v1_5(), pgstattuple(), pgstattuple_v1_5(), process_owned_by(), RelationNameGetTupleDesc(), table_openrv(), and transformTableLikeClause().

◆ relation_openrv_extended()

Relation relation_openrv_extended	(	const RangeVar *	relation,
		LOCKMODE	lockmode,
		bool	missing_ok
	)

Definition at line 172 of file relation.c.

 {
     Oid         relOid;
  
     /*
      * Check for shared-cache-inval messages before trying to open the
      * relation.  See comments in relation_openrv().
      */
     if (lockmode != NoLock)
         AcceptInvalidationMessages();
  
     /* Look up and lock the appropriate relation using namespace search */
     relOid = RangeVarGetRelid(relation, lockmode, missing_ok);
  
     /* Return NULL on not-found */
     if (!OidIsValid(relOid))
         return NULL;
  
     /* Let relation_open do the rest */
     return relation_open(relOid, NoLock);
 }

References AcceptInvalidationMessages(), NoLock, OidIsValid, RangeVarGetRelid, and relation_open().

Referenced by get_object_address_publication_rel(), get_relation_by_qualified_name(), and table_openrv_extended().

◆ try_relation_open()

Relation try_relation_open	(	Oid	relationId,
		LOCKMODE	lockmode
	)

Definition at line 88 of file relation.c.

 {
     Relation    r;
  
     Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);
  
     /* Get the lock first */
     if (lockmode != NoLock)
         LockRelationOid(relationId, lockmode);
  
     /*
      * Now that we have the lock, probe to see if the relation really exists
      * or not.
      */
     if (!SearchSysCacheExists1(RELOID, ObjectIdGetDatum(relationId)))
     {
         /* Release useless lock */
         if (lockmode != NoLock)
             UnlockRelationOid(relationId, lockmode);
  
         return NULL;
     }
  
     /* Should be safe to do a relcache load */
     r = RelationIdGetRelation(relationId);
  
     if (!RelationIsValid(r))
         elog(ERROR, "could not open relation with OID %u", relationId);
  
     /* If we didn't get the lock ourselves, assert that caller holds one */
     Assert(lockmode != NoLock ||
            CheckRelationLockedByMe(r, AccessShareLock, true));
  
     /* Make note that we've accessed a temporary relation */
     if (RelationUsesLocalBuffers(r))
         MyXactFlags |= XACT_FLAGS_ACCESSEDTEMPNAMESPACE;
  
     pgstat_init_relation(r);
  
     return r;
 }

References AccessShareLock, Assert, CheckRelationLockedByMe(), elog, ERROR, LockRelationOid(), MAX_LOCKMODES, MyXactFlags, NoLock, ObjectIdGetDatum(), pgstat_init_relation(), RelationIdGetRelation(), RelationIsValid, RelationUsesLocalBuffers, SearchSysCacheExists1, UnlockRelationOid(), and XACT_FLAGS_ACCESSEDTEMPNAMESPACE.