You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Added concrete examples to admin_tutorial.md
* Update admin_tutorial.md
changed taxi columns/types table to simple text dump to be consistent with other tables
* Update admin_guide.md
* Update admin_tutorial.md
Broke config examples into per-database and per-table. Also added reference to the admin guide
* Update admin_tutorial.md
* Reverted to Edon's original admin_tutorial, added admin_case_study
* fixed column names and stuff
* removed case study ... do later
* Update admin_tutorial.md
* Update admin_guide.md
* Update admin_guide.md
Copy file name to clipboardExpand all lines: docs/admin_guide.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Configuration
2
2
3
-
This document provides detailed information about the configuration, behavior and recommended usage of `pg_diffix`.
3
+
This reference contains descriptions of all the configuration commands, and detailed information about the configuration, behavior and recommended usage of `pg_diffix`. The [Administration Tutorial](admin_tutorial.md) contains simple step-by-step configuration instructions and is a good starting point.
4
4
5
5
## Background reading
6
6
@@ -12,7 +12,7 @@ Extension behavior is controlled by __security labels__ and __settings__. Securi
12
12
13
13
Only superusers can assign security labels. To remove a security label from an object, set it to `NULL`.
14
14
15
-
The command `SELECT * FROM diffix.show_labels();` displays the current security labels assigned to tables and columns by the extension.
15
+
The command `SELECT * FROM diffix.show_labels();` displays the current security labels assigned to tables and columns by the extension. Note that if this command fails, then probably `pg_diffix` has not been enabled for the database. See the [Administration Tutorial](admin_tutorial.md) for step-by-step instructions.
16
16
17
17
The command `SELECT diffix.access_level();` displays the current access level of the active session.
18
18
The access level depends on the current role's security label and the `session_access_level`/`default_access_level` settings.
@@ -51,7 +51,7 @@ Tables may have one of two security labels: `public` or `personal`.
51
51
52
52
* Tables labeled as `personal` are anonymized by the extension for `anonymized_*` access levels.
53
53
* Tables labeled as `public` are not anonymized: all users have direct access to these tables.
54
-
*Unabeled tables are not accessible for `anonymized_*` access levels (unless the value of the configuration
54
+
*Unlabeled tables are not accessible for `anonymized_*` access levels (unless the value of the configuration
55
55
variable `pg_diffix.treat_unmarked_tables_as_public` is set to `true`, in which case they are considered `public`).
56
56
57
57
The procedure `diffix.mark_public(table_name)` labels a table as `public`.
@@ -89,7 +89,7 @@ Superusers can change these variables at runtime for their own session, while re
89
89
To use different values for all future sessions, they have to be set in the server's configuration file.
90
90
91
91
Execute `SELECT diffix.show_settings();` to display the current settings of the extension.
92
-
If the result is empty, make sure [`pg_diffix` is loaded](#using-the-extension).
92
+
If the result is empty, make sure `pg_diffix` is loaded.
Copy file name to clipboardExpand all lines: docs/admin_tutorial.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,8 @@
1
-
# Admin tutorial
1
+
# Admin Tutorial
2
2
3
-
This document provides an example on how to install and configure `pg_diffix` to expose a simple dataset
4
-
for anonymized querying.
5
-
It assumes that an existing installation of PostgreSQL 14 on a Linux system is available, a database
6
-
named `test_db` was created, and the personal data is in the table `test_table`,
7
-
containing a column named `id`, which uniquely identifies protected entities (the anonymization ID).
3
+
This document contains a simple tutorial on how to install and configure `pg_diffix` to expose a simple dataset for anonymized querying. It assumes that an existing installation of PostgreSQL 14 on a Linux system is available.
4
+
5
+
This simple example assumes assumes a database named `test_db` was created, and the personal data is in the table `test_table`, and contains a column named `id` that uniquely identifies protected entities (the anonymization ID).
0 commit comments