PostgreSQL Source Code git master
Typedefs | Functions | Variables
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.

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_WITH_MACRO (pg_db_role_setting, 2966, 2967, PgDbRoleSettingToastTable, PgDbRoleSettingToastIndex)
 
 DECLARE_UNIQUE_INDEX_PKEY (pg_db_role_setting_databaseid_rol_index, 2965, DbRoleSettingDatidRolidIndexId, pg_db_role_setting, 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
 

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.

25{
26 char *valuestr;
27 HeapTuple tuple;
28 Relation rel;
29 ScanKeyData scankey[2];
30 SysScanDesc scan;
31
32 valuestr = ExtractSetVariableArgs(setstmt);
33
34 /* Get the old tuple, if any. */
35
36 rel = table_open(DbRoleSettingRelationId, RowExclusiveLock);
37 ScanKeyInit(&scankey[0],
38 Anum_pg_db_role_setting_setdatabase,
39 BTEqualStrategyNumber, F_OIDEQ,
40 ObjectIdGetDatum(databaseid));
41 ScanKeyInit(&scankey[1],
42 Anum_pg_db_role_setting_setrole,
43 BTEqualStrategyNumber, F_OIDEQ,
44 ObjectIdGetDatum(roleid));
45 scan = systable_beginscan(rel, DbRoleSettingDatidRolidIndexId, true,
46 NULL, 2, scankey);
47 tuple = systable_getnext(scan);
48
49 /*
50 * There are three cases:
51 *
52 * - in RESET ALL, request GUC to reset the settings array and update the
53 * catalog if there's anything left, delete it otherwise
54 *
55 * - in other commands, if there's a tuple in pg_db_role_setting, update
56 * it; if it ends up empty, delete it
57 *
58 * - otherwise, insert a new pg_db_role_setting tuple, but only if the
59 * command is not RESET
60 */
61 if (setstmt->kind == VAR_RESET_ALL)
62 {
63 if (HeapTupleIsValid(tuple))
64 {
65 ArrayType *new = NULL;
66 Datum datum;
67 bool isnull;
68
69 datum = heap_getattr(tuple, Anum_pg_db_role_setting_setconfig,
70 RelationGetDescr(rel), &isnull);
71
72 if (!isnull)
73 new = GUCArrayReset(DatumGetArrayTypeP(datum));
74
75 if (new)
76 {
77 Datum repl_val[Natts_pg_db_role_setting];
78 bool repl_null[Natts_pg_db_role_setting];
79 bool repl_repl[Natts_pg_db_role_setting];
80 HeapTuple newtuple;
81
82 memset(repl_repl, false, sizeof(repl_repl));
83
84 repl_val[Anum_pg_db_role_setting_setconfig - 1] =
85 PointerGetDatum(new);
86 repl_repl[Anum_pg_db_role_setting_setconfig - 1] = true;
87 repl_null[Anum_pg_db_role_setting_setconfig - 1] = false;
88
89 newtuple = heap_modify_tuple(tuple, RelationGetDescr(rel),
90 repl_val, repl_null, repl_repl);
91 CatalogTupleUpdate(rel, &tuple->t_self, newtuple);
92 }
93 else
94 CatalogTupleDelete(rel, &tuple->t_self);
95 }
96 }
97 else if (HeapTupleIsValid(tuple))
98 {
99 Datum repl_val[Natts_pg_db_role_setting];
100 bool repl_null[Natts_pg_db_role_setting];
101 bool repl_repl[Natts_pg_db_role_setting];
102 HeapTuple newtuple;
103 Datum datum;
104 bool isnull;
105 ArrayType *a;
106
107 memset(repl_repl, false, sizeof(repl_repl));
108 repl_repl[Anum_pg_db_role_setting_setconfig - 1] = true;
109 repl_null[Anum_pg_db_role_setting_setconfig - 1] = false;
110
111 /* Extract old value of setconfig */
112 datum = heap_getattr(tuple, Anum_pg_db_role_setting_setconfig,
113 RelationGetDescr(rel), &isnull);
114 a = isnull ? NULL : DatumGetArrayTypeP(datum);
115
116 /* Update (valuestr is NULL in RESET cases) */
117 if (valuestr)
118 a = GUCArrayAdd(a, setstmt->name, valuestr);
119 else
120 a = GUCArrayDelete(a, setstmt->name);
121
122 if (a)
123 {
124 repl_val[Anum_pg_db_role_setting_setconfig - 1] =
125 PointerGetDatum(a);
126
127 newtuple = heap_modify_tuple(tuple, RelationGetDescr(rel),
128 repl_val, repl_null, repl_repl);
129 CatalogTupleUpdate(rel, &tuple->t_self, newtuple);
130 }
131 else
132 CatalogTupleDelete(rel, &tuple->t_self);
133 }
134 else if (valuestr)
135 {
136 /* non-null valuestr means it's not RESET, so insert a new tuple */
137 HeapTuple newtuple;
138 Datum values[Natts_pg_db_role_setting];
139 bool nulls[Natts_pg_db_role_setting];
140 ArrayType *a;
141
142 memset(nulls, false, sizeof(nulls));
143
144 a = GUCArrayAdd(NULL, setstmt->name, valuestr);
145
146 values[Anum_pg_db_role_setting_setdatabase - 1] =
147 ObjectIdGetDatum(databaseid);
148 values[Anum_pg_db_role_setting_setrole - 1] = ObjectIdGetDatum(roleid);
149 values[Anum_pg_db_role_setting_setconfig - 1] = PointerGetDatum(a);
150 newtuple = heap_form_tuple(RelationGetDescr(rel), values, nulls);
151
152 CatalogTupleInsert(rel, newtuple);
153 }
154 else
155 {
156 /*
157 * RESET doesn't need to change any state if there's no pre-existing
158 * pg_db_role_setting entry, but for consistency we should still check
159 * that the option is valid and we're allowed to set it.
160 */
161 (void) GUCArrayDelete(NULL, setstmt->name);
162 }
163
164 InvokeObjectPostAlterHookArg(DbRoleSettingRelationId,
165 databaseid, 0, roleid, false);
166
167 systable_endscan(scan);
168
169 /* Close pg_db_role_setting, but keep lock till commit */
170 table_close(rel, NoLock);
171}
DatumGetArrayTypeP
#define DatumGetArrayTypeP(X)
Definition: array.h:261
values
static Datum values[MAXATTR]
Definition: bootstrap.c:153
systable_endscan
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:603
systable_getnext
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:514
systable_beginscan
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:388
GUCArrayAdd
ArrayType * GUCArrayAdd(ArrayType *array, const char *name, const char *value)
Definition: guc.c:6328
GUCArrayReset
ArrayType * GUCArrayReset(ArrayType *array)
Definition: guc.c:6474
GUCArrayDelete
ArrayType * GUCArrayDelete(ArrayType *array, const char *name)
Definition: guc.c:6405
ExtractSetVariableArgs
char * ExtractSetVariableArgs(VariableSetStmt *stmt)
Definition: guc_funcs.c:167
heap_modify_tuple
HeapTuple heap_modify_tuple(HeapTuple tuple, TupleDesc tupleDesc, const Datum *replValues, const bool *replIsnull, const bool *doReplace)
Definition: heaptuple.c:1210
heap_form_tuple
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1117
HeapTupleIsValid
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
heap_getattr
static Datum heap_getattr(HeapTuple tup, int attnum, TupleDesc tupleDesc, bool *isnull)
Definition: htup_details.h:904
CatalogTupleUpdate
void CatalogTupleUpdate(Relation heapRel, const ItemPointerData *otid, HeapTuple tup)
Definition: indexing.c:313
CatalogTupleInsert
void CatalogTupleInsert(Relation heapRel, HeapTuple tup)
Definition: indexing.c:233
CatalogTupleDelete
void CatalogTupleDelete(Relation heapRel, const ItemPointerData *tid)
Definition: indexing.c:365
a
int a
Definition: isn.c:73
NoLock
#define NoLock
Definition: lockdefs.h:34
RowExclusiveLock
#define RowExclusiveLock
Definition: lockdefs.h:38
InvokeObjectPostAlterHookArg
#define InvokeObjectPostAlterHookArg(classId, objectId, subId, auxiliaryId, is_internal)
Definition: objectaccess.h:200
VAR_RESET_ALL
@ VAR_RESET_ALL
Definition: parsenodes.h:2699
PointerGetDatum
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:332
ObjectIdGetDatum
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:262
Datum
uint64_t Datum
Definition: postgres.h:70
RelationGetDescr
#define RelationGetDescr(relation)
Definition: rel.h:541
ScanKeyInit
void ScanKeyInit(ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
Definition: scankey.c:76
BTEqualStrategyNumber
#define BTEqualStrategyNumber
Definition: stratnum.h:31
HeapTupleData::t_self
ItemPointerData t_self
Definition: htup.h:65
VariableSetStmt::kind
VariableSetKind kind
Definition: parsenodes.h:2707
table_close
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:126
table_open
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:40

References a, BTEqualStrategyNumber, CatalogTupleDelete(), CatalogTupleInsert(), CatalogTupleUpdate(), DatumGetArrayTypeP, 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().

◆ ApplySetting()

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

Definition at line 229 of file pg_db_role_setting.c.

231{
232 SysScanDesc scan;
233 ScanKeyData keys[2];
234 HeapTuple tup;
235
236 ScanKeyInit(&keys[0],
237 Anum_pg_db_role_setting_setdatabase,
238 BTEqualStrategyNumber,
239 F_OIDEQ,
240 ObjectIdGetDatum(databaseid));
241 ScanKeyInit(&keys[1],
242 Anum_pg_db_role_setting_setrole,
243 BTEqualStrategyNumber,
244 F_OIDEQ,
245 ObjectIdGetDatum(roleid));
246
247 scan = systable_beginscan(relsetting, DbRoleSettingDatidRolidIndexId, true,
248 snapshot, 2, keys);
249 while (HeapTupleIsValid(tup = systable_getnext(scan)))
250 {
251 bool isnull;
252 Datum datum;
253
254 datum = heap_getattr(tup, Anum_pg_db_role_setting_setconfig,
255 RelationGetDescr(relsetting), &isnull);
256 if (!isnull)
257 {
258 ArrayType *a = DatumGetArrayTypeP(datum);
259
260 /*
261 * We process all the options at SUSET level. We assume that the
262 * right to insert an option into pg_db_role_setting was checked
263 * when it was inserted.
264 */
265 ProcessGUCArray(a, PGC_SUSET, source, GUC_ACTION_SET);
266 }
267 }
268
269 systable_endscan(scan);
270}
ProcessGUCArray
void ProcessGUCArray(ArrayType *array, GucContext context, GucSource source, GucAction action)
Definition: guc.c:6296
GUC_ACTION_SET
@ GUC_ACTION_SET
Definition: guc.h:203
PGC_SUSET
@ PGC_SUSET
Definition: guc.h:78
source
static rewind_source * source
Definition: pg_rewind.c:89

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

Referenced by process_settings().

◆ CATALOG()

CATALOG ( pg_db_role_setting  ,
2964  ,
DbRoleSettingRelationId   
)

Definition at line 34 of file pg_db_role_setting.h.

35{
36 /* database, or 0 for a role-specific setting */
37 Oid setdatabase BKI_LOOKUP_OPT(pg_database);
38
39 /* role, or 0 for a database-specific setting */
40 Oid setrole BKI_LOOKUP_OPT(pg_authid);
41
42#ifdef CATALOG_VARLEN /* variable-length fields start here */
43 text setconfig[1]; /* GUC settings to apply at login */
44#endif
45} FormData_pg_db_role_setting;
BKI_LOOKUP_OPT
#define BKI_LOOKUP_OPT(catalog)
Definition: genbki.h:47
FormData_pg_db_role_setting
FormData_pg_db_role_setting
Definition: pg_db_role_setting.h:45
Oid
unsigned int Oid
Definition: postgres_ext.h:32
varlena
Definition: c.h:695

References BKI_LOOKUP_OPT.

◆ DECLARE_TOAST_WITH_MACRO()

DECLARE_TOAST_WITH_MACRO ( pg_db_role_setting  ,
2966  ,
2967  ,
PgDbRoleSettingToastTable  ,
PgDbRoleSettingToastIndex   
)

◆ DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY ( pg_db_role_setting_databaseid_rol_index  ,
2965  ,
DbRoleSettingDatidRolidIndexId  ,
pg_db_role_setting  ,
btree(setdatabase oid_ops, setrole oid_ops)   
)

◆ DropSetting()

void DropSetting ( Oid  databaseid,
Oid  roleid 
)

Definition at line 179 of file pg_db_role_setting.c.

180{
181 Relation relsetting;
182 TableScanDesc scan;
183 ScanKeyData keys[2];
184 HeapTuple tup;
185 int numkeys = 0;
186
187 relsetting = table_open(DbRoleSettingRelationId, RowExclusiveLock);
188
189 if (OidIsValid(databaseid))
190 {
191 ScanKeyInit(&keys[numkeys],
192 Anum_pg_db_role_setting_setdatabase,
193 BTEqualStrategyNumber,
194 F_OIDEQ,
195 ObjectIdGetDatum(databaseid));
196 numkeys++;
197 }
198 if (OidIsValid(roleid))
199 {
200 ScanKeyInit(&keys[numkeys],
201 Anum_pg_db_role_setting_setrole,
202 BTEqualStrategyNumber,
203 F_OIDEQ,
204 ObjectIdGetDatum(roleid));
205 numkeys++;
206 }
207
208 scan = table_beginscan_catalog(relsetting, numkeys, keys);
209 while (HeapTupleIsValid(tup = heap_getnext(scan, ForwardScanDirection)))
210 {
211 CatalogTupleDelete(relsetting, &tup->t_self);
212 }
213 table_endscan(scan);
214
215 table_close(relsetting, RowExclusiveLock);
216}
OidIsValid
#define OidIsValid(objectId)
Definition: c.h:777
heap_getnext
HeapTuple heap_getnext(TableScanDesc sscan, ScanDirection direction)
Definition: heapam.c:1361
ForwardScanDirection
@ ForwardScanDirection
Definition: sdir.h:28
table_beginscan_catalog
TableScanDesc table_beginscan_catalog(Relation relation, int nkeys, ScanKeyData *key)
Definition: tableam.c:113
table_endscan
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:985

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().

Variable Documentation

◆ FormData_pg_db_role_setting

FormData_pg_db_role_setting

Definition at line 45 of file pg_db_role_setting.h.