Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metadata to kv, remove read-after-write guarantee #329

Merged
merged 3 commits into from
Feb 17, 2025
Merged

Add metadata to kv, remove read-after-write guarantee #329

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ef933b
Fix kv release history date
Jarema Feb 17, 2025
d4b4596
Add stream metadata to KV
Jarema Feb 17, 2025
d5f2826
Remove read-after-write guarantees in KV ADR
Jarema Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions adr/ADR-8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
| 4 | 2023-10-25 | Support compression | 2.10.0 |
| 5 | 2024-06-05 | Add KV management | |
| 6 | 2024-06-05 | Add Keys listers with filters | |
| 7 | 2025-02-23 | Add Max Age limit Markers, remove non direct gets | 2.11.0 |
| 7 | 2025-01-23 | Add Max Age limit Markers, remove non direct gets | 2.11.0 |
| 8 | 2025-02-17 | Add Metadata | 2.10.0 |


## Context
Expand All @@ -44,7 +45,6 @@ additional behaviors will come during the 1.x cycle.
* Key deletes preserves history
* Keys can be expired from the bucket based on a TTL, TTL is set for the entire bucket
* Watching a specific key, ranges based on NATS wildcards, or the entire bucket for live updates
* Read-after-write safety
* Valid keys are `\A[-/_=\.a-zA-Z0-9]+\z`, additionally they may not start or end in `.`
* Valid buckets are `\A[a-zA-Z0-9_-]+\z`
* Custom Stream Names and Stream ingest subjects to cater for different domains, mirrors and imports
Expand Down Expand Up @@ -320,6 +320,7 @@ A bucket is a Stream with these properties:
* Allow Direct is always set to `true`. (It can be modified out-of-band only if desired, but not through KV bucket update.)
* Placement is allowed
* Republish is allowed
* Stream Metadata is allowed
* If compression is requested in the configuration set `compression` to `s2`

Enabling Limit Markers requires NATS Server with API level 1 or newer support (2.11+) and clients should assert this using the `$JS.API.INFO` call or similar means (not connected server version).
Expand Down Expand Up @@ -357,6 +358,9 @@ Here is a full example of the `CONFIGURATION` bucket with compression enabled:
"src": "repub.>",
"dest": "dest.>",
"headers_only": true
},
"metadata": {
"encoding": "base64"
}
}
```
Expand Down