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

Reorder release notes for v8.0

Browse Source
This commit is contained in:
steve-chavez
2021-08-10 00:26:24 -05:00
parent ff30d4d417
commit fcabf4012b
4 changed files with 37 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
admin.rst
+2 -2
View File
@@ -148,14 +148,14 @@ Logging
PostgREST logs basic request information to ``stdout``, including the requesting IP address and user agent, the URL requested, and HTTP response status.
.. code-block::
.. code-block:: none
127.0.0.1 - - [26/Jul/2021:01:56:38 -0500] "GET /clients HTTP/1.1" 200 - "" "curl/7.64.0"
127.0.0.1 - - [26/Jul/2021:01:56:48 -0500] "GET /unexistent HTTP/1.1" 404 - "" "curl/7.64.0"
For diagnostic information about the server itself, PostgREST logs to ``stderr``.
.. code-block::
.. code-block:: none
12/Jun/2021:17:47:39 -0500: Attempting to connect to the database...
12/Jun/2021:17:47:39 -0500: Listening on port 3000
configuration.rst
+3 -3
View File
@@ -404,7 +404,7 @@ To reload the configuration without restarting the PostgREST server, send a SIGU
killall -SIGUSR2 postgrest
This method does not reload :ref:`env_variables_config` and it will not work for reloading a Docker container configuration. In these cases, you need to restart the PostgREST server or use :ref:`in_db_config` as an alternative.
This method does not reload :ref:`env_variables_config` and it will not work for reloading a Docker container configuration. In these cases, you need to restart the PostgREST server or use the :ref:`in_db_config` as an alternative.
.. important::
@@ -433,12 +433,12 @@ For example, you can configure :ref:`db-schema` and :ref:`jwt-secret` like this:
ALTER ROLE authenticator SET pgrst.db_schema = "tenant1, tenant2, tenant3"
ALTER ROLE authenticator SET pgrst.jwt_secret = "REALLYREALLYREALLYREALLYVERYSAFE"
Note that underscores(``_``) need to be used instead of dashes(``-``) for the in-database config options.
.. important::
For altering a role in this way, you need a SUPERUSER. You might not be able to use this configuration mode on cloud-hosted databases.
Note that underscores(``_``) need to be used instead of dashes(``-``) for the options when the configuration is inside the database.
When using both the configuration file and the in-database configuration, the latter takes precedence.
.. danger::
releases/v8.0.0.rst
+29 -35
View File
@@ -19,7 +19,7 @@ Added
* Allow :ref:`embedding_view_chains` recursively to any depth.
|br| -- `@wolfgangwalther <https://github.com/wolfgangwalther>`_
* No downtime when reloading the schema cache. See the note in :ref:`schema_reloading`.
* No downtime when reloading the schema cache. See :ref:`schema_reloading`.
|br| -- `@steve-chavez <https://github.com/steve-chavez>`_
* Allow schema cache reloading using PostgreSQL :ref:`NOTIFY <schema_reloading_notify>` command. This enables :ref:`auto_schema_reloading`.
@@ -63,6 +63,34 @@ Added
+ Added the :ref:`schema_cache` page.
+ Moved the :ref:`schema_reloading` reference from :ref:`admin` to :ref:`schema_cache`
Changed
-------
* Docker images are now optimized to be built from the scratch image. This reduces the compressed image size from over 30 MB to about 4 MB.
For more details, see `Docker image built with Nix <https://github.com/PostgREST/postgrest/tree/main/nix/tools/docker#user-content-docker-image-built-with-nix>`_.
|br| -- `@monacoremo <https://github.com/monacoremo>`_
* The Docker image no longer has an internal ``/etc/postgrest.conf`` file, you must use :ref:`env_variables_config` to configure it.
|br| -- `@wolfgangwalther <https://github.com/wolfgangwalther>`_
* The ``pg_listen`` `utility <https://github.com/begriffs/pg_listen>`_ is no longer needed to automatically reload the schema cache
and it's replaced entirely by database notifications. See :ref:`auto_schema_reloading`.
|br| -- `@steve-chavez <https://github.com/steve-chavez>`_
* POST requests for insertions no longer include a ``Location`` header in the response by default and behave the same way as having a
``Prefer: return=minimal`` header in the request. This prevents permissions errors when having a write-only table. See :ref:`insert_update`.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
* Modified the default logging level from ``info`` to ``error``. See :ref:`log-level`.
|br| -- `@steve-chavez <https://github.com/steve-chavez>`_
* Changed the error message for a not found RPC on a stale schema (see :ref:`stale_function_signature`) and for the unsupported case of
overloaded functions with the same argument names but different types.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
* Changed the error message for the no relationship found error. See :ref:`stale_fk_relationships`.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
Fixed
-----
@@ -111,40 +139,6 @@ Fixed
* Fix requests for overloaded functions from HTML forms to no longer hang.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
* Add a hint and clarification to the no relationship found error.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
* Show comprehensive error when an RPC is not found in a stale schema cache.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
* Fix Location headers in headers only representation for null PK inserts on views.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
Changed
-------
* Docker images are now optimized to be built from the scratch image. This reduces the compressed image size from over 30 MB to about 4 MB.
For more details, see `Docker image built with Nix <https://github.com/PostgREST/postgrest/tree/main/nix/tools/docker#user-content-docker-image-built-with-nix>`_.
|br| -- `@monacoremo <https://github.com/monacoremo>`_
* The Docker image no longer has an internal ``/etc/postgrest.conf`` file, you must use :ref:`env_variables_config` to configure it.
|br| -- `@wolfgangwalther <https://github.com/wolfgangwalther>`_
* The ``pg_listen`` `utility <https://github.com/begriffs/pg_listen>`_ is no longer needed to automatically reload the schema cache
and it's replaced entirely by database notifications. See :ref:`schema_reloading_notify`.
|br| -- `@steve-chavez <https://github.com/steve-chavez>`_
* Improved error message for a not found RPC on a stale schema (see :ref:`stale_function_signature`) and for the unsupported case of
overloaded functions with the same argument names but different types.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
* Modified the default logging level from ``info`` to ``error``. See :ref:`log-level`.
|br| -- `@steve-chavez <https://github.com/steve-chavez>`_
* POST requests for insertions no longer include a ``Location`` header in the response by default and behave the same way as having a
``Prefer: return=minimal`` header in the request. This prevents permissions errors when having a write-only table. See :ref:`insert_update`.
|br| -- `@laurenceisla <https://github.com/laurenceisla>`_
Thanks
------
schema_cache.rst
+3 -3
View File
@@ -34,6 +34,8 @@ When you make changes on the metadata mentioned above, the schema cache will tur
For instance, let's see what would happen if you have a stale schema cache for foreign key relationships and function signatures.
.. _stale_fk_relationships:
Stale Foreign Key Relationships
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -102,9 +104,7 @@ For docker you can do:
# or in docker-compose
docker-compose kill -s SIGUSR1 <service>
.. note::
There's no downtime when reloading the schema cache. The reloading will happen on a background thread while requests keep being served.
There's no downtime when reloading the schema cache. The reloading will happen on a background thread while requests keep being served.
.. _schema_reloading_notify: