From 04e6c09f145d13e38e72280422a59a3c3fc9cf15 Mon Sep 17 00:00:00 2001 From: Anastasia Lubennikova Date: Tue, 31 Oct 2023 13:29:25 +0000 Subject: [PATCH] Add pgxn/neon/README.md --- pgxn/neon/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 pgxn/neon/README.md diff --git a/pgxn/neon/README.md b/pgxn/neon/README.md new file mode 100644 index 0000000000..39311aba82 --- /dev/null +++ b/pgxn/neon/README.md @@ -0,0 +1,20 @@ +neon extension consists of several parts: + +### shared preload library `neon.so` + +- implements storage manager API and network communications with remote page server. + +- walproposer: implements broadcast protocol between postgres and WAL safekeepers. + +- control plane connector: Captures updates to roles/databases using ProcessUtility_hook and sends them to the control ProcessUtility_hook. + +- remote extension server: Request compute_ctl to download extension files. + +- file_cache: Local file cache is used to temporary store relations pages in local file system for better performance. + +- relsize_cache: Relation size cache for better neon performance. + +### SQL functions in `neon--*.sql` + +Utility functions to expose neon specific information to user and metrics collection. +This extension is created in all databases in the cluster by default.