海山数据库(He3DB)源码解读：T_DropRoleSetStmt原理浅析

一、概述

   DropRoleStmt 表示删除角色的 DDL 语句。。

二、DropRole 命令的执行流程

1. PostgresMain
2. exec_simple_query →执行简单的 SQL 查询;
3. StartTransactionCommand → 开始事务;
4. pg_parse_query →解析为内部的抽象语法树（AST）；
5. PortalRun
6. standard_ProcessUtility →权限检查和准备；
7. DropRole→删除角色；
8. CommandCounterIncrement→增量更新当前的命令计数器；
9. CommitTransactionCommand→ 提交当前事务；
10. finish_xact_command→ 在事务结束时，执行必要的清理和关闭操作；

图1 DropRole命令的执行流程图

三、核心结构体介绍

 (一)  DropRoleStmt 是一个结构体，定义在 He3DB中，用于表示删除角色的 SQL 命令。下面是对这个结构体中各个字段的详细解释：

typedef struct DropRoleStmt
{NodeTag		type;List	   *roles;			/* List of roles to remove */bool		missing_ok;		/* skip error if a role is missing? */
} DropRoleStmt;

NodeTag type;
这是一个枚举类型，表示节点类型。NodeTag 通常用于区分不同的 SQL 语句类型或查询树中的不同节点类型。对于 DropRoleStmt，这个字段通常会被设置为 T_DropRoleStmt，表示这是一个删除角色的语句。

List *roles;
这是一个链表（List），包含了要删除的角色的名称列表。每个角色名称通常是一个字符串（char *），表示要删除的角色。List 是一个在He3DB内部使用的链表结构，用于存储一组相关的数据。

bool missing_ok;
这是一个布尔类型（bool），表示在尝试删除不存在的角色时是否忽略错误。如果设置为 true，当某个角色不存在时，系统不会抛出错误，而是继续执行操作；如果设置为 false，当某个角色不存在时，系统会抛出一个错误并停止执行。

四、核心代码解析

   在 He3DB 的源代码中， DropRole（@src\backend\commands\user.c） 用于删除数据库角色的函数 。它处理了从数据库中删除角色的各种步骤，包括权限检查、元组删除、依赖关系检查等。

void DropRole(DropRoleStmt *stmt)

定义了一个名为 DropRole 的函数，该函数接受一个 DropRoleStmt 类型的指针作为参数。

  // 定义两个关系变量，用于打开两个系统目录表：pg_authid 和 pg_auth_membersRelation    pg_authid_rel,pg_auth_members_rel;

声明了两个 Relation 类型的变量，分别用于操作 pg_authid 和 pg_auth_members 系统目录表。

   // 定义一个列表单元变量，用于遍历 `stmt->roles` 列表ListCell   *item = NULL;

声明了一个 ListCell 类型的指针变量 item，用于遍历 stmt->roles 列表。

   // 检查当前用户是否有创建角色的权限，如果没有则抛出错误if (!have_createrole_privilege())ereport(ERROR,(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),errmsg("permission denied to drop role")));

检查当前用户是否具有创建角色的权限，如果没有，则抛出错误并中止操作。

   // 打开 pg_authid 和 pg_auth_members 表，获取行独占锁pg_authid_rel = table_open(AuthIdRelationId, RowExclusiveLock);pg_auth_members_rel = table_open(AuthMemRelationId, RowExclusiveLock);

打开 pg_authid 和 pg_auth_members 表，并获取行独占锁，以防止其他操作修改这些表。

   // 遍历 `stmt->roles` 列表中的每一个角色foreach(item, stmt->roles){RoleSpec   *rolspec = lfirst(item);char       *role = NULL;HeapTuple  tuple,tmp_tuple;Form_pg_authid roleform;ScanKeyData scankey;char       *detail = NULL;char       *detail_log = NULL;SysScanDesc sscan;Oid         roleid = 0;

开始遍历 stmt->roles 列表中的每一个角色。声明了一系列变量，用于处理每个角色的删除操作。

       // 检查角色规范类型，如果不是 ROLESPEC_CSTRING 则抛出错误if (rolspec->roletype != ROLESPEC_CSTRING)ereport(ERROR,(errcode(ERRCODE_INVALID_PARAMETER_VALUE),errmsg("cannot use special role specifier in DROP ROLE")));role = rolspec->rolename;

