schema cache title is redundant on navbar

Use a raw html title for correcting this
This commit is contained in:
steve-chavez
2023-05-03 17:47:54 -03:00
committed by Steve Chavez
parent 4fb13ebae6
commit 837df8b045
3 changed files with 7 additions and 6 deletions
+1 -1
View File
@@ -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 ``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 <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``: For instance, to verify if PostgREST is running at ``localhost:3000`` while the ``admin-server-port`` is set to ``3001``:
+3 -3
View File
@@ -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" "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 <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 .. code-block:: http
@@ -137,8 +137,8 @@ Related to the connection with the database.
| PGRST001 | | | | PGRST001 | | |
+---------------+-------------+-------------------------------------------------------------+ +---------------+-------------+-------------------------------------------------------------+
| .. _pgrst002: | 503 | Could not connect with the database when building the | | .. _pgrst002: | 503 | Could not connect with the database when building the |
| | | :ref:`schema_cache` due to the PostgreSQL service not | | | | :doc:`Schema Cache <schema_cache>` |
| PGRST002 | | running. | | PGRST002 | | due to the PostgreSQL service not running. |
+---------------+-------------+-------------------------------------------------------------+ +---------------+-------------+-------------------------------------------------------------+
| .. _pgrst003: | 504 | The request timed out waiting for a pool connection | | .. _pgrst003: | 504 | The request timed out waiting for a pool connection |
| | | to be available. See :ref:`db-pool-acquisition-timeout`. | | | | to be available. See :ref:`db-pool-acquisition-timeout`. |
+3 -2
View File
@@ -1,7 +1,8 @@
.. _schema_cache: .. _schema_cache:
Schema Cache .. raw:: html
============
<h1>Schema Cache</h1>
Certain PostgREST features require metadata from the database schema. Getting this metadata requires executing expensive queries, so 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. in order to avoid repeating this work, PostgREST uses a schema cache.