@madewithremy/admin 0.1.68 → 0.1.69

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/dist/ops/db.d.ts CHANGED
@@ -19,6 +19,10 @@ import type { DbHistoryPurgeResult, DbHistoryResult, DbQueryResult } from '../ty
19
19
  * too large) throws with `errorString: 'sql_error'`, and the body's
20
20
  * `errorMessage` is the database's own message.
21
21
  *
22
+ * A statement that changes live is recorded in the workspace's audit log:
23
+ * who ran it and when, which database and how many rows changed, never the
24
+ * SQL.
25
+ *
22
26
  * @param sql The SQL statement to execute.
23
27
  * @throws AdminApiError `no_live_release` (404) — the app has not been
24
28
  * deployed; `no_database` (404) — the live release has no database;
@@ -70,9 +74,10 @@ export declare function historyQuery(ctx: AdminContext, releaseId: string, sql:
70
74
  /**
71
75
  * Run one SQL statement against live with a past release's database attached
72
76
  * as the schema `history`: `history.<table>` is the past table, and an
73
- * unqualified name is live's. Writes to live are real, as with `query`, and
74
- * run in one transaction; the attached copy is private to the call, so
75
- * nothing written into it lasts.
77
+ * unqualified name is live's. Writes to live are real, as with `query`, run
78
+ * in one transaction, and are recorded in the workspace's audit log as
79
+ * `query`'s are; the attached copy is private to the call, so nothing
80
+ * written into it lasts.
76
81
  *
77
82
  * A past database larger than 1 GB can't be attached: read it with
78
83
  * `historyQuery` instead, and write what's needed to live with `query`.
package/dist/prod.js CHANGED
@@ -2457,6 +2457,10 @@ Notes:
2457
2457
  SQL don't parse flags, so a statement may safely begin with a '--'
2458
2458
  comment. Always quote the SQL.
2459
2459
  - The history commands use the database named as live's default.
2460
+ - A 'db query' or 'db history attach' that changes live is recorded in the
2461
+ workspace's audit log, as a purge is: who ran it and when, which database
2462
+ and how many rows changed, never the SQL. Workspace admins read the log
2463
+ in Workspace Settings.
2460
2464
  - The first history command on a copy fetches it, so it takes longer for a
2461
2465
  large database; the ones after it are quick.
2462
2466
  - Errors: release_not_found (no release of this app that was ever live has
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@madewithremy/admin",
3
- "version": "0.1.68",
3
+ "version": "0.1.69",
4
4
  "description": "Admin SDK + CLI for managing production Remy apps",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",