Skip to content

Update docs to recommend UUIDv4 explicitly #20031

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

Jump to bottom
Merged
merged 2 commits into from
Aug 14, 2025
Merged

Update docs to recommend UUIDv4 explicitly #20031

merged 2 commits into from
Aug 14, 2025

Conversation

rmloveland
Copy link
Contributor

Fixes DOC-9482

@rmloveland rmloveland marked this pull request as draft July 30, 2025 21:50
@netlify Netlify
Copy link

netlify bot commented Jul 30, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 2ad1a03
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/689e2c3cdf6d840008a2fa70

@netlify Netlify
Copy link

netlify bot commented Jul 30, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 2ad1a03
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/689e2c3cab3c0900070c69ca

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 30, 2025 •
edited
Loading

Files changed:

@netlify Netlify
Copy link

netlify bot commented Jul 30, 2025 •
edited
Loading

✅ Netlify Preview

Name Link
🔨 Latest commit 2ad1a03
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/689e2c3c8de20d0007ecc2cc
😎 Deploy Preview https://deploy-preview-20031--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@rmloveland rmloveland force-pushed the 20250730-DOC-9482-recommend-uuid-v4 branch 2 times, most recently from 320eb15 to a4b3170 Compare August 5, 2025 18:28
@rmloveland rmloveland marked this pull request as ready for review August 5, 2025 18:42
@rmloveland
Copy link
Contributor Author

rmloveland commented Aug 5, 2025 •
edited
Loading

@data-matt I know you're on PTO right now, PTAL when you get back

@dikshant tagged you for review FYI so you know we're making this update to our UUID recommendations. It's not really a big change of direction, just trying to clarify that users should use UUIDv4 with CockroachDB, not the other variations that could result in hotspots

@data-matt
Copy link
Contributor

Hi @rmloveland, looks close. The only thing I would say, this part is perhaps a little strong:

due to their non-random elements, they are likely to cause {% if page.name == "performance-best-practices-overview.md" %}hotspots{% else %}

Maybe more like:

Other types of UUID are largely untested with CockroachDB and will require performance testing to avoid hotspots

@rmloveland
Copy link
Contributor Author

Maybe more like:

Other types of UUID are largely untested with CockroachDB and will require performance testing to avoid hotspots

thanks @data-matt ! updated in c487e1e PTAL

@data-matt
Copy link
Contributor

Lgtm

data-matt
data-matt approved these changes Aug 13, 2025
View reviewed changes
Copy link
Contributor

@data-matt data-matt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@rmloveland rmloveland requested a review from taroface August 13, 2025 19:56
@rmloveland
Copy link
Contributor Author

TFTR Matt! FYI once this is through Docs team review I will backport the changes to all supported versions v24.1 and later

taroface
taroface approved these changes Aug 13, 2025
View reviewed changes
Copy link
Contributor

@taroface taroface left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just one small comment.

@rmloveland
Copy link
Contributor Author

TFTRs!

backporting to all supported versions v24.1 and later, then merging

@rmloveland rmloveland force-pushed the 20250730-DOC-9482-recommend-uuid-v4 branch from fba1d0b to 516b063 Compare August 14, 2025 16:11
@rmloveland
Update docs to recommend UUIDv4 explicitly
db36211 
Fixes DOC-9482

NB. Changes were initially made to v25.3, then backported to all
supported versions v24.1+
@rmloveland rmloveland force-pushed the 20250730-DOC-9482-recommend-uuid-v4 branch from 516b063 to db36211 Compare August 14, 2025 18:25
@rmloveland rmloveland enabled auto-merge (squash) August 14, 2025 18:34
@rmloveland rmloveland merged commit 021b907 into main Aug 14, 2025
6 checks passed
@rmloveland rmloveland deleted the 20250730-DOC-9482-recommend-uuid-v4 branch August 14, 2025 18:43
@rmloveland rmloveland mentioned this pull request Aug 19, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@taroface taroface taroface approved these changes

@data-matt data-matt data-matt approved these changes

@dikshant dikshant Awaiting requested review from dikshant

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rmloveland @data-matt @taroface