Schema reloading

2016-11-13 18:11:50 -08:00
parent 0ae281f15f
commit 8258631b03
1 changed files with 13 additions and 1 deletions
@@ -174,9 +174,21 @@ Once you've verified that requests are as you expect, you can get more informati

 Restart the database and watch the log file in real-time to understand how HTTP requests are being translated into SQL commands.

+Schema Reloading
+----------------
+
+PostgREST's database schema cache is a common source of confusion. Detecting the foreign key relationships between tables (including how those relationships pass through views) is an involved query. To speed up regular API requests the server caches the database schema on startup. However if the schema changes while the server is running it results in a stale cache and failures for :ref:`Resource Embedding`_ in API requests.
+
+To refresh the cache without restarting the PostgREST server, send its process a SIGHUP signal:
+
+.. code:: bash
+
+  killall -HUP postgrest
+
+For the future we're investigating ways to keep the cache updated without an intrusive setup procedure or system resource usage.
+
 .. Administration
 ..   Alternate URL structure
 ..   API Versioning
-..   Schema Reloading
 ..   HTTP Caching
 ..   Upgrading