Document that you must always close the pool

Fixes #170
rstudio · Feb 14, 2024 · 723e354 · 723e354
1 parent 4671ae5
commit 723e354
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/R/pool-methods.R b/R/pool-methods.R
@@ -6,6 +6,11 @@
 #' little computational cost. The pool should be created only once
 #' and closed when it is no longer needed, to prevent leaks.
 #'
+#' Every usage of `poolCreate()` should always be paired with a call to
+#' `poolClose()` to avoid "leaking" resources. In shiny app, you should
+#' create the pool outside of the server function and close it on stop,
+#' i.e. `onStop(function() pool::poolClose(pool))`.
+#'
 #' See [dbPool()] for an example of object pooling applied to DBI database
 #' connections.
 #'

diff --git a/man/Pool-class.Rd b/man/Pool-class.Rd