检查角色规范类型是否为 ROLESPEC_CSTRING，如果不是，则抛出错误。

        // 从 pg_authid 缓存中查找角色元组tuple = SearchSysCache1(AUTHNAME, PointerGetDatum(role));if (!HeapTupleIsValid(tuple)){// 如果角色不存在，并且不允许忽略缺失的角色，则抛出错误if (!stmt->missing_ok){ereport(ERROR,(errcode(ERRCODE_UNDEFINED_OBJECT),errmsg("role \"%s\" does not exist", role)));}else{// 如果角色不存在，但允许忽略，则发出通知并跳过ereport(NOTICE,(errmsg("role \"%s\" does not exist, skipping",role)));}continue;}

从 pg_authid 缓存中查找角色元组。如果角色不存在，并且不允许忽略缺失的角色，则抛出错误；否则发出通知并跳过该角色。

     // 获取角色的 OIDroleform = (Form_pg_authid) GETSTRUCT(tuple);roleid = roleform->oid;
解析：获取角色的 OID。// 检查是否尝试删除当前用户或会话用户if (roleid == GetUserId())ereport(ERROR,(errcode(ERRCODE_OBJECT_IN_USE),errmsg("current user cannot be dropped")));if (roleid == GetOuterUserId())ereport(ERROR,(errcode(ERRCODE_OBJECT_IN_USE),errmsg("current user cannot be dropped")));if (roleid == GetSessionUserId())ereport(ERROR,(errcode(ERRCODE_OBJECT_IN_USE),errmsg("session user cannot be dropped")));

检查是否尝试删除当前用户或会话用户，如果是，则抛出错误。

// 检查是否有权限删除超级用户角色if (roleform->rolsuper && !superuser())ereport(ERROR,(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),errmsg("must be superuser to drop superusers")));

检查是否有权限删除超级用户角色，如果没有，则抛出错误。

       // 调用删除钩子，通知系统角色正在被删除InvokeObjectDropHook(AuthIdRelationId, roleid, 0);

调用删除钩子，通知系统角色正在被删除。

       // 锁住角色，防止在删除过程中有新的依赖关系添加LockSharedObject(AuthIdRelationId, roleid, 0, AccessExclusiveLock);

锁住角色，防止在删除过程中有新的依赖关系添加。

       // 检查是否有其他对象依赖于此角色if (checkSharedDependencies(AuthIdRelationId, roleid,&detail, &detail_log))ereport(ERROR,(errcode(ERRCODE_DEPENDENT_OBJECTS_STILL_EXIST),errmsg("role \"%s\" cannot be dropped because some objects depend on it",role),errdetail_internal("%s", detail),errdetail_log("%s", detail_log)));

检查是否有其他对象依赖于此角色，如果有，则抛出错误。

       // 从 pg_authid 表中删除角色元组CatalogTupleDelete(pg_authid_rel, &tuple->t_self);

从 pg_authid 表中删除角色元组。

       // 释放缓存中的元组ReleaseSysCache(tuple);

释放缓存中的元组。

       // 初始化扫描键，准备扫描 pg_auth_members 表中角色相关的元组ScanKeyInit(&scankey,Anum_pg_auth_members_roleid,BTEqualStrategyNumber, F_OIDEQ,ObjectIdGetDatum(roleid));

初始化扫描键，准备扫描 pg_auth_members 表中角色相关的元组。

       // 开始扫描 pg_auth_members 表sscan = systable_beginscan(pg_auth_members_rel, AuthMemRoleMemIndexId,true, NULL, 1, &scankey);

开始扫描 pg_auth_members 表。

       // 遍历并删除所有与角色相关的元组while (HeapTupleIsValid(tmp_tuple = systable_getnext(sscan))){CatalogTupleDelete(pg_auth_members_rel, &tmp_tuple->t_self);}

遍历并删除所有与角色相关的元组。

       // 结束扫描systable_endscan(sscan);

结束扫描。

       // 初始化扫描键，准备扫描 pg_auth_members 表中成员相关的元组ScanKeyInit(&scankey,Anum_pg_auth_members_member,BTEqualStrategyNumber, F_OIDEQ,ObjectIdGetDatum(roleid));

初始化扫描键，准备扫描 pg_auth_members 表中成员相关的元组。

       // 开始扫描 pg_auth_members 表sscan = systable_beginscan(pg_auth_members_rel, AuthMemMemRoleIndexId,true, NULL, 1, &scankey);  

