Wiki documentation for ocsipersist-pgsql

Author: Jan Rochel

doc/manual-wiki/config.wiki

@@ -148,7 +148,10 @@ Here is a simple example:
 </ocsigen>
 }}}
 
-Here is another example, for use as unprivileged user toto on port 8000:
+Here is another example, for use as unprivileged user toto on port 8000.
+We use the PostgreSQL (version >= 9.5) backend for ocsipersist. Note that the
+ocsipersist-database under the specified name (default: "ocsipersist") needs to
+exist. To create it run {{{psql}}} and execute {{{CREATE TABLE ocsipersist;}}}.
 
 {{{
 <ocsigen>
@@ -167,8 +170,14 @@ Here is another example, for use as unprivileged user toto on port 8000:
 
     <extension findlib-package="ocsigenserver.ext.staticmod"/>
 
-    <extension findlib-package="ocsigenserver.ext.ocsipersist-sqlite"/>
-    <!-- sqlite3.cma will be loaded automatically using findlib -->
+    <extension findlib-package="ocsigenserver.ext.ocsipersist-pgsql">
+      <database <!-- optional, as each of the following attributes are -->
+        port="3000"
+        user="toto"
+        password="toto's secret"
+      />
+    </extension>
+    <!-- pa_pgsql.cma will be loaded automatically using findlib -->
 
     <extension findlib-package="ocsigenserver.ext.eliom"/>
     <!-- Eliom's dependencies will be loaded automatically using findlib -->
@@ -182,7 +191,7 @@ Here is another example, for use as unprivileged user toto on port 8000:
       <site path="tuto">
         <eliom module="/usr/local/lib/ocsigenserver/tutoeliom.cmo" />
         <static dir="/home/toto/var/www/ocsigenserver/tutorial" />
-	<!-- Module's path coul be relative but static dir must be absolute -->
+        <!-- Module's path coul be relative but static dir must be absolute -->
       </site>
 
     </host>

doc/manual-wiki/libraries.wiki

@@ -5,15 +5,17 @@
 
 ==Ocsipersist
 
-<<div class="wip"|Ocsipersist (2 implémentations)
+<<div class="wip"|Ocsipersist (3 implémentations)
 Eliom allows to use more persistent data, using the module
 <<a_api project="ocsigenserver" | module Ocsipersist >> is needed in
 {{{ eliom.cma }}}, thus you need to dynlink it in the
 configuration file before {{{ Eliom }}}).
 There are currently two implementations of {{{ Ocsipersist }}}:
-{{{ ocsipersist-dbm.cma }}} (uses the DBM database) and
-{{{ ocsipersist-sqlite.cma }}} (uses the SQLite database,
-and depends on {{{ sqlite3.cma }}}).
+{{{ ocsipersist-dbm.cma }}} (uses the DBM database);
+{{{ ocsipersist-sqlite.cma }}} (uses the SQLite database
+and depends on {{{ sqlite3.cma }}});
+{{{ ocsipersist-pgsql.cma }}} (uses the PostgreSQL (version >= 9.5)
+database and depends on {{{ pa_pgsql.cma }}});
 >>
 
 It is possible to customize the location of the database on the 
@@ -31,3 +33,19 @@ name of the {{{ocsidbm}}} process you want to use:
       <ocsidbm name="_EXTRALIBDIR_/ocsidbm"/>
     </extension>
 }}}
+PostgreSQL has more options to specify how to connect to the database.
+Note that the ocsipersist-database under the specified name (default:
+"ocsipersist") needs to exist. To create it run {{{psql}}} and execute
+{{{CREATE TABLE ocsipersist;}}}.
+{{{
+    <extension findlib-package="ocsigenserver.ext.ocsipersist-pgsql">
+      <database <!-- optional, as each of the following attributes are -->
+        host="localhost"
+        port="3000"
+        user="Aerobic Respirator"
+        password="Guess what I need!"
+        database="ocsipersist" <!-- this is the default value if not specified -->
+        unix_domain_socket_dir="./udsd"
+      />
+    </extension>
+}}}