Skip to content

Commit

Permalink
Add section to README about RLS in Postgres 14 (#202)
Browse files Browse the repository at this point in the history
Add a section covering the limitations of `pgroll` and row level
security policies in Postgres 14.

[[Direct
link](https://github.com/xataio/pgroll/blob/document-rls/docs/README.md#supported-postgres-versions)]

Relates to #179
  • Loading branch information
andrew-farries committed Nov 8, 2023
1 parent 4f4d549 commit 7f20c15
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* [Multiple schema versions](#multiple-schema-versions)
* [Client applications](#client-applications)
* [Installation](#installation)
* [Supported Postgres versions](#supported-postgres-versions)
* [Tutorial](#tutorial)
* [Command line reference](#command-line-reference)
* [init](#init)
Expand Down Expand Up @@ -111,6 +112,12 @@ brew tap xataio/pgroll
brew install pgroll
```

## Supported Postgres versions

`pgroll` supports Postgres versions >= 14.

:warning: In Postgres 14, row level security policies on tables are not respected by `pgroll`'s versioned views. This is because `pgroll` is unable to create the views with the `(security_invoker = true)` option, as the ability to do so was added in Postgres 15. If you use RLS in Postgres 14 `pgroll` is likely a poor choice of migration tool. All other `pgroll` features are fully supported across all supported Postgres versions.

## Tutorial

This section will walk you through applying your first migrations using `pgroll`.
Expand Down

0 comments on commit 7f20c15

Please sign in to comment.