Skip to content

Commit

Permalink
[automated commit] Bump docs to versions 2.19.0, 1.53.4
Browse files Browse the repository at this point in the history
  • Loading branch information
leorossi authored and github-actions[bot] committed Dec 4, 2024
1 parent 60f80c3 commit 1430237
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/db/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ postgres://user:password@my-database:5432/db-name

- **`events`** (`boolean` or `object`, default: `true`) — Controls the support for events published by the SQL mapping layer.
- `enabled`: Set to `true` to activate event publishing, which support for GraphQL Subscription over WebSocket using an in-process message broker.
- Custom Broker: To use an external message broker, such as Redis, provide the connection string as shown in the example below.
- Custom Broker: To use an external message broker, such as Valkey, provide the connection string as shown in the example below.

```json title="Example Object"
{
Expand All @@ -332,7 +332,7 @@ postgres://user:password@my-database:5432/db-name
"events": {
...
"enabled": true,
"connectionString": "redis://:password@redishost.com:6380/"
"connectionString": "valkey://:password@valkeyhost.com:6380/"
}
}
}
Expand Down
12 changes: 12 additions & 0 deletions docs/packages/next/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,16 @@ Configures the HTTP server, see the [runtime](../../runtime/configuration.md#ser

Manages watching of the service, see the [service](../../service/configuration.md#watch) documentation.

## `caching`

Configures an [Incremental Server Rendering cache](https://nextjs.org/docs/app/api-reference/next-config-js/incrementalCacheHandlerPath) handler.

Supported object properties:

- **`adapter`**: The adapter to use. The only supported value is `valkey` (of which `redis` is a synonym).
- **`url`**: The URL of the Valkey/Redis server.
- **`prefix`**: The prefix to use for all cache keys.
- **`maxTTL`**: The maximum life of a server key, in seconds. If the Next.js `revalidate` value is greater than this value, then
the adapter will refresh the key expire time as long as it is accessed every `maxTTL` seconds. The default value is `604800` (one week).

<Issues />
2 changes: 1 addition & 1 deletion docs/packages/sql-events/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ label: sql-events
The Platformatic DB sql-events uses [mqemitter](http://npm.im/mqemitter) to publish events when [entities](/reference/sql-mapper/entities/introduction.md) are saved and deleted.

These events are useful to distribute updates to clients, e.g. via WebSocket, Server-Sent Events, or GraphQL Subscritions.
When subscribing and using a multi-process system with a broker like Redis, a subscribed topic will receive the data from all
When subscribing and using a multi-process system with a broker like Valkey, a subscribed topic will receive the data from all
the other processes.

They are not the right choice for executing some code whenever an entity is created, modified or deleted, in that case
Expand Down

0 comments on commit 1430237

Please sign in to comment.