Document disconnect_all/3 (#322)

elixir-ecto · Feb 12, 2025 · 48bc34d · 48bc34d
1 parent df77232
commit 48bc34d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/db_connection/connection_pool.ex b/lib/db_connection/connection_pool.ex
@@ -6,6 +6,11 @@ defmodule DBConnection.ConnectionPool do
 
   You're not supposed to call any functions on this pool directly, but only pass this
   as the value of the `:pool` option in functions such as `DBConnection.start_link/2`.
+
+  `disconnect_all/3`, which by default will result in connections being
+  reestablished, can be called periodically to recycle checked-in connections
+  after a maximum lifetime is reached. `Ecto SQL` users may find it at
+  https://hexdocs.pm/ecto_sql/Ecto.Adapters.SQL.html#disconnect_all/3
   """
 
   use GenServer