Skip to content

Commit 182ea12

Browse files
authored
Paul/update docs elm (#399)
* 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
1 parent 7739166 commit 182ea12

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

docs/admin_guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration
22

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.
44

55
## Background reading
66

@@ -12,7 +12,7 @@ Extension behavior is controlled by __security labels__ and __settings__. Securi
1212

1313
Only superusers can assign security labels. To remove a security label from an object, set it to `NULL`.
1414

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.
1616

1717
The command `SELECT diffix.access_level();` displays the current access level of the active session.
1818
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`.
5151

5252
* Tables labeled as `personal` are anonymized by the extension for `anonymized_*` access levels.
5353
* 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
5555
variable `pg_diffix.treat_unmarked_tables_as_public` is set to `true`, in which case they are considered `public`).
5656

5757
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
8989
To use different values for all future sessions, they have to be set in the server's configuration file.
9090

9191
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.
9393

9494
### Anonymization salt
9595

docs/admin_tutorial.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
# Admin tutorial
1+
# Admin Tutorial
22

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

97
## Installation
108

@@ -74,4 +72,4 @@ CALL diffix.mark_role('analyst_role', 'anonymized_trusted');
7472
```
7573

7674

77-
__That's it!__ The analyst can now connect to the database and issue (only) anonymizing queries against the test dataset.
75+
__That's it!__ The analyst can now connect to the database and issue (only) anonymizing queries against the test dataset.

0 commit comments

Comments
 (0)