Configs

Update the sub-configurations under persistent_session_store

put/configs/persistent_session_store

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/configs/persistent_session_store
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Request body

enabledboolean

Use the database to store information about persistent sessions.<br/>This makes it possible to migrate a client connection to another<br/>cluster node if a node is stopped.<br/>

on_discboolean

Save information about the persistent sessions on disc.<br/>If this option is enabled, persistent sessions will survive full restart of the cluster.<br/>Otherwise, all the data will be stored in RAM, and it will be lost when all the nodes in the cluster are stopped.

ram_cacheboolean

Maintain a copy of the data in RAM for faster access.

max_retain_undeliveredstring

The time messages that was not delivered to a persistent session<br/>is stored before being garbage collected if the node the previous<br/>session was handled on restarts of is stopped.<br/>

message_gc_intervalstring

The starting interval for garbage collection of undelivered messages to<br/>a persistent session. This affects how often the "max_retain_undelivered"<br/>is checked for removal.<br/>

session_message_gc_intervalstring

The starting interval for garbage collection of transient data for<br/>persistent session messages. This does not affect the lifetime length<br/>of persistent session messages.<br/>

Example request

{
  "max_retain_undelivered": "12m",
  "message_gc_interval": "12m",
  "session_message_gc_interval": "12m"
}

Response

enabledboolean

Use the database to store information about persistent sessions.<br/>This makes it possible to migrate a client connection to another<br/>cluster node if a node is stopped.<br/>

on_discboolean

Save information about the persistent sessions on disc.<br/>If this option is enabled, persistent sessions will survive full restart of the cluster.<br/>Otherwise, all the data will be stored in RAM, and it will be lost when all the nodes in the cluster are stopped.

ram_cacheboolean

Maintain a copy of the data in RAM for faster access.

max_retain_undeliveredstring

The time messages that was not delivered to a persistent session<br/>is stored before being garbage collected if the node the previous<br/>session was handled on restarts of is stopped.<br/>

message_gc_intervalstring

The starting interval for garbage collection of undelivered messages to<br/>a persistent session. This affects how often the "max_retain_undelivered"<br/>is checked for removal.<br/>

session_message_gc_intervalstring

The starting interval for garbage collection of transient data for<br/>persistent session messages. This does not affect the lifetime length<br/>of persistent session messages.<br/>

Example response

{
  "max_retain_undelivered": "12m",
  "message_gc_interval": "12m",
  "session_message_gc_interval": "12m"
}

Changes

No recorded changes to this operation across all 1 revision of this API.