summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Eisentraut <peter_e@gmx.net>2017-08-23 14:59:25 -0400
committerPeter Eisentraut <peter_e@gmx.net>2017-08-23 14:59:55 -0400
commitd51b0872bf9a71d9585ca13bbf1f9463d9c61182 (patch)
tree0b139d2b821db62cbf4f1d26bbd40b12bf2d0c92
parentda19c32c6b7dd7d0ff5814538adf5aaa665848a1 (diff)
Update code comment for temporary replication slots
Reported-by: Alvaro Herrera <alvherre@2ndquadrant.com>
-rw-r--r--src/include/replication/slot.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h
index 0bf2611fe9c..0c442330b22 100644
--- a/src/include/replication/slot.h
+++ b/src/include/replication/slot.h
@@ -22,9 +22,13 @@
*
* Slots marked as PERSISTENT are crash-safe and will not be dropped when
* released. Slots marked as EPHEMERAL will be dropped when released or after
- * restarts.
+ * restarts. Slots marked TEMPORARY will be dropped at the end of a session
+ * or on error.
*
- * EPHEMERAL slots can be made PERSISTENT by calling ReplicationSlotPersist().
+ * EPHEMERAL is used as a not-quite-ready state when creating persistent
+ * slots. EPHEMERAL slots can be made PERSISTENT by calling
+ * ReplicationSlotPersist(). For a slot that goes away at the end of a
+ * session, TEMPORARY is the appropriate choice.
*/
typedef enum ReplicationSlotPersistency
{