docs: add documentation for scylla_identifier #21221
Conversation
bhalevy
added
documentation
Docs Preview 📖Docs Preview for this pull request is available here Changed Files: Note: This preview will be available for 30 days and will be automatically deleted after that period. You can manually trigger a new build by committing changes. |
docs/dev/sstable-scylla-format.md
Outdated
| change if the sstable is migrated to a different shard or node, the sstable | ||
| identifier is stable and copied with the rest of the scylla metadata. | ||
|
|
||
| The :doc:`scylla sstable dump-scylla-metadata </operating-scylla/admin-tools/scylla-sstable/#dump-scylla-metadata>` tool |
There was a problem hiding this comment.
The docs directive will not work in an .md file. In the internal documents within the dev folder, it's better to use the markdown syntax to add links to the file on GitHub rather than the published docs. That would be:
[scylla sstable dump-scylla-metadata](https://github.com/scylladb/scylladb/blob/master/docs/operating-scylla/admin-tools/scylla-sstable.rst#dump-scylla-metadata)
There was a problem hiding this comment.
fixed in next version (a22bc02)
Commit 3a12ad9 added an sstable_identifier uuid to the SSTable scylla_metadata component, however it was under-documented and this patch adds the missing documentation for the sstable component format, and to the scylla sstable tool documentation. Signed-off-by: Benny Halevy <[email protected]>
bhalevy
force-pushed
the
doc-sstable-id
branch
from
0ef3265
to
a22bc02
Compare
|
In a22bc02: use markdown syntax in .md doc (#21221 (comment)) |
|
@scylladb/scylla-maint please consider merging |
|
@scylladb/scylla-maint hello maintainers, could you help queue this change? |
| @@ -500,6 +500,7 @@ The content is dumped in JSON, using the following schema: | |||
| "scylla_build_id": String | |||
| "scylla_version": String | |||
| "ext_timestamp_stats": {"$key": int64, ...} | |||
| "sstable_identifier": String, // UUID | |||
There was a problem hiding this comment.
Why is it a string and not a uuid?
There was a problem hiding this comment.
It is stored as a uuid.
I just followed run_identifier's example in the documentation.
There was a problem hiding this comment.
Then it's misleading. String -> formatted UUID.
There was a problem hiding this comment.
This is documenting a JSON schema and JSON doesn't have a UUID type, so it has to be converted to string.
Commit 3a12ad9
added an sstable_identifier uuid to the SSTable
scylla_metadata component, however it was
under-documented and this patch adds the missing
documentation for the sstable component format,
and to the scylla sstable tool documentation.