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

pin version to 11.0.1

Browse Source
This commit is contained in:
steve-chavez
2023-06-07 19:56:05 -05:00
committed by Steve Chavez
parent b1f50537e9
commit ee6b9c5224
5 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/conf.py
+2 -2
View File
@@ -57,9 +57,9 @@ copyright = u'2017, ' + author
# built documents.
#
# The short X.Y version.
version = u'11.0'
version = u'11.1'
# The full version, including alpha/beta/rc tags.
release = u'11.0.1'
release = u'11.1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
docs/references/api/stored_procedures.rst
+1 -1
View File
@@ -65,7 +65,7 @@ The client can call it by posting an object like
Calling with GET
----------------
If the function doesn't modify the database, it will also run under the GET method(see :ref:`access_mode`).
If the function doesn't modify the database, it will also run under the GET method (see :ref:`access_mode`).
.. tabs::
docs/references/configuration.rst
+8 -8
View File
@@ -158,8 +158,8 @@ db-extra-search-path String public Y PGRST_DB_EXTRA_
db-max-rows Int ∞ Y PGRST_DB_MAX_ROWS pgrst.db_max_rows
db-plan-enabled Boolean False Y PGRST_DB_PLAN_ENABLED pgrst.db_plan_enabled
db-pool Int 10 PGRST_DB_POOL
db-pool-max-idletime Int 30 PGRST_DB_POOL_MAX_IDLETIME
db-pool-acquisition-timeout Int 10 PGRST_DB_POOL_ACQUISITION_TIMEOUT
db-pool-max-idletime Int 30 PGRST_DB_POOL_MAX_IDLETIME
db-pool-max-lifetime Int 1800 PGRST_DB_POOL_MAX_LIFETIME
db-pre-request String Y PGRST_DB_PRE_REQUEST pgrst.db_pre_request
db-prepared-statements Boolean True Y PGRST_DB_PREPARED_STATEMENTS pgrst.db_prepared_statements
@@ -295,6 +295,13 @@ db-pool
Number of maximum connections to keep open in PostgREST's database pool.
.. _db-pool-acquisition-timeout:
db-pool-acquisition-timeout
---------------------------
Specifies the maximum time in seconds that the request will wait for the pool to free up a connection slot to the database.
.. _db-pool-max-idletime:
db-pool-max-idletime
@@ -304,13 +311,6 @@ db-pool-max-idletime
Time in seconds to close idle pool connections.
.. _db-pool-acquisition-timeout:
db-pool-acquisition-timeout
---------------------------
Specifies the maximum time in seconds that the request will wait for the pool to free up a connection slot to the database.
.. _db-pool-max-lifetime:
db-pool-max-lifetime
docs/references/connection_pool.rst
+9 -9
View File
@@ -13,24 +13,24 @@ Minimizing connections it’s paramount to performance. Each PostgreSQL connecti
Dynamic Connection Pool
-----------------------
To conserve system resources, PostgREST uses a dynamic connection pool. This enables the number of connections in the pool to increase and decrease depending on request traffic.
To conserve system resources, PostgREST uses a dynamic connection pool. This enables the number of connections in the pool to increase and decrease depending on request traffic.
- If all the connections are being used, a new connection is added. The pool can grow until it reaches the :ref:`db-pool` size. Note it’s pointless to set this higher than the ``max_connections`` setting in your database.
- If a connection is unused for a period of time(determined by :ref:`db-pool-max-idletime`, 30 seconds by default), it will be released.
- If all the connections are being used, a new connection is added. The pool can grow until it reaches the :ref:`db-pool` size. Note that it’s pointless to set this higher than the ``max_connections`` setting in your database.
- If a connection is unused for a period of time (determined by :ref:`db-pool-max-idletime`, 30 seconds by default), it will be released.
Connection lifetime
-------------------
Long-lived PostgreSQL connections can consume considerable memory(see `here <https://www.postgresql.org/message-id/CAFj8pRCQN2B2vrVMH1-bd-8xtzjytWR%2BAjZ%2BMCj9J2wPxKPa9Q%40mail.gmail.com>`_ for more details).
Long-lived PostgreSQL connections can consume considerable memory (see `here <https://www.postgresql.org/message-id/CAFj8pRCQN2B2vrVMH1-bd-8xtzjytWR%2BAjZ%2BMCj9J2wPxKPa9Q%40mail.gmail.com>`_ for more details).
Under a busy system, the :ref:`db-pool-max-idletime` won't be reached and the connection pool can have many long-lived connections.
To avoid this problem and save resources, a connection max lifetime(determined by :ref:`db-pool-max-lifetime`, 30 minutes by default) is enforced.
After the max lifetime is reached, connections from the pool will be released and news ones will be created. This doesn't affect running requests, only unused connections will be released.
To avoid this problem and save resources, a connection max lifetime (determined by :ref:`db-pool-max-lifetime`, 30 minutes by default) is enforced.
After the max lifetime is reached, connections from the pool will be released and new ones will be created. This doesn't affect running requests, only unused connections will be released.
Acquisition Timeout
-------------------
If all the available connections in the pool are busy, an HTTP request will wait until reaching a timeout(determined by :ref:`db-pool-acquisition-timeout`, 10 seconds by default).
If all the available connections in the pool are busy, an HTTP request will wait until reaching a timeout (determined by :ref:`db-pool-acquisition-timeout`, 10 seconds by default).
If the request reaches the timeout, it will be aborted with the following response:
@@ -68,9 +68,9 @@ Automatic Recovery
The server will retry reconnecting to the database if connection loss happens.
- It will retry forever with exponential backoff. 32 seconds being the maximum backoff time between retries. Each of these attempts are :ref:`logged <pgrst_logging>`.
- It will retry forever with exponential backoff, with a maximum backoff time of 32 seconds between retries. Each of these attempts are :ref:`logged <pgrst_logging>`.
- It will only stop retrying if the server deems the error to be fatal. This can be a password authentication failure or an internal error.
- The retries happen immediately after a connection loss, if :ref:`db-channel-enabled` is set to true(the default). Otherwise they'll happen once a request arrives.
- The retries happen immediately after a connection loss, if :ref:`db-channel-enabled` is set to true (the default). Otherwise they'll happen once a request arrives.
- To ensure a valid state, the server reloads the :ref:`schema_cache` and :ref:`configuration` when recovering.
- To notify the client of the next retry, the server sends a ``503 Service Unavailable`` status with the ``Retry-After: x`` header. Where ``x`` is the number of seconds programmed for the next retry.
docs/releases/unreleased.rst → docs/releases/v11.1.0.rst
+2 -2
View File
@@ -1,5 +1,5 @@
Unreleased
==========
11.1.0
======
Features
--------