diff --git a/docs/README.md b/docs/README.md index 05f330fc..79b374bd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) @@ -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`.