From 5643eba166e2be14cb6834a73e5292f4a9fb2f37 Mon Sep 17 00:00:00 2001
From: Tobias Lindahl <tobias@happihacking.com>
Date: Mon, 1 Nov 2021 10:29:22 +0100
Subject: [PATCH] chore(persistent_session): add description for ps db backend

---
 apps/emqx/src/emqx_schema.erl | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl
index 4059415f7..a94181ff3 100644
--- a/apps/emqx/src/emqx_schema.erl
+++ b/apps/emqx/src/emqx_schema.erl
@@ -163,6 +163,14 @@ fields("persistent_session_store") ->
       {"db_backend",
        sc(hoconsc:union([mnesia_ram, mnesia_disc]),
           #{ default => "mnesia_ram"
+           , desc => """
+Which database backend should be used for persistent session storage.<br>
+mnesia_ram: Mnesia table, RAM only.<br>
+mnesia_disc: Mnesia table, in RAM but also copy to disc.<br>
+When running in a single node, it's recommended to have the session states copied to disc.<br>
+When clustered, session states are replicated to all the nodes in the cluster,
+most of the time, RAM only is good enough.
+"""
            })},
       {"max_retain_undelivered",
        sc(duration(),