IF Commons GitHub

sql/extensions/protected-access/settings

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0014-sql-protected-access FR-001

The settings of the protection layer (commons data 0014-sql-protected-access FR-001): what a project says of the schema of its tables and of its views, how far the layer is enforced, whether it guards the tables against a change outside a migration, whether it hides what governance says is to be hidden, and which roles see it as it is. Every one has a default.

Source: commons/data/sql/extensions/protected-access/settings.ts

0 of 2 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

Protectioninterfaceno test imports it
interface Protection

The settings with every default filled.

MemberTypeWhat it is
tablesSchemastring
viewsSchemastring
enforcementEnforcement
guardboolean
masksboolean
unmaskedRolesreadonly string[]
migratingSettingstring
migratingSecretstring | undefined
ownerstring | undefined
ProtectionSettingsinterfaceno test imports it
interface ProtectionSettings

What a project says of protection; what is not said is the default.

MemberTypeWhat it is
tablesSchema?stringThe schema the tables are in; data by default.
viewsSchema?stringThe schema the views are in; api by default.
enforcement?Enforcementauto (the default), enforced or convention.
guard?"off" | "on"Whether a table is guarded against a change outside a migration; on by default.
masks?"off" | "on"Whether what governance says is to be hidden (security.mask) is hidden in the views; on by default.
unmaskedRoles?readonly string[]The roles that see a masked value as it is; none by default.
migratingSetting?stringThe setting a migration sets to tell the guard it is one; lifecycle.migrating by default.
migratingSecret?stringA secret that seals the flag: the guard then holds only its hash and a migration sets the secret, so that a session that does not know it cannot say it is a migration; without one, on says so and any session can.
owner?stringThe role that owns the schemas, the tables and the views, so that a view runs with its rights and row-level security applies to it; none by default, which leaves ownership to whoever runs the plan.

Titles, headings, exports, tables, columns and requirements. Esc closes.