diff --git a/_static/css/custom.css b/_static/css/custom.css index 555afaa1c..50359ce05 100644 --- a/_static/css/custom.css +++ b/_static/css/custom.css @@ -21,3 +21,23 @@ div.line-block { #sponsors img{ margin: 10px; } + +#thanks{ + text-align: center; +} + +#thanks img{ + margin: 10px; +} + +#thanks h2{ + text-align: left; +} + +#thanks p{ + text-align: left; +} + +#thanks ul{ + text-align: left; +} diff --git a/api.rst b/api.rst index 5e7271de5..97f3cf8b7 100644 --- a/api.rst +++ b/api.rst @@ -45,6 +45,8 @@ Complex logic can also be applied: GET /people?and=(grade.gte.90,student.is.true,or(age.gte.14,age.is.null)) HTTP/1.1 +.. _operators: + Operators ~~~~~~~~~ @@ -773,6 +775,8 @@ PostgREST will detect if the function is scalar or table-valued and will shape t { "title": "Blade Runner 2049", "rating": 8.1} ] +.. _bulk_call: + Bulk Call --------- @@ -1147,6 +1151,8 @@ If the stored procedure returns non-scalar values, you need to do a :code:`selec If more than one row would be returned the binary results will be concatenated with no delimiter. +.. _plain_text_output: + Plain Text Output ----------------- diff --git a/configuration.rst b/configuration.rst index f44019b1e..d44096de4 100644 --- a/configuration.rst +++ b/configuration.rst @@ -90,10 +90,13 @@ 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. +.. _db-pool-timeout: + db-pool-timeout --------------- - Time to live for an idle database pool connection. + Time to live for an idle database pool connection. If the timeout is reached the connection will be closed. + Once a new request arrives a new connection will be started. .. _db-extra-search-path: @@ -126,6 +129,8 @@ server-port The TCP port to bind the web server. +.. _server-unix-socket: + server-unix-socket ------------------ diff --git a/index.rst b/index.rst index 3b49b816f..41b8be7aa 100644 --- a/index.rst +++ b/index.rst @@ -65,11 +65,13 @@ Getting Support The project has a friendly and growing community. Join our `chat room `_ for discussion and help. You can also report or search for bugs/features on the Github `issues `_ page. .. toctree:: + :glob: + :reversed: :caption: Release Notes :titlesonly: :hidden: - release_notes.rst + releases/* Tutorials --------- @@ -88,21 +90,6 @@ Are you new to PostgREST? This is the place to start! Also have a look at :doc:`Installation `. -How-to guides -------------- - -These are recipes that'll help you address specific use-cases. - -.. toctree:: - :glob: - :caption: How-to guides - :hidden: - - how-tos/* - -- :doc:`how-tos/embedding-table-from-another-schema` -- :doc:`how-tos/casting-type-to-custom-json` - Reference guides ---------------- @@ -123,6 +110,23 @@ Technical references for PostgREST's functionality. - :doc:`API ` - :doc:`configuration` +.. _how_tos: + +How-to guides +------------- + +These are recipes that'll help you address specific use-cases. + +.. toctree:: + :glob: + :caption: How-to guides + :hidden: + + how-tos/* + +- :doc:`how-tos/embedding-table-from-another-schema` +- :doc:`how-tos/casting-type-to-custom-json` + Topic guides ------------ @@ -167,6 +171,15 @@ PostgREST has a growing ecosystem of examples, libraries, and experiments. Here * :ref:`clientside_libraries` * :ref:`eco_commercial` +Release Notes +------------- + +Here we'll include the most relevant changes so you can migrate to newer versions easily. +You can see the full changelog of each release in the `PostgREST repository `_. + +- :doc:`releases/v6.0.2` +- :doc:`releases/v5.2.0` + In Production ------------- diff --git a/livereload_docs.py b/livereload_docs.py index befcaa35e..03910bd6a 100755 --- a/livereload_docs.py +++ b/livereload_docs.py @@ -7,6 +7,7 @@ server = Server() server.watch('*.rst', shell('sphinx-build -b html -a -n . _build')) server.watch('tutorials/*.rst', shell('sphinx-build -b html -a -n . _build')) server.watch('how-tos/*.rst', shell('sphinx-build -b html -a -n . _build')) +server.watch('releases/*.rst', shell('sphinx-build -b html -a -n . _build')) # For custom port and host -# server.serve(port=8080, host='192.168.1.2') -server.serve(root='_build/') +server.serve(root='_build/', host='192.168.1.2') +# server.serve(root='_build/') diff --git a/release_notes.rst b/release_notes.rst deleted file mode 100644 index e69de29bb..000000000 diff --git a/releases/v5.2.0.rst b/releases/v5.2.0.rst new file mode 100644 index 000000000..43bc18833 --- /dev/null +++ b/releases/v5.2.0.rst @@ -0,0 +1,26 @@ +v5.2.0 +====== + +* `Explicit qualification `_ introduced in ``v5.0`` is no longer necessary, this section will not be included from this version onwards. A :ref:`db-extra-search-path` configuration parameter was introduced to avoid the need to explictly qualify database objects. If you install PostgreSQL extensions on the ``public`` schema, they'll work normally from now on. + +* Now you can filter :ref:`tabs-cols-w-spaces`. + +* Included the ability to quote columns that have :ref:`reserved-chars`. + +* Thanks to `Zhou Feng `_, now is possible to reference an external file in :ref:`db-uri`. + +* Thanks to `Russell Davies `_, Json Web Key Sets are now accepted by :ref:`jwt-secret`. + +Thanks +------ + +This release was made possible thanks to: + +* `Daniel Babiak `_ +* `Michel Pelletier `_ +* Tsingson Qin +* Jay Hannah +* Victor Adossi +* Petr Beles + +If you like to join them please consider `supporting PostgREST development `_. diff --git a/releases/v6.0.2.rst b/releases/v6.0.2.rst new file mode 100644 index 000000000..774ac61bb --- /dev/null +++ b/releases/v6.0.2.rst @@ -0,0 +1,79 @@ +.. |br| raw:: html + +
+ +v6.0.2 +====== + +Full changelog is available at `PostgREST releases page `_. + +Added +----- + +* Ignoring payload keys for insert/update can be now done with the ``?columns`` query parameter. See :ref:`specify_columns`. + |br| -- `@steve-chavez `_ + +* `websearch_to_tsquery `_ can now be used + through the ``wfts`` operator. See :ref:`fts`. + |br| -- `@herulume `_ + +* Resource Embedding on materialized views is now possible. See :ref:`embedding_views`. + |br| -- `@vitorbaptista `_ + +* Bulk calling an RPC is now allowed. See :ref:`bulk_call`. + |br| -- `@steve-chavez `_ + +* It's now possible to request a ``text/plain`` output. See :ref:`plain_text_output`. + |br| -- `@steve-chavez `_ + +* Config option for specifying PostgREST database pool timeout. See :ref:`db-pool-timeout`. + |br| -- `@Qu4tro `_ + +* Config option for binding the PostgREST web server to an unix socket. See :ref:`server-unix-socket`. + |br| -- `@Dansvidania `_ + +* Config option for extending the supported media types. See :ref:`raw-media-types`. + |br| -- `@Dansvidania `_ + +* We now offer an statically linked binary for Linux. Look for **postgrest--linux-x64-static.tar.xz** on the + `releases page `_. + |br| -- `@clojurians-org `_ + +* A :ref:`how_tos` section was added to the documentation. + +Changed +------- + +* ``SIGHUP`` support was removed. You should use ``SIGUSR1`` instead. See :ref:`schema_reloading`. + +* server-host default of ``127.0.0.1`` was changed to ``!4``. See :ref:`server-host`. + +Thanks +------ + +This release was sponsored by: + +.. image:: ../_static/cybertec.png + :target: https://www.cybertec-postgresql.com/en/ + :width: 13em + +.. image:: ../_static/2ndquadrant.png + :target: https://www.2ndquadrant.com/en/?utm_campaign=External%20Websites&utm_source=PostgREST&utm_medium=Logo + :width: 13em + +.. image:: ../_static/retool.png + :target: https://tryretool.com/?utm_source=sponsor&utm_campaign=postgrest + :width: 13em + +* Daniel Babiak +* Evans Fernandes +* Tsingson Qin +* Michel Pelletier +* Jay Hannah +* Robert Stolarz +* Kofi Gumbs +* Nicholas DiBiase +* Christopher Reid +* Nathan Bouscal + +If you like to join them please consider `supporting PostgREST development `_.