From 3af3371e1ec629cf82be79bc02fe5452636d5a5e Mon Sep 17 00:00:00 2001 From: steve-chavez Date: Wed, 5 Mar 2025 18:37:10 -0500 Subject: [PATCH] docs: add note about Plan in architecture page Also add links to the ApiRequest, Plan and Query components in the diagram. --- docs/_diagrams/uml/arch.uml | 7 +++++++ docs/_static/arch-dark.svg | 2 +- docs/_static/arch.svg | 2 +- docs/_static/sch-iso-dark.svg | 2 +- docs/_static/sch-iso.svg | 2 +- docs/explanations/architecture.rst | 2 +- 6 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/_diagrams/uml/arch.uml b/docs/_diagrams/uml/arch.uml index d61a1a82e..4f3844f57 100644 --- a/docs/_diagrams/uml/arch.uml +++ b/docs/_diagrams/uml/arch.uml @@ -60,6 +60,10 @@ note bottom of ApiRequest Parses the URL syntax end note +note bottom of Plan + Generates internal AST +end note + note bottom of Query Generates the SQL end note @@ -71,6 +75,9 @@ end note url of Admin is [[../references/admin_server.html#admin-server]] url of API is [[../explanations/schema_isolation.html]] url of Auth is [[../references/auth.html#authn]] +url of ApiRequest is [[../explanations/architecture.html#api-request]] +url of Plan is [[../explanations/architecture.html#plan]] +url of Query is [[../explanations/architecture.html#query]] url of Authorization is [[../explanations/db_authz.html]] url of CLI is [[../references/cli.html#cli]] url of "Connection Pool" is [[../references/connection_pool.html]] diff --git a/docs/_static/arch-dark.svg b/docs/_static/arch-dark.svg index f55c127c4..ac80be588 100644 --- a/docs/_static/arch-dark.svg +++ b/docs/_static/arch-dark.svg @@ -1 +1 @@ -PostgRESTPostgreSQLAuthorizationAPI schemaHTTPAuthApiRequestPlanQueryConnection PoolSchema CacheListenerHTTPAdminConfigCLITables, extensionsRoles, GRANT, RLSFunctions, ViewsuserProxyoperatordeveloperAuthenticates the user requestParses the URL syntaxGenerates the SQLLISTEN sessionusesreloads \ No newline at end of file +PostgRESTPostgreSQLAuthorizationAPI schemaHTTPAuthApiRequestPlanQueryConnection PoolSchema CacheListenerHTTPAdminConfigCLITables, extensionsRoles, GRANT, RLSFunctions, ViewsuserProxyoperatordeveloperAuthenticates the user requestParses the URL syntaxGenerates internal ASTGenerates the SQLLISTEN sessionusesreloads \ No newline at end of file diff --git a/docs/_static/arch.svg b/docs/_static/arch.svg index b2005f268..0fca584e4 100644 --- a/docs/_static/arch.svg +++ b/docs/_static/arch.svg @@ -1 +1 @@ -PostgRESTPostgreSQLAuthorizationAPI schemaHTTPAuthApiRequestPlanQueryConnection PoolSchema CacheListenerHTTPAdminConfigCLITables, extensionsRoles, GRANT, RLSFunctions, ViewsuserProxyoperatordeveloperAuthenticates the user requestParses the URL syntaxGenerates the SQLLISTEN sessionusesreloads \ No newline at end of file +PostgRESTPostgreSQLAuthorizationAPI schemaHTTPAuthApiRequestPlanQueryConnection PoolSchema CacheListenerHTTPAdminConfigCLITables, extensionsRoles, GRANT, RLSFunctions, ViewsuserProxyoperatordeveloperAuthenticates the user requestParses the URL syntaxGenerates internal ASTGenerates the SQLLISTEN sessionusesreloads \ No newline at end of file diff --git a/docs/_static/sch-iso-dark.svg b/docs/_static/sch-iso-dark.svg index bf6c8a0d5..3d6dba754 100644 --- a/docs/_static/sch-iso-dark.svg +++ b/docs/_static/sch-iso-dark.svg @@ -1 +1 @@ -PostgreSQLpublicapitablesextensionsviews + functionsPostgREST \ No newline at end of file +PostgreSQLpublicapitablesextensionsviews + functionsPostgREST \ No newline at end of file diff --git a/docs/_static/sch-iso.svg b/docs/_static/sch-iso.svg index 0a54cba0f..3de5a417f 100644 --- a/docs/_static/sch-iso.svg +++ b/docs/_static/sch-iso.svg @@ -1 +1 @@ -PostgreSQLpublicapitablesextensionsviews + functionsPostgREST \ No newline at end of file +PostgreSQLpublicapitablesextensionsviews + functionsPostgREST \ No newline at end of file diff --git a/docs/explanations/architecture.rst b/docs/explanations/architecture.rst index 23a377518..9dd2b0832 100644 --- a/docs/explanations/architecture.rst +++ b/docs/explanations/architecture.rst @@ -58,7 +58,7 @@ A request might be rejected at this level if it's invalid. For example when prov Plan ---- -Using the Schema Cache, `Plan.hs `_ fills in out-of-band SQL details (like an ``ON CONFLICT (pk)`` clause) required to complete the user request. +Using the Schema Cache, `Plan.hs `_ generates an internal AST, filling out-of-band SQL details (like an ``ON CONFLICT (pk)`` clause) required to complete the user request. A request might be rejected at this level if it's invalid. For example when doing resource embedding on a nonexistent resource.