Merge pull request #283 from supabase/add_warning

add warnings in docs and readme about using materialized views
supabase · Jun 4, 2024 · e14771b · e14771b
2 parents 4842428 + bd29e66
commit e14771b
Show file tree

Hide file tree

Showing 14 changed files with 56 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,10 @@
 | [AWS Cognito](./wrappers/src/fdw/cognito_fdw)   | A FDW for [AWS Cognito](https://aws.amazon.com/cognito/)                      | ✅   | ❌     |
 | [Notion](./wrappers/src/fdw/notion_fdw)         | A FDW for [Notion](https://www.notion.so/)                                    | ✅   | ❌     |
 
+### Warning
+
+Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Features
 
 - Minimum interface and easy to implement.

diff --git a/docs/airtable.md b/docs/airtable.md
@@ -2,6 +2,10 @@
 
 The Airtable Wrapper allows you to read data from your Airtable bases/tables within your Postgres database.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Preparation
 
 Before you get started, make sure the `wrappers` extension is installed on your database:

diff --git a/docs/auth0.md b/docs/auth0.md
@@ -2,6 +2,10 @@
 
 The Auth0 Wrapper allows you to read data from your Auth0 tenant for use within your Postgres database.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Preparation
 
 Before you get started, make sure the `wrappers` extension is installed on your database:

diff --git a/docs/bigquery.md b/docs/bigquery.md
@@ -2,6 +2,10 @@
 
 The BigQuery Wrapper allows you to read and write data from BigQuery within your Postgres database.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Supported Data Types
 
 | Postgres Type    | BigQuery Type |

diff --git a/docs/clickhouse.md b/docs/clickhouse.md
@@ -2,6 +2,10 @@
 
 The ClickHouse Wrapper allows you to read and write data from ClickHouse within your Postgres database.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Supported Data Types
 
 | Postgres Type    | ClickHouse Type |

diff --git a/docs/cognito.md b/docs/cognito.md
@@ -2,6 +2,10 @@
 
 The Cognito wrapper allows you to read data from your Cognito Userpool within your Postgres database.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Preparation
 
 Before you get started, make sure the `wrappers` extension is installed on your database:

diff --git a/docs/firebase.md b/docs/firebase.md
@@ -3,6 +3,10 @@
 1. [Authentication Users](https://firebase.google.com/docs/auth/users) (_read only_)
 2. [Firestore Database Documents](https://firebase.google.com/docs/firestore) (_read only_)
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Preparation
 
 Before you get started, make sure the `wrappers` extension is installed on your database:

diff --git a/docs/index.md b/docs/index.md
@@ -52,3 +52,7 @@ Currently `supabase/wrappers` supports:
 | S3          |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
 | Stripe      |   ✅   |   ✅   |   ✅   |   ✅   |    ❌    |
 | SQL Server  |   ✅   |   ❌   |   ❌   |   ❌   |    ❌    |
+
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
diff --git a/docs/logflare.md b/docs/logflare.md
@@ -2,6 +2,10 @@
 
 The Logflare Wrapper allows you to read data from Logflare endpoints within your Postgres database.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Preparation
 
 Before you get started, make sure the `wrappers` extension is installed on your database:

diff --git a/docs/mssql.md b/docs/mssql.md
@@ -2,6 +2,10 @@
 
 The SQL Server Wrapper allows you to read data from Microsoft SQL Server within your Postgres database.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Supported Data Types
 
 | Postgres Type      | SQL Server Type                  |

diff --git a/docs/notion.md b/docs/notion.md
@@ -3,6 +3,10 @@
 
 The Notion Wrapper allows you to read data from your Notion workspace for use within your Postgres database. Only the users endpoint is supported at the moment.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Preparation
 
 Before you get started, make sure the `wrappers` extension is installed on your database:

diff --git a/docs/redis.md b/docs/redis.md
@@ -2,6 +2,10 @@
 
 The Redis Wrapper allows you to read data from Redis within your Postgres database.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Supported Redis Data Types
 
 All Redis value will be stored as `text` or `jsonb` column in Postgres, below are the supported Redis data types:

diff --git a/docs/s3.md b/docs/s3.md
@@ -17,6 +17,10 @@ The S3 Wrapper also supports below compression algorithms:
 
 **Note for Parquet files: the whole Parquet file will be loaded into local memory if it is compressed, so keep the file size as small as possible**.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Supported Data Types For Parquet File
 
 The S3 Wrapper uses Parquet file data types from [arrow_array::types](https://docs.rs/arrow-array/41.0.0/arrow_array/types/index.html), below are their mappings to Postgres data types.

diff --git a/docs/stripe.md b/docs/stripe.md
@@ -1,5 +1,9 @@
 [Stripe](https://stripe.com) is an API driven online payment processing utility. `supabase/wrappers` exposes below endpoints.
 
+!!! warning
+
+    Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
+
 ## Preparation
 
 Before you get started, make sure the `wrappers` extension is installed on your database: