Skip to content

Commit 6640a9b

Browse files
committed
docs
1 parent 55f4473 commit 6640a9b

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

docs/api/constructor.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,13 @@ The following configuration options should not normally need to be changed, but
9393

9494
How often queue metadata is refreshed in memory.
9595

96-
### Backend
96+
* **persistWarnings**, bool, default false
97+
98+
If set to true, warnings emitted during monitoring and maintenance (slow queries, queue backlogs, clock skew) will be persisted to the `warning` table in addition to being emitted as events. This enables historical tracking of warnings for debugging and monitoring purposes. See [Events](./events.md#warning) for more details on warning types.
99+
100+
* **warningRetentionDays**, int
101+
102+
When `persistWarnings` is enabled, this option controls automatic cleanup of old warnings. Warnings older than the specified number of days will be deleted during maintenance. If not set, warnings are retained indefinitely. Maximum: 365 days.
97103

98104
* **backend**, string, default `'postgres'`
99105

@@ -103,13 +109,5 @@ The following configuration options should not normally need to be changed, but
103109
const boss = new PgBoss({ connectionString, backend: 'cockroachdb' })
104110
```
105111

106-
Based on this setting, the fetch strategy, mutation strategy, schema shape, and numeric coercion may bec changed. See [Database Backends](../database-backends.md#backend-profiles)
112+
Based on this setting, the fetch strategy, mutation strategy, schema shape, and numeric coercion may be changed. See [Database Backends](../database-backends.md#backend-profiles)
107113
for what each backend enables and the [compatibility matrix](../database-backends.md#database-compatibility).
108-
109-
* **persistWarnings**, bool, default false
110-
111-
If set to true, warnings emitted during monitoring and maintenance (slow queries, queue backlogs, clock skew) will be persisted to the `warning` table in addition to being emitted as events. This enables historical tracking of warnings for debugging and monitoring purposes. See [Events](./events.md#warning) for more details on warning types.
112-
113-
* **warningRetentionDays**, int
114-
115-
When `persistWarnings` is enabled, this option controls automatic cleanup of old warnings. Warnings older than the specified number of days will be deleted during maintenance. If not set, warnings are retained indefinitely. Maximum: 365 days.

0 commit comments

Comments
 (0)