diff --git a/docs/admin.rst b/docs/admin.rst index 36b9e5e6f..3f427feac 100644 --- a/docs/admin.rst +++ b/docs/admin.rst @@ -272,7 +272,7 @@ To do this, set the configuration variable :ref:`admin-server-port` to the port The ``live`` endpoint verifies if PostgREST is running on its configured port. A request will return ``200 OK`` if PostgREST is alive or ``503`` otherwise. -The ``ready`` endpoint also checks the state of both the Database Connection and the :ref:`schema_cache`. A request will return ``200 OK`` if it is ready or ``503`` if not. +The ``ready`` endpoint also checks the state of both the Database Connection and the :doc:`Schema Cache `. A request will return ``200 OK`` if it is ready or ``503`` if not. For instance, to verify if PostgREST is running at ``localhost:3000`` while the ``admin-server-port`` is set to ``3001``: diff --git a/docs/errors.rst b/docs/errors.rst index 2d13faa98..e4bc89000 100644 --- a/docs/errors.rst +++ b/docs/errors.rst @@ -23,7 +23,7 @@ For the most part, error messages will come directly from the database with the "message": "relation \"api.nonexistent_table\" does not exist" } -However, some errors do come from PostgREST itself (such as those related to the :ref:`schema_cache`). These have the same structure as the PostgreSQL errors but are differentiated by the ``PGRST`` prefix in the ``code`` field (see :ref:`pgrst_errors`). For instance, when querying a function that does not exist, the error will be: +However, some errors do come from PostgREST itself (such as those related to the :doc:`Schema Cache `). These have the same structure as the PostgreSQL errors but are differentiated by the ``PGRST`` prefix in the ``code`` field (see :ref:`pgrst_errors`). For instance, when querying a function that does not exist, the error will be: .. code-block:: http @@ -137,8 +137,8 @@ Related to the connection with the database. | PGRST001 | | | +---------------+-------------+-------------------------------------------------------------+ | .. _pgrst002: | 503 | Could not connect with the database when building the | -| | | :ref:`schema_cache` due to the PostgreSQL service not | -| PGRST002 | | running. | +| | | :doc:`Schema Cache ` | +| PGRST002 | | due to the PostgreSQL service not running. | +---------------+-------------+-------------------------------------------------------------+ | .. _pgrst003: | 504 | The request timed out waiting for a pool connection | | | | to be available. See :ref:`db-pool-acquisition-timeout`. | diff --git a/docs/schema_cache.rst b/docs/schema_cache.rst index c966a3990..9751e4d51 100644 --- a/docs/schema_cache.rst +++ b/docs/schema_cache.rst @@ -1,7 +1,8 @@ .. _schema_cache: -Schema Cache -============ +.. raw:: html + +

Schema Cache

Certain PostgREST features require metadata from the database schema. Getting this metadata requires executing expensive queries, so in order to avoid repeating this work, PostgREST uses a schema cache.