Skip to content

docs: fix S3 adapter key encoding description and routing key placeholder consistency #393

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

Merged
bootjp merged 2 commits into from
Mar 21, 2026
Merged

docs: fix S3 adapter key encoding description and routing key placeholder consistency #393

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5291e6d
Initial plan
Copilot Mar 21, 2026
50dc7c8
docs: fix escape/terminator byte description and standardize routing …
Copilot Mar 21, 2026
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
4 changes: 2 additions & 2 deletions docs/s3_compatible_adapter_design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Suggested keys:

Segment encoding:

- All string segments (`<bucket-esc>`, `<object-esc>`, `<upload-id-esc>`) MUST use the same prefix-safe, byte-ordered escaping scheme as the DynamoDB adapter’s key encoder. Concretely, each string segment is escaped so that a reserved terminator byte (e.g. `0x00`) never appears in the payload, and the segment is terminated by that byte. This makes each string segment self-delimiting while preserving lexicographic order over the original strings.
- All string segments (`<bucket-esc>`, `<object-esc>`, `<upload-id-esc>`) MUST use the same prefix-safe, byte-ordered escaping scheme as the DynamoDB adapter’s key encoder (`encodeDynamoKeySegment`). Concretely: the escape byte is `0x00`; any raw `0x00` byte in the segment payload is encoded as the two-byte sequence `0x00 0xFF`; the segment is terminated by the two-byte sequence `0x00 0x01`. This makes each string segment self-delimiting while preserving lexicographic order over the original strings.
- All numeric segments (`<gen-u64>`, `<part-no-u64>`, `<chunk-no-u64>`) MUST be encoded as fixed-width 8-byte big-endian unsigned integers (ordered uint64) written directly after the preceding segment, with no additional separator bytes.
- The layout is therefore:
- `obj|head`: `prefix | bucket-esc | gen-u64 | object-esc`
Expand Down Expand Up @@ -223,7 +223,7 @@ Per-part ETags stored in each part descriptor must use the single-part format (M
All object-scoped internal keys must route as if they belong to the logical object key:

```text
!s3route|<bucket-enc><gen><object-enc>
!s3route|<bucket-esc><gen-u64><object-esc>
```

That means:
Expand Down
Loading