Skip to content

Commit

Permalink
docs: add config/cli/developer to arch
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-chavez committed Apr 8, 2024
1 parent b91908b commit 2772b78
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
3 changes: 1 addition & 2 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
27 changes: 18 additions & 9 deletions docs/_diagrams/arch.uml
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
@startuml

:user:

package "PostgREST" {
() HTTP as HTTPAPI
HTTPAPI - [Auth]
Expand All @@ -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"
[Schema Cache] <- () Listener : reloads

() HTTP as HTTPADMIN
[Admin] - () HTTPADMIN
[Admin] -r- () HTTPADMIN
[Config] -l- () CLI
HTTPADMIN -[hidden]r- CLI

/'HTTPADMIN <-r[hidden]- [Schema Cache] : "\t\t\t"'/
/'
'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
'/
}


Expand All @@ -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"

Expand All @@ -52,5 +62,4 @@ end note
note top of Listener
LISTEN session
end note

@enduml
Binary file modified docs/_static/arch.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2772b78

Please sign in to comment.