开始扫描 pg_auth_members 表。

       // 遍历并删除所有与成员相关的元组while (HeapTupleIsValid(tmp_tuple = systable_getnext(sscan))){CatalogTupleDelete(pg_auth_members_rel, &tmp_tuple->t_self);}

遍历并删除所有与成员相关的元组。

       // 结束扫描systable_endscan(sscan);

结束扫描。

       // 删除角色的注释和安全标签DeleteSharedComments(roleid, AuthIdRelationId);DeleteSharedSecurityLabel(roleid, AuthIdRelationId);

删除角色的注释和安全标签。

       // 删除角色的设置DropSetting(InvalidOid, roleid);

删除角色的设置。

       // 增加命令计数器，确保后续操作能看到已做的更改CommandCounterIncrement();

增加命令计数器，确保后续操作能看到已做的更改。

  // 关闭打开的表table_close(pg_authid_rel, NoLock);table_close(pg_auth_members_rel, NoLock);

关闭打开的表。

    DropSetting，用于从系统目录中删除特定的设置。这些设置可以与某个特定的数据库或角色相关。以下是对每行代码的逐步分析：

void DropSetting(Oid databaseid, Oid roleid)

函数定义，接受两个参数，databaseid 和 roleid，它们的类型是 Oid（对象标识符）。这两个参数指明要删除的设置是与哪个数据库或角色相关。

   Relation	relsetting;TableScanDesc scan;ScanKeyData keys[2] = {0};HeapTuple	tup;int			numkeys = 0;

定义一个 Relation 类型的变量 relsetting，用于表示数据库中要操作的表（或关系）。
定义一个 TableScanDesc 类型的变量 scan，用于描述对表的扫描操作。
定义一个长度为2的 ScanKeyData 数组 keys，并初始化为0。这个数组用于存储扫描所需的键（过滤条件）。
定义一个 HeapTuple 类型的变量 tup，用于存储从表中扫描到的元组。
定义一个整型变量 numkeys，初始化为0，用于记录有效的扫描键的数量。

   relsetting = table_open(DbRoleSettingRelationId, RowExclusiveLock);

使用 table_open 函数打开系统目录中存储角色设置的表（DbRoleSettingRelationId 是对应表的 OID），并获取一个行级独占锁 RowExclusiveLock，返回的 Relation 对象保存在 relsetting 中。

   if (OidIsValid(databaseid)){

检查 databaseid 是否有效（即是否为有效的 OID）。如果有效，继续执行后续代码。

   	ScanKeyInit(&keys[numkeys],Anum_pg_db_role_setting_setdatabase,BTEqualStrategyNumber,F_OIDEQ,ObjectIdGetDatum(databaseid));numkeys++;}

使用 ScanKeyInit 初始化第一个扫描键。这指定了过滤条件为 pg_db_role_setting 表中的 setdatabase 列，使用等值比较策略 BTEqualStrategyNumber，比较函数 F_OIDEQ，并将 databaseid 转换为 Datum 类型。之后，numkeys 增加1，即有效键的数量加1。

   if (OidIsValid(roleid)){

检查 roleid 是否有效。如果有效，继续执行后续代码。

   	ScanKeyInit(&keys[numkeys],Anum_pg_db_role_setting_setrole,BTEqualStrategyNumber,F_OIDEQ,ObjectIdGetDatum(roleid));numkeys++;}

类似地，初始化第二个扫描键，用于过滤 setrole 列的条件。将 roleid 转换为 Datum，并更新有效键的数量 numkeys。

   scan = table_beginscan_catalog(relsetting, numkeys, keys);

调用 table_beginscan_catalog 函数开始扫描 relsetting 表，使用之前定义的扫描键和数量 numkeys，返回的扫描描述符保存在 scan 中。

   while (HeapTupleIsValid(tup = heap_getnext(scan, ForwardScanDirection)))

使用 heap_getnext 从扫描中获取下一个有效的元组。ForwardScanDirection 表示以向前的方式扫描。如果 tup 是有效的元组，就进入循环。

   {CatalogTupleDelete(relsetting, &tup->t_self);}

对于每个有效的 tup，调用 CatalogTupleDelete 函数，从 relsetting 表中删除该元组（即删除对应的设置）。

	table_endscan(scan);

结束对表的扫描，释放相关资源。

	table_close(relsetting, RowExclusiveLock);
}

关闭表并释放行级独占锁。至此，函数结束。