You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+68-1Lines changed: 68 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,69 @@
2
2
3
3
A RESTful API for managing your Postgres. Fetch tables, add roles, and run queries (and more).
4
4
5
+
## Documentation
6
+
7
+
https://supabase.github.io/postgres-meta/
8
+
9
+
## Progress
10
+
11
+
Schema:
12
+
13
+
-[x]`POST /query` (Execute SQL query)
14
+
-[x]`/columns`
15
+
-[X] GET (List)
16
+
-[X] POST (`alter table add column`)
17
+
-[X] PATCH (`alter table alter/rename column`)
18
+
-[X] DELETE (`alter table drop column`)
19
+
-[x]`/extensions`
20
+
-[X] GET (List)
21
+
-[X] POST (`create extension`)
22
+
-[X] PATCH (`alter extension`)
23
+
-[X] DELETE (`drop extension`)
24
+
-[ ]`/functions`
25
+
-[x] GET (List)
26
+
-[ ] POST (`create function`)
27
+
-[ ] PATCH (`alter function`)
28
+
-[ ] DELETE (`drop function`)
29
+
-[x]`/publications`
30
+
-[X] GET (List)
31
+
-[X] POST (`create publication`)
32
+
-[X] PATCH (`alter publication`)
33
+
-[X] DELETE (`drop publication`)
34
+
-[x]`/roles`
35
+
-[x] GET (List)
36
+
-[x] POST (`create role`)
37
+
-[x] PATCH (`alter role`)
38
+
-[x] DELETE (`drop role`)
39
+
-[x]`/schemas`
40
+
-[X] GET (List)
41
+
-[X] POST (`create schema`)
42
+
-[X] PATCH (`alter schema`)
43
+
-[X] DELETE (`drop schema`)
44
+
-[x]`/tables`
45
+
-[X] GET (List)
46
+
-[X] POST (`create table`)
47
+
-[X] PATCH (`alter table`)
48
+
-[X] DELETE (`drop table`)
49
+
-[x]`/triggers`
50
+
-[X] GET (List)
51
+
-[X] POST (`create trigger`)
52
+
-[X] PATCH (`alter trigger`)
53
+
-[X] DELETE (`drop trigger`)
54
+
-[ ]`/types`
55
+
-[x] GET (List)
56
+
-[ ] POST (`create type`)
57
+
-[ ] PATCH (`alter type`)
58
+
-[ ] DELETE (`drop type`)
59
+
60
+
Helpers:
61
+
62
+
-[ ]`/config`
63
+
-[ ] GET `/version`: Postgres version
64
+
-[ ]`/generators`
65
+
-[ ] GET `/openapi`: Generate Open API
66
+
-[ ] GET `/typescript`: Generate Typescript types
67
+
5
68
## Quickstart
6
69
7
70
Set the following ENV VARS:
@@ -19,9 +82,13 @@ Then run any of the binaries in the releases.
19
82
20
83
## FAQs
21
84
85
+
**Why*?*
86
+
87
+
This servers as a light-weight connection pooler. It also normalises the Postgres system catalog into a more readable format. While it it a lot of reinventing right now, this server will eventually provide helpers (such as type generators). The server is multi-tenant, so it can support multiple Postgres databases from a single server.
88
+
22
89
**What security does this use?**
23
90
24
-
None. Please don't use this as a standalone server. We are assuming you are using this behind a proxy which brings its own security, on your local machine, or using this internally with no access to the outside world. This is designed to be used as a part of a larger system.
91
+
None. Please don't use this as a standalone server. This should be used behind a proxy in a trusted environment, on your local machine, or using this internally with no access to the outside world.
0 commit comments