Skip to content

Commit ad906c1

Browse files
committed
feat: document shutdown_after_inactive_seconds in README
1 parent b5e3a39 commit ad906c1

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,22 @@ users may find useful:
105105
to you, if you need to pin your usage to a particular, supported
106106
WherobotsDB version. Defaults to `"latest"`.
107107
* `session_type`: `"single"` or `"multi"`; if set to `"single"`, then
108-
each call to `connect()` establishes an exclusive connection to a
109-
distinct and dedicated Wherobots runtime; if set to "multi", then
110-
multiple `connect()` calls with the same arguments and credentials
111-
will connect to the same shared Wherobots runtime; `"multi"` is the
112-
default.
113-
114-
Consider multi-session for potential cost savings, but be mindful of
115-
performance impacts from shared resources. You might need to adjust
116-
cluster size if slowdowns occur, which could affect overall cost.
108+
each call to `connect()` establishes an exclusive connection to a
109+
distinct and dedicated Wherobots runtime; if set to "multi", then
110+
multiple `connect()` calls with the same arguments and credentials
111+
will connect to the same shared Wherobots runtime; `"multi"` is the
112+
default.
113+
114+
Consider multi-session for potential cost savings, but be mindful of
115+
performance impacts from shared resources. You might need to adjust
116+
cluster size if slowdowns occur, which could affect overall cost.
117+
* `shutdown_after_inactive_seconds`: how long the runtime waits and
118+
stays running after all clients have disconnected. This delay gives
119+
an opportunity for clients to reconnect to a previously-established
120+
runtime without having to start a new one.
121+
122+
If you're using a simple "connect-query-disconnect" pattern from
123+
your application, you can set this parameter to a value greater than
124+
your expected time between queries and effectively get a continuously
125+
running SQL session runtime without any complex connection management
126+
in your application.

0 commit comments

Comments
 (0)