postgresai 0.18.0-dev.11 → 0.18.0-dev.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -4
- package/dist/bin/postgres-ai.js +729 -128
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -224,13 +224,19 @@ the Console (Monitoring, then the instance). A database that must stay behind an
|
|
|
224
224
|
needs AWS PrivateLink (RDS) or self-hosted monitoring (`--self-hosted`).
|
|
225
225
|
|
|
226
226
|
Without `--provider`, RDS hostnames still go to their console integration, and Supabase hostnames to the Supabase consent flow (`pgai mon deploy` for Supabase).
|
|
227
|
+
|
|
228
|
+
A Supabase project needs no URL at all: `pgai mon deploy --provider supabase` connects the Supabase organization
|
|
229
|
+
if needed and lists its projects. At a terminal you pick one; agents and scripts pass
|
|
230
|
+
`--supabase-project <name or project ID>`. Without either, with `--yes`, or not at a terminal, it stops (exit 3) with the list
|
|
231
|
+
in the JSON result (`projects`, each with `selectable` and `reason`). The vCPUs come from the project's compute size.
|
|
232
|
+
|
|
227
233
|
`generic` does not configure AWS PrivateLink, open a firewall, or remove TLS, permission, or
|
|
228
234
|
payment checks. A private endpoint needs a network path, or monitoring hosted in that network
|
|
229
235
|
(`--self-hosted`).
|
|
230
236
|
|
|
231
237
|
`pgai mon deploy` and `pgai dblab deploy` share their options and results: the database URL as the
|
|
232
|
-
argument (or `--db-url`), `--name` (default: from the database), `--location` (
|
|
233
|
-
|
|
238
|
+
argument (or `--db-url`), `--name` (default: from the database), `--cloud` and `--location` (where the box
|
|
239
|
+
runs; see the table), `--wait <minutes>` / `--no-wait`, `--yes` (never prompt), `--json`, the
|
|
234
240
|
`status` words and exit codes below, and `instances list | watch | delete`, which take an id or a name
|
|
235
241
|
(a name two instances have is refused, with their ids). `watch` is also `status`.
|
|
236
242
|
|
|
@@ -256,11 +262,12 @@ terminal, or with `--json`, it only points to `pgai mon deploy`.
|
|
|
256
262
|
| `--monitoring-user <name>` | the monitoring role to create or use (default `postgres_ai_mon`; at most 63 bytes; MCP: `monitoring_user`). A custom role always carries its own password: PostgresAI keeps only `postgres_ai_mon`'s, so creating or resetting a custom role needs `PGAI_MON_PASSWORD` (an agent passes the role's URL). A name with `'`, `$`, `%`, backslash or a control character is refused, and so is a role that is a superuser or has `CREATEDB`, `CREATEROLE`, `REPLICATION` or `BYPASSRLS`, is a member of a role other than `pg_monitor`, `pg_read_all_stats`, `pg_read_all_settings` and `pg_stat_scan_tables` (directly or through other roles, also through `pg_monitor` itself), owns objects, has grants in another database of the server, or has grants in the database beyond `CONNECT`, `USAGE` on schemas other than `pg_toast`, `SELECT` outside `pg_catalog` and `pg_toast`, and the grants pgai makes, or holds any grant `WITH GRANT OPTION` or a membership `WITH ADMIN OPTION`. So a custom role used for databases on one server is refused for the second one. `SELECT` on application tables and views is allowed, including a view over `pg_authid`: what a role may read through views is the owner's choice. Ignored for a host handed to the Console (RDS); refused for Supabase, where PostgresAI creates `postgres_ai_mon` through the Supabase Management API |
|
|
257
263
|
| `--db-url <url>` | the database URL, instead of the argument |
|
|
258
264
|
| `--name <name>` | the instance's name (default: `host[:port]/database`); ignored, with a note, for a database already monitored |
|
|
259
|
-
| `--
|
|
265
|
+
| `--cloud <cloud>` | `mon deploy`: `aws` or `hetzner`; default: the database's cloud (its RDS, Aurora, EC2 or Supabase region), else AWS. `dblab deploy`: `hetzner`, `aws` or `gcp` (default `hetzner`) |
|
|
266
|
+
| `--location <location>` | a location of that cloud: an AWS region, or a Hetzner location (`fsn1`, `nbg1`, `hel1`, `ash`, `hil`). `mon deploy` default: the database's region, else us-east-1 on AWS; a location of another cloud is refused before anything is created |
|
|
260
267
|
| `--vcpus <n>` | `mon deploy` only: the database server's vCPUs. Without it there is no AAS (database load) data; at a terminal you are asked. On a database already monitored, it sets missing vCPUs (a set value is changed with `mon instances set`) |
|
|
261
268
|
| `--wait <minutes>` | how long to wait for the monitoring box; `0` does not wait (default 20) |
|
|
262
269
|
| `--no-wait` | the same as `--wait 0` |
|
|
263
|
-
| `-y, --yes` | never prompt
|
|
270
|
+
| `-y, --yes` | never prompt: deploy where shown and accept the price (`mon deploy` does not start the browser sign-in; `mon instances delete` does not ask). Without it, `mon deploy` asks before creating any box, free or billed, and at a terminal lets you choose another cloud and location; not at a terminal it stops (exit 3) with the place, the price and `choices` |
|
|
264
271
|
| `--coupon <code>` | promotion code for the organization's monitoring subscription |
|
|
265
272
|
| `--json` | JSON output, also on a terminal |
|
|
266
273
|
|