jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add db-pool-acquisition-timeout configuration parameter

Browse Source
This commit is contained in:
Laurence Isla
2023-04-21 18:52:56 -05:00
committed by Laurence Isla
parent 1e353dc4d2
commit bd11334df7
2 changed files with 41 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/configuration.rst
+40 -41
View File
@@ -108,7 +108,7 @@ It's not possible to change :ref:`env_variables_config` for a running process an
* :ref:`admin-server-port` * :ref:`admin-server-port`
* :ref:`db-uri` * :ref:`db-uri`
* :ref:`db-pool` * :ref:`db-pool`
* :ref:`db-pool-timeout` * :ref:`db-pool-acquisition-timeout`
* :ref:`server-host` * :ref:`server-host`
* :ref:`server-port` * :ref:`server-port`
* :ref:`server-unix-socket` * :ref:`server-unix-socket`
@@ -143,40 +143,40 @@ The ``"pgrst"`` notification channel is enabled by default. For configuring the
List of parameters List of parameters
================== ==================
======================== ======= ================= ========== =========================== ======= ================= ==========
Name Type Default Reloadable Name Type Default Reloadable
======================== ======= ================= ========== =========================== ======= ================= ==========
admin-server-port Int admin-server-port Int
app.settings.* String Y app.settings.* String Y
db-anon-role String Y db-anon-role String Y
db-channel String pgrst Y db-channel String pgrst Y
db-channel-enabled Boolean True Y db-channel-enabled Boolean True Y
db-config Boolean True Y db-config Boolean True Y
db-extra-search-path String public Y db-extra-search-path String public Y
db-max-rows Int ∞ Y db-max-rows Int ∞ Y
db-plan-enabled Boolean False Y db-plan-enabled Boolean False Y
db-pool Int 10 db-pool Int 10
db-pool-timeout Int 3600 db-pool-acquisition-timeout Int ∞
db-pre-request String Y db-pre-request String Y
db-prepared-statements Boolean True Y db-prepared-statements Boolean True Y
db-schemas String public Y db-schemas String public Y
db-tx-end String commit db-tx-end String commit
db-uri String postgresql:// db-uri String postgresql://
db-use-legacy-gucs Boolean True Y db-use-legacy-gucs Boolean True Y
jwt-aud String Y jwt-aud String Y
jwt-role-claim-key String .role Y jwt-role-claim-key String .role Y
jwt-secret String Y jwt-secret String Y
jwt-secret-is-base64 Boolean False Y jwt-secret-is-base64 Boolean False Y
log-level String error Y log-level String error Y
openapi-mode String follow-privileges Y openapi-mode String follow-privileges Y
openapi-security-active Boolean False Y openapi-security-active Boolean False Y
openapi-server-proxy-uri String Y openapi-server-proxy-uri String Y
raw-media-types String Y raw-media-types String Y
server-host String !4 server-host String !4
server-port Int 3000 server-port Int 3000
server-unix-socket String server-unix-socket String
server-unix-socket-mode String 660 server-unix-socket-mode String 660
======================== ======= ================= ========== =========================== ======= ================= ==========
.. _admin-server-port: .. _admin-server-port:
@@ -332,18 +332,17 @@ db-pool
Number of connections to keep open in PostgREST's database pool. Having enough here for the maximum expected simultaneous client connections can improve performance. Note it's pointless to set this higher than the :code:`max_connections` GUC in your database. Number of connections to keep open in PostgREST's database pool. Having enough here for the maximum expected simultaneous client connections can improve performance. Note it's pointless to set this higher than the :code:`max_connections` GUC in your database.
.. _db-pool-timeout: .. _db-pool-acquisition-timeout:
db-pool-timeout db-pool-acquisition-timeout
--------------- ---------------------------
=============== ================= =============== =================
**Environment** PGRST_DB_POOL_TIMEOUT **Environment** PGRST_DB_POOL_ACQUISITION_TIMEOUT
**In-Database** `n/a` **In-Database** `n/a`
=============== ================= =============== =================
Time to live, in seconds, for an idle database pool connection. If the timeout is reached the connection will be closed. Specifies the maximum time in seconds that the request will wait for the pool to free up a connection slot to the database. If it times out without acquiring a connection, then the request is aborted and a ``504`` error is returned.
Once a new request arrives a new connection will be started.
.. _db-pre-request: .. _db-pre-request:
docs/releases/v6.0.2.rst
+1 -1
View File
@@ -26,7 +26,7 @@ Added
* It's now possible to request a ``text/plain`` output. See :ref:`scalar_return_formats`. * It's now possible to request a ``text/plain`` output. See :ref:`scalar_return_formats`.
|br| -- `@steve-chavez <https://github.com/steve-chavez>`_ |br| -- `@steve-chavez <https://github.com/steve-chavez>`_
* Config option for specifying PostgREST database pool timeout. See :ref:`db-pool-timeout`. * Config option for specifying PostgREST database pool timeout ``db-pool-timeout``.
|br| -- `@Qu4tro <https://github.com/Qu4tro>`_ |br| -- `@Qu4tro <https://github.com/Qu4tro>`_
* Config option for binding the PostgREST web server to an unix socket. See :ref:`server-unix-socket`. * Config option for binding the PostgREST web server to an unix socket. See :ref:`server-unix-socket`.