diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 3cb8f8366..6d0490c3a 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -32,8 +32,7 @@ A request might be rejected at this level if it's invalid. For example when prov ### Plan -Using the Schema Cache, this module enables more complex functionality (like resource embedding) by enriching the ApiRequest. It generates intermediate Plan types -that then will be used for the next step. +Using the Schema Cache, this module fills in SQL details that the user might have not specified (like an `ON CONFLICT (pk)` clause ). A request might be rejected at this level if it's invalid. For example when doing resource embedding on a nonexistent resource. diff --git a/docs/_diagrams/arch.uml b/docs/_diagrams/arch.uml index 0a2d7d729..503f15d64 100644 --- a/docs/_diagrams/arch.uml +++ b/docs/_diagrams/arch.uml @@ -1,7 +1,4 @@ @startuml - -:user: - package "PostgREST" { () HTTP as HTTPAPI HTTPAPI - [Auth] @@ -11,11 +8,19 @@ package "PostgREST" { [Query] - () "Connection Pool" : "\t" [Plan] -u-> [Schema Cache]:uses [Query] -u-> [Schema Cache]:uses - [Schema Cache] <- () Listener : reloads "\t" - () HTTP as HTTPADMIN - [Admin] - () HTTPADMIN + [Schema Cache] <- () Listener : reloads - /'HTTPADMIN <-r[hidden]- [Schema Cache] : "\t\t\t"'/ + () HTTP as HTTPADMIN + [Admin] -r- () HTTPADMIN + [Config] -l- () CLI + HTTPADMIN -[hidden]r- CLI + + /' + 'the listener reloads the config. Too much detail, the arrows are crosssed. + '[Schema Cache] <-l[hidden]- [Config] + '[Schema Cache] <-l[hidden]- [Admin] + '[Config] <-l~ () Listener : reloads + '/ } @@ -30,9 +35,14 @@ database "PostgreSQL" { API -d- texts } -HTTPAPI <.l- user : "\t" -operator .d-> HTTPADMIN +HTTPAPI <.l- :user: : "\t" + +:operator: .-> HTTPADMIN +:operator: .-> CLI + + +PostgreSQL <.developer : "\t" Listener -r.> "PostgreSQL" "Connection Pool" -r.> "PostgreSQL" : "\t\t" @@ -52,5 +62,4 @@ end note note top of Listener LISTEN session end note - @enduml diff --git a/docs/_static/arch.png b/docs/_static/arch.png index f06ea0b81..5e1848748 100644 Binary files a/docs/_static/arch.png and b/docs/_static/arch.png differ