From d4635a7968d779315ea6feab5461e1c53818ca1a Mon Sep 17 00:00:00 2001
From: Valentin Lab <valentin.lab@kalysto.org>
Date: Tue, 4 Apr 2023 15:06:47 +0200
Subject: [PATCH] new: doc: [postgres] added some docs about relation's option

---
 postgres/README.org | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 postgres/README.org

diff --git a/postgres/README.org b/postgres/README.org
new file mode 100644
index 0000000..a556706
--- /dev/null
+++ b/postgres/README.org
@@ -0,0 +1,23 @@
+# -*- ispell-local-dictionary: "english" -*-
+
+* Usage
+
+By default, =postgres= charm won't need any options in general.
+
+However, services using =postgres= through relations will typically
+want to set some options (if the default behavior is not enough).
+
+#+begin_src yaml
+myservice:
+  relations:
+    postgres-database:
+      postgres:
+        dbname: foo     ## default uses the name of querying service (here: 'myservice')
+        user: mydbuser  ## default uses the name of querying service (here: 'myservice')
+        password: bar   ## if not set, a random password will be generated
+        extensions:     ## default is empty list
+          - unaccent
+          - pg_trgm
+        init-sql: !bash-stdout | ## default is empty
+          zcat "$BASE_CHARM_PATH/src/init.sql.gz"
+#+end_src