Skip to content

Commit b2da203

Browse files
author
Yaroslaff Fedin
authored
Update README.md
Make fork readme notes less scary
1 parent 68deeae commit b2da203

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,24 @@ Response is generated in `rds` format, so it's compatible with `ngx_rds_json`
77
and `ngx_drizzle` modules.
88

99

10-
FORK
11-
====
10+
Community fork
11+
==============
1212

13-
This is an amateurish fork that adds a bunch of questionable stuff:
13+
This is a fork that adds a bunch of new features:
1414

15-
* It adds prepared statements (bound directly to nginx variables). For each connection in pool it keeps its own set of prepared statements. Seemed to work decently.
16-
* It adds json output option to format rows as json arrays
17-
* It allows postgres_rewrite to make redirects (with interpolations)
18-
19-
Even more questionable features:
20-
21-
* Include substring of SQL query from JSON by key
22-
* Adds `errors` and `no_errors` conditions that check if response json has any `error:` or `errors:` keys in it (nested)
23-
*
24-
25-
With this i'm trying to close the gaps of building a foundation for Rails-like REST system. It got good stuff (prepared statements) mixed with weird/opinionated stuff (query substitution from json). If anybody (of ngx_postgres developers?) would like to work on incorporating parts of this into mainline - drop me a line at invizko@gmail.com
15+
Postgres additions (by @Inviz)
16+
* **prepared statements** (bound directly to nginx variables). For each connection in pool it keeps its own set of prepared statements.
17+
* **json output** option to format rows as json arrays
18+
* postgres_rewrite can now make **redirects** (with interpolations)
19+
* **`errors`** and **`no_errors`** rewrite conditions that look for `error:` or `errors:` in json response
2620

21+
Server additions (by @cryptofuture)
22+
* **socket** support for pg connection
23+
* **dynamic module** loading support
2724

2825
Status
2926
======
30-
This module is production-ready and it's compatible with following nginx
27+
This is a **fork** which is less battle-tested that mainline project. Original version of the module is production-ready and it's compatible with following nginx
3128
releases:
3229

3330
- 0.7.x (tested with 0.7.60 to 0.7.69),

0 commit comments

Comments
 (0)