pg_db_role_setting.h File Reference

#include "catalog/genbki.h"
#include "catalog/pg_db_role_setting_d.h"
#include "utils/guc.h"
#include "utils/relcache.h"
#include "utils/snapshot.h"

Include dependency graph for pg_db_role_setting.h:

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

Go to the source code of this file.

Macros
#define	PgDbRoleSettingToastTable   2966
#define	PgDbRoleSettingToastIndex   2967
#define	DbRoleSettingDatidRolidIndexId   2965

Typedefs
typedef FormData_pg_db_role_setting *	Form_pg_db_role_setting

Functions
	CATALOG (pg_db_role_setting, 2964, DbRoleSettingRelationId) BKI_SHARED_RELATION
	DECLARE_TOAST (pg_db_role_setting, 2966, 2967)
	DECLARE_UNIQUE_INDEX_PKEY (pg_db_role_setting_databaseid_rol_index, 2965, on pg_db_role_setting using btree(setdatabase oid_ops, setrole oid_ops))
void	AlterSetting (Oid databaseid, Oid roleid, VariableSetStmt *setstmt)
void	DropSetting (Oid databaseid, Oid roleid)
void	ApplySetting (Snapshot snapshot, Oid databaseid, Oid roleid, Relation relsetting, GucSource source)

Variables
	FormData_pg_db_role_setting

Macro Definition Documentation

DbRoleSettingDatidRolidIndexId

#define DbRoleSettingDatidRolidIndexId   2965

Definition at line 54 of file pg_db_role_setting.h.

Referenced by AlterSetting(), ApplySetting(), and IsSharedRelation().

PgDbRoleSettingToastIndex

#define PgDbRoleSettingToastIndex   2967

Definition at line 51 of file pg_db_role_setting.h.

Referenced by IsSharedRelation().

PgDbRoleSettingToastTable

#define PgDbRoleSettingToastTable   2966

Definition at line 50 of file pg_db_role_setting.h.

Referenced by IsSharedRelation().

Typedef Documentation

Form_pg_db_role_setting

typedef FormData_pg_db_role_setting* Form_pg_db_role_setting

Definition at line 47 of file pg_db_role_setting.h.

Function Documentation

AlterSetting()

void AlterSetting	(	Oid	databaseid,
		Oid	roleid,
		VariableSetStmt *	setstmt
	)

Definition at line 24 of file pg_db_role_setting.c.

References BTEqualStrategyNumber, CatalogTupleDelete(), CatalogTupleInsert(), CatalogTupleUpdate(), DatumGetArrayTypeP, DbRoleSettingDatidRolidIndexId, ExtractSetVariableArgs(), GUCArrayAdd(), GUCArrayDelete(), GUCArrayReset(), heap_form_tuple(), heap_getattr, heap_modify_tuple(), HeapTupleIsValid, InvokeObjectPostAlterHookArg, VariableSetStmt::kind, VariableSetStmt::name, NoLock, ObjectIdGetDatum, PointerGetDatum, RelationGetDescr, RowExclusiveLock, ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), HeapTupleData::t_self, table_close(), table_open(), values, and VAR_RESET_ALL.

Referenced by AlterDatabaseSet(), and AlterRoleSet().

