Skip to content

Commit 761b3f6

Browse files
committed
Update cross-links in docs
1 parent e95ed65 commit 761b3f6

File tree

2 files changed

+7
-13
lines changed

2 files changed

+7
-13
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
`pg_diffix` is a PostgreSQL extension for strong dynamic anonymization. It ensures that answers to simple SQL queries are anonymous. For more information, visit the [Open Diffix](https://www.open-diffix.org/) website.
44

5-
Check out the [Admin Tutorial](docs/admin_tutorial.md) for an example on how to set up `pg_diffix`.
6-
See the [Admin Guide](docs/admin_guide.md) for details on configuring and using the extension.
5+
**For administrators:** Check out the [admin tutorial](docs/admin_tutorial.md) for an example on how to set up `pg_diffix`.
6+
See the [admin guide](docs/admin_guide.md) for details on configuring and using the extension.
7+
To install from source, see the [installation](#installation) section.
8+
9+
**For analysts:** The [banking notebook](docs/banking.ipynb) provides example queries against a real dataset.
10+
The [analyst guide](docs/analyst_guide.md) describes the SQL features and limitations imposed by `pg_diffix`.
711

812
## Installation
913

docs/admin_guide.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -152,17 +152,7 @@ Default value is `*`. Any user can change this setting.
152152

153153
## Restricted features and extensions
154154

155-
**TODO:** I think this kind of information is better put in the notebook tutorial? Or if you want it here it seems incomplete or something. Needs work...
156-
157-
For users other than `direct`, various data and features built into PostgreSQL are restricted. Among others:
158-
159-
1. Issue utility statements like `COPY` and `ALTER TABLE`, beside a few allowlisted ones, are not allowed.
160-
2. Some of the data in `pg_catalog` tables like `pg_user_functions` is not accessible.
161-
3. Selected subset of less frequently used PostgreSQL query features like `EXISTS` or `NULLIF` are disabled.
162-
4. Inheritance involving a personal table is not allowed.
163-
5. Some of the output of `EXPLAIN` for queries involving a personal table is censored.
164-
165-
**NOTE** If any of the currently blocked features is necessary for your use case, open an issue and let us know.
155+
For a detailed description of supported SQL features and restrictions, see the [analyst guide](analyst_guide.md).
166156

167157
Row level security (RLS) can be enabled and used on personal tables.
168158
It is advised that the active policies are vetted from the point of view of anonymity.

0 commit comments

Comments
 (0)