docs: remove schema cache dep from Query

PostgREST · Apr 11, 2024 · b881912 · b881912
1 parent 4bcd672
commit b881912
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 9 deletions.
diff --git a/docs/_diagrams/arch.uml b/docs/_diagrams/arch.uml
@@ -8,31 +8,34 @@ package "PostgREST" {
   [Plan] -r.> [Query]
   [Query] - () "Connection Pool" : "\t"
   [Plan] -u-> [Schema Cache]:uses
-  [Query] -u-> [Schema Cache]:uses
   [Schema Cache] <- () Listener : reloads
 
   () HTTP as HTTPADMIN
   [Admin]  -r- () HTTPADMIN
   [Config] -l- () CLI
-  HTTPADMIN -[hidden]r- CLI
 
+  [Config] <-l~ Listener
+
+  HTTPADMIN -[hidden]r- CLI
   Listener -[hidden]r- [Schema Cache]
-  [Schema Cache] <-l[hidden]- [Config]
+  Listener -[hidden]r- [Config]
+  [Schema Cache] -l[hidden]- [Config]
   [Schema Cache] -l[hidden]- [Admin]
-  [Config] <-l~ Listener
+  [Schema Cache] -l[hidden]- CLI
 }
 
 
 database "PostgreSQL" {
+  node "API schema" as API {
+    rectangle "Functions, Views"
+  }
   node Authorization {
     rectangle "Roles, GRANT, RLS"
   }
-  node API {
-    rectangle "Functions, Views"
-  }
   rectangle "Tables, extensions" as tbs
   API -d- tbs
-  Authorization -d- tbs
+
+ API -[hidden]l- Authorization
 }
 
 :user:

diff --git a/docs/_static/arch.png b/docs/_static/arch.png
diff --git a/src/PostgREST/ApiRequest.hs b/src/PostgREST/ApiRequest.hs
@@ -4,7 +4,7 @@ Description : PostgREST functions to translate HTTP request to a domain type cal
 -}
 {-# LANGUAGE LambdaCase     #-}
 {-# LANGUAGE NamedFieldPuns #-}
-
+-- TODO: This module shouldn't depend on SchemaCache
 module PostgREST.ApiRequest
   ( ApiRequest(..)
   , InvokeMethod(..)

diff --git a/src/PostgREST/Query.hs b/src/PostgREST/Query.hs
@@ -1,5 +1,6 @@
 {-# LANGUAGE NamedFieldPuns  #-}
 {-# LANGUAGE RecordWildCards #-}
+-- TODO: This module shouldn't depend on SchemaCache
 module PostgREST.Query
   ( QueryResult (..)
   , runQuery