{
    char       *valuestr;
    HeapTuple   tuple;
    Relation    rel;
    ScanKeyData scankey[2];
    SysScanDesc scan;

    valuestr = ExtractSetVariableArgs(setstmt);

    /* Get the old tuple, if any. */

    rel = table_open(DbRoleSettingRelationId, RowExclusiveLock);
    ScanKeyInit(&scankey[0],
                Anum_pg_db_role_setting_setdatabase,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(databaseid));
    ScanKeyInit(&scankey[1],
                Anum_pg_db_role_setting_setrole,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(roleid));
    scan = systable_beginscan(rel, DbRoleSettingDatidRolidIndexId, true,
                              NULL, 2, scankey);
    tuple = systable_getnext(scan);

    /*
     * There are three cases:
     *
     * - in RESET ALL, request GUC to reset the settings array and update the
     * catalog if there's anything left, delete it otherwise
     *
     * - in other commands, if there's a tuple in pg_db_role_setting, update
     * it; if it ends up empty, delete it
     *
     * - otherwise, insert a new pg_db_role_setting tuple, but only if the
     * command is not RESET
     */
    if (setstmt->kind == VAR_RESET_ALL)
    {
        if (HeapTupleIsValid(tuple))
        {
            ArrayType  *new = NULL;
            Datum       datum;
            bool        isnull;

            datum = heap_getattr(tuple, Anum_pg_db_role_setting_setconfig,
                                 RelationGetDescr(rel), &isnull);

            if (!isnull)
                new = GUCArrayReset(DatumGetArrayTypeP(datum));

            if (new)
            {
                Datum       repl_val[Natts_pg_db_role_setting];
                bool        repl_null[Natts_pg_db_role_setting];
                bool        repl_repl[Natts_pg_db_role_setting];
                HeapTuple   newtuple;

                memset(repl_repl, false, sizeof(repl_repl));

                repl_val[Anum_pg_db_role_setting_setconfig - 1] =
                    PointerGetDatum(new);
                repl_repl[Anum_pg_db_role_setting_setconfig - 1] = true;
                repl_null[Anum_pg_db_role_setting_setconfig - 1] = false;

                newtuple = heap_modify_tuple(tuple, RelationGetDescr(rel),
                                             repl_val, repl_null, repl_repl);
                CatalogTupleUpdate(rel, &tuple->t_self, newtuple);
            }
            else
                CatalogTupleDelete(rel, &tuple->t_self);
        }
    }
    else if (HeapTupleIsValid(tuple))
    {
        Datum       repl_val[Natts_pg_db_role_setting];
        bool        repl_null[Natts_pg_db_role_setting];
        bool        repl_repl[Natts_pg_db_role_setting];
        HeapTuple   newtuple;
        Datum       datum;
        bool        isnull;
        ArrayType  *a;

        memset(repl_repl, false, sizeof(repl_repl));
        repl_repl[Anum_pg_db_role_setting_setconfig - 1] = true;
        repl_null[Anum_pg_db_role_setting_setconfig - 1] = false;

        /* Extract old value of setconfig */
        datum = heap_getattr(tuple, Anum_pg_db_role_setting_setconfig,
                             RelationGetDescr(rel), &isnull);
        a = isnull ? NULL : DatumGetArrayTypeP(datum);

        /* Update (valuestr is NULL in RESET cases) */
        if (valuestr)
            a = GUCArrayAdd(a, setstmt->name, valuestr);
        else
            a = GUCArrayDelete(a, setstmt->name);

        if (a)
        {
            repl_val[Anum_pg_db_role_setting_setconfig - 1] =
                PointerGetDatum(a);

            newtuple = heap_modify_tuple(tuple, RelationGetDescr(rel),
                                         repl_val, repl_null, repl_repl);
            CatalogTupleUpdate(rel, &tuple->t_self, newtuple);
        }
        else
            CatalogTupleDelete(rel, &tuple->t_self);
    }
    else if (valuestr)
    {
        /* non-null valuestr means it's not RESET, so insert a new tuple */
        HeapTuple   newtuple;
        Datum       values[Natts_pg_db_role_setting];
        bool        nulls[Natts_pg_db_role_setting];
        ArrayType  *a;

        memset(nulls, false, sizeof(nulls));

        a = GUCArrayAdd(NULL, setstmt->name, valuestr);

        values[Anum_pg_db_role_setting_setdatabase - 1] =
            ObjectIdGetDatum(databaseid);
        values[Anum_pg_db_role_setting_setrole - 1] = ObjectIdGetDatum(roleid);
        values[Anum_pg_db_role_setting_setconfig - 1] = PointerGetDatum(a);
        newtuple = heap_form_tuple(RelationGetDescr(rel), values, nulls);

        CatalogTupleInsert(rel, newtuple);
    }

    InvokeObjectPostAlterHookArg(DbRoleSettingRelationId,
                                 databaseid, 0, roleid, false);

    systable_endscan(scan);

    /* Close pg_db_role_setting, but keep lock till commit */
    table_close(rel, NoLock);
}

ApplySetting()

void ApplySetting	(	Snapshot	snapshot,
		Oid	databaseid,
		Oid	roleid,
		Relation	relsetting,
		GucSource	source
	)

Definition at line 220 of file pg_db_role_setting.c.

References BTEqualStrategyNumber, DatumGetArrayTypeP, DbRoleSettingDatidRolidIndexId, GUC_ACTION_SET, heap_getattr, HeapTupleIsValid, ObjectIdGetDatum, PGC_SUSET, ProcessGUCArray(), RelationGetDescr, ScanKeyInit(), systable_beginscan(), systable_endscan(), and systable_getnext().

Referenced by process_settings().

{
    SysScanDesc scan;
    ScanKeyData keys[2];
    HeapTuple   tup;

    ScanKeyInit(&keys[0],
                Anum_pg_db_role_setting_setdatabase,
                BTEqualStrategyNumber,
                F_OIDEQ,
                ObjectIdGetDatum(databaseid));
    ScanKeyInit(&keys[1],
                Anum_pg_db_role_setting_setrole,
                BTEqualStrategyNumber,
                F_OIDEQ,
                ObjectIdGetDatum(roleid));

    scan = systable_beginscan(relsetting, DbRoleSettingDatidRolidIndexId, true,
                              snapshot, 2, keys);
    while (HeapTupleIsValid(tup = systable_getnext(scan)))
    {
        bool        isnull;
        Datum       datum;

        datum = heap_getattr(tup, Anum_pg_db_role_setting_setconfig,
                             RelationGetDescr(relsetting), &isnull);
        if (!isnull)
        {
            ArrayType  *a = DatumGetArrayTypeP(datum);

            /*
             * We process all the options at SUSET level.  We assume that the
             * right to insert an option into pg_db_role_setting was checked
             * when it was inserted.
             */
            ProcessGUCArray(a, PGC_SUSET, source, GUC_ACTION_SET);
        }
    }

    systable_endscan(scan);
}

CATALOG()

CATALOG	(	pg_db_role_setting	,
		2964	,
		DbRoleSettingRelationId
	)

Definition at line 34 of file pg_db_role_setting.h.

References BKI_LOOKUP_OPT.

{
    /* database, or 0 for a role-specific setting */
    Oid         setdatabase BKI_LOOKUP_OPT(pg_database);

    /* role, or 0 for a database-specific setting */
    Oid         setrole BKI_LOOKUP_OPT(pg_authid);

#ifdef CATALOG_VARLEN           /* variable-length fields start here */
    text        setconfig[1];   /* GUC settings to apply at login */
#endif
} FormData_pg_db_role_setting;

DECLARE_TOAST()

DECLARE_TOAST	(	pg_db_role_setting	,
		2966	,
		2967
	)

DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY	(	pg_db_role_setting_databaseid_rol_index	,
		2965	,
		on pg_db_role_setting using	btreesetdatabase oid_ops, setrole oid_ops
	)

DropSetting()

void DropSetting	(	Oid	databaseid,
		Oid	roleid
	)

Definition at line 170 of file pg_db_role_setting.c.

References BTEqualStrategyNumber, CatalogTupleDelete(), ForwardScanDirection, heap_getnext(), HeapTupleIsValid, ObjectIdGetDatum, OidIsValid, RowExclusiveLock, ScanKeyInit(), HeapTupleData::t_self, table_beginscan_catalog(), table_close(), table_endscan(), and table_open().

Referenced by dropdb(), and DropRole().

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

    relsetting = table_open(DbRoleSettingRelationId, RowExclusiveLock);

    if (OidIsValid(databaseid))
    {
        ScanKeyInit(&keys[numkeys],
                    Anum_pg_db_role_setting_setdatabase,
                    BTEqualStrategyNumber,
                    F_OIDEQ,
                    ObjectIdGetDatum(databaseid));
        numkeys++;
    }
    if (OidIsValid(roleid))
    {
        ScanKeyInit(&keys[numkeys],
                    Anum_pg_db_role_setting_setrole,
                    BTEqualStrategyNumber,
                    F_OIDEQ,
                    ObjectIdGetDatum(roleid));
        numkeys++;
    }

    scan = table_beginscan_catalog(relsetting, numkeys, keys);
    while (HeapTupleIsValid(tup = heap_getnext(scan, ForwardScanDirection)))
    {
        CatalogTupleDelete(relsetting, &tup->t_self);
    }
    table_endscan(scan);

    table_close(relsetting, RowExclusiveLock);
}

Variable Documentation

FormData_pg_db_role_setting

FormData_pg_db_role_setting

Definition at line 45 of file pg_db_role_setting.h.