Skip to content

Commit 9aedabb

Browse files
author
imqueue-bot
committed
docs(api): resync pg-prisma with npm — 1.1.0
1 parent bc176a3 commit 9aedabb

13 files changed

Lines changed: 260 additions & 12 deletions

lib/api-versions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export const API_VERSIONS: ApiVersions = {
1212
"pg-cache": { "latest": "5.1.2", "archives": [] },
1313
"tag-cache": { "latest": "3.0.5", "archives": [] },
1414
"pg-sequelize": { "latest": "4.2.3", "archives": [] },
15-
"pg-prisma": { "latest": "1.0.3", "archives": [] },
15+
"pg-prisma": { "latest": "1.1.0", "archives": [] },
1616
"async-logger": { "latest": "3.2.0", "archives": [] },
1717
"opentelemetry": { "latest": "4.1.1", "archives": [] },
1818
"datadog": { "latest": "3.2.1", "archives": [] },

src/_data/apiVersions.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"archives": []
3131
},
3232
"pg-prisma": {
33-
"latest": "1.0.3",
33+
"latest": "1.1.0",
3434
"archives": []
3535
},
3636
"async-logger": {

src/_data/packageStatus.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"generated": "2026-08-26T13:47:34.906Z",
2+
"generated": "2026-08-27T15:15:44.776Z",
33
"framework": {
44
"license": "GPL-3.0-only",
55
"licenseNote": "GPL-3.0-only, or a commercial licence for closed-source distribution. Not AGPL: running it as a network service is not distribution, so internal services and SaaS carry no source-release obligation",
@@ -143,12 +143,12 @@
143143
{
144144
"name": "pg-prisma",
145145
"scoped": "@imqueue/pg-prisma",
146-
"version": "1.0.3",
146+
"version": "1.1.0",
147147
"license": "GPL-3.0-only",
148148
"node": ">=22.12.0",
149-
"released": "2026-08-22",
149+
"released": "2026-08-27",
150150
"firstRelease": "2026-07-22",
151-
"releases": 4,
151+
"releases": 5,
152152
"majors": [
153153
1
154154
],

src/org/api/pg-prisma/latest/index.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "@imqueue/pg-prisma 1.0.3 · API reference"
2+
title: "@imqueue/pg-prisma 1.1.0 · API reference"
33
description: "Prisma and Postgres building blocks for @imqueue services."
44
apiCrumbs: [{"name":"API reference","url":"/api/"},{"name":"@imqueue/pg-prisma","url":"/api/pg-prisma/latest/"}]
55
---
@@ -177,6 +177,17 @@ Recursively replace every `Date` with its ISO-8601 string, structure intact.
177177
Exported so it can be tested without a database, like `accessWhere`<!-- -->: what it does to a shape is the whole of this extension, and the interesting cases — a buffer, a nested date, an array of rows — are all reachable from here.
178178

179179

180+
</td></tr>
181+
<tr><td>
182+
183+
[withoutChangeNotify(client, fn, setting)](/api/pg-prisma/latest/pg-prisma.withoutchangenotify/)
184+
185+
186+
</td><td>
187+
188+
Run `fn` in a transaction whose row changes notify nobody.
189+
190+
180191
</td></tr>
181192
</tbody></table>
182193

@@ -405,6 +416,17 @@ Default Postgres NOTIFY channel the change triggers emit on.
405416
Default name of the trigger's plpgsql notify function.
406417

407418

419+
</td></tr>
420+
<tr><td>
421+
422+
[CHANGE\_NOTIFY\_SUPPRESS\_SETTING](/api/pg-prisma/latest/pg-prisma.change_notify_suppress_setting/)
423+
424+
425+
</td><td>
426+
427+
Setting the trigger reads to decide whether to stay quiet.
428+
429+
408430
</td></tr>
409431
<tr><td>
410432

src/org/api/pg-prisma/latest/latest.11tydata.json

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"section": "api",
44
"bareTitle": true,
55
"apiPkg": "pg-prisma",
6-
"apiVersion": "1.0.3",
6+
"apiVersion": "1.1.0",
77
"apiVersionPath": "latest",
8-
"apiReleased": "2026-08-22T06:11:35.992Z",
8+
"apiReleased": "2026-08-27T11:29:19.815Z",
99
"apiNav": [
1010
{
1111
"group": "Functions",
@@ -61,6 +61,10 @@
6161
{
6262
"name": "toIsoDates(value)",
6363
"url": "/api/pg-prisma/latest/pg-prisma.toisodates/"
64+
},
65+
{
66+
"name": "withoutChangeNotify(client, fn, setting)",
67+
"url": "/api/pg-prisma/latest/pg-prisma.withoutchangenotify/"
6468
}
6569
]
6670
},
@@ -144,6 +148,10 @@
144148
"name": "CHANGE_NOTIFY_FUNCTION_NAME",
145149
"url": "/api/pg-prisma/latest/pg-prisma.change_notify_function_name/"
146150
},
151+
{
152+
"name": "CHANGE_NOTIFY_SUPPRESS_SETTING",
153+
"url": "/api/pg-prisma/latest/pg-prisma.change_notify_suppress_setting/"
154+
},
147155
{
148156
"name": "CHANGE_NOTIFY_TRIGGER_NAME",
149157
"url": "/api/pg-prisma/latest/pg-prisma.change_notify_trigger_name/"
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "CHANGE_NOTIFY_SUPPRESS_SETTING variable · @imqueue/pg-prisma"
3+
description: "Setting the trigger reads to decide whether to stay quiet."
4+
apiCrumbs: [{"name":"API reference","url":"/api/"},{"name":"@imqueue/pg-prisma","url":"/api/pg-prisma/latest/"},{"name":"CHANGE_NOTIFY_SUPPRESS_SETTING","url":"/api/pg-prisma/latest/pg-prisma.change_notify_suppress_setting/"}]
5+
---
6+
7+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
8+
9+
# CHANGE\_NOTIFY\_SUPPRESS\_SETTING variable
10+
11+
Setting the trigger reads to decide whether to stay quiet.
12+
13+
**Signature:**
14+
15+
```typescript
16+
CHANGE_NOTIFY_SUPPRESS_SETTING = "record_change_notify.suppressed"
17+
```
18+
19+
## Remarks
20+
21+
Named after the trigger it silences, like the channel, trigger and function above it — a reader meeting it in a `SET LOCAL` can tell what it belongs to without knowing this package.
22+
23+
A setting of our own rather than `session_replication_role`<!-- -->, which would also switch off foreign-key enforcement — a bulk load run that way can leave orphan rows behind. This suppresses nothing but these notifications.
24+

src/org/api/pg-prisma/latest/pg-prisma.changetriggerconfig.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,25 @@ readonly string\[\]
9595
_(Optional)_ Tables that should notifythe complete desired set, not an addition.
9696

9797

98+
</td></tr>
99+
<tr><td>
100+
101+
[schema?](/api/pg-prisma/latest/pg-prisma.changetriggerconfig.schema/)
102+
103+
104+
</td><td>
105+
106+
107+
</td><td>
108+
109+
string
110+
111+
112+
</td><td>
113+
114+
_(Optional)_ Default schema of the listed tables (default `public`<!-- -->).
115+
116+
98117
</td></tr>
99118
<tr><td>
100119

@@ -114,6 +133,25 @@ boolean
114133
_(Optional)_ Suppress SQL logging for the install DDL (default `true`<!-- -->).
115134

116135

136+
</td></tr>
137+
<tr><td>
138+
139+
[suppressSetting?](/api/pg-prisma/latest/pg-prisma.changetriggerconfig.suppresssetting/)
140+
141+
142+
</td><td>
143+
144+
145+
</td><td>
146+
147+
string
148+
149+
150+
</td><td>
151+
152+
_(Optional)_ Setting that silences the trigger (default [CHANGE\_NOTIFY\_SUPPRESS\_SETTING](/api/pg-prisma/latest/pg-prisma.change_notify_suppress_setting/)<!-- -->).
153+
154+
117155
</td></tr>
118156
<tr><td>
119157

src/org/api/pg-prisma/latest/pg-prisma.changetriggerconfig.models.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,7 @@ models?: readonly string[];
1919

2020
## Remarks
2121

22-
Reconciliation is two-way: a table listed here without the trigger gets it, and a table that HAS the trigger but is not listed here has it dropped. So omitting `models` entirely (the default empty array) removes the trigger from every table it is currently on.
22+
Reconciliation is two-way: a table listed here without the trigger gets it, and a table that HAS the trigger but is not listed here has it dropped.
23+
24+
It is confined to the schemas these names mention, so a call listing only public tables leaves triggers in other schemas alone — otherwise a service that installs per-schema would tear down its own work on the next start. Within those schemas it is absolute: omitting `models` entirely removes the trigger from every table in the default schema.
2325

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: "ChangeTriggerConfig.schema property · @imqueue/pg-prisma"
3+
description: "Default schema of the listed tables (default public)."
4+
apiCrumbs: [{"name":"API reference","url":"/api/"},{"name":"@imqueue/pg-prisma","url":"/api/pg-prisma/latest/"},{"name":"ChangeTriggerConfig","url":"/api/pg-prisma/latest/pg-prisma.changetriggerconfig/"},{"name":"schema","url":"/api/pg-prisma/latest/pg-prisma.changetriggerconfig.schema/"}]
5+
sitemap: false
6+
---
7+
8+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
9+
10+
# ChangeTriggerConfig.schema property
11+
12+
Default schema of the listed tables (default `public`<!-- -->).
13+
14+
**Signature:**
15+
16+
```typescript
17+
schema?: string;
18+
```
19+
20+
## Remarks
21+
22+
A model may name its own schema as `schema.Table`<!-- -->, which wins over this. That is what lets a service reconcile tables it creates at run time — a tenant schema, say — without naming the default one.
23+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "ChangeTriggerConfig.suppressSetting property · @imqueue/pg-prisma"
3+
description: "Setting that silences the trigger (default CHANGE_NOTIFY_SUPPRESS_SETTING)."
4+
apiCrumbs: [{"name":"API reference","url":"/api/"},{"name":"@imqueue/pg-prisma","url":"/api/pg-prisma/latest/"},{"name":"ChangeTriggerConfig","url":"/api/pg-prisma/latest/pg-prisma.changetriggerconfig/"},{"name":"suppressSetting","url":"/api/pg-prisma/latest/pg-prisma.changetriggerconfig.suppresssetting/"}]
5+
sitemap: false
6+
---
7+
8+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
9+
10+
# ChangeTriggerConfig.suppressSetting property
11+
12+
Setting that silences the trigger (default [CHANGE\_NOTIFY\_SUPPRESS\_SETTING](/api/pg-prisma/latest/pg-prisma.change_notify_suppress_setting/)<!-- -->).
13+
14+
**Signature:**
15+
16+
```typescript
17+
suppressSetting?: string;
18+
```

0 commit comments

Comments
 (0)