Merge pull request #13104 from backstage/blam/divvymode

chore: adding a note about division mode
2022-08-11 16:03:34 +02:00
parent 49c01cdd33 c2b932dfb9
commit 68ac6f91d0
1 changed files with 13 additions and 0 deletions
@@ -86,3 +86,16 @@ backend:
 +      #   ca: # if you have a CA file and want to verify it you can uncomment this section
 +      #     $file: <file-path>/ca/server.crt
 ```
+
+### Using a single database
+
+By default, each plugin will get its own logical database, to ensure that there's no conflict in table names throughout the plugins that you install and to keep their concerns separate for other use cases further down the line. If you are limited in that you can only make use of a single database, you can use a special option `pluginDivisionMode` with `client: pg` in the config to create separate [PostgreSQL Schemas](https://www.postgresql.org/docs/current/ddl-schemas.html) instead of creating separate databases.
+
+You can enable this using the following config:
+
+```yaml
+backend:
+  database:
+    client: pg
+    pluginDivisionMode: schema # defaults to database, but changing this to schema means plugins will be given their own schema (in the specified/default database)
+```