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.

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

cloud/amazon: add option to skip checksums #143069

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dt
Copy link
Member

@dt dt commented Mar 18, 2025

Our files (SSTs) often have internal checksums anyway, and we have ecplicit checksum files for those that don't that are cloud agnostic, so we do not generally need the extra checksums in s3-specific metadata. Computing them has non-zero cost as well, so users may wish to disable them. Indeed, we almost did so by default a couple years ago before realizing that they are required by the S3 API if certain other features, like object locking, are enabled. So while some users may not be able to or want to disable them, e.g. if they're using object locking, we can provide the option to do so to those who would want it. This may also be useful to users of certain s3-like storage services that have different compatibility with different checksums.

Release note (sql change): S3 storage URIs now support the optional AWS_SKIP_CHECKSUM parameter.
Epic: none.

@dt dt requested review from benbardin and msbutler March 18, 2025 15:15
Copy link

blathers-crl bot commented Mar 18, 2025

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@dt dt requested a review from a team as a code owner March 18, 2025 15:15
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Collaborator

@benbardin benbardin left a comment

Choose a reason for hiding this comment

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

Add a unit test? Also note somewhere that this isn't compatible with object locking. Probably in-code for us, and in the Release note so Kathryn can call that out. Otherwise LGTM, thank you!

Copy link
Collaborator

@msbutler msbutler left a comment

Choose a reason for hiding this comment

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

If it is easy to add a test case to the cloud unit test suite, that would be great.

Our files (SSTs) often have internal checksums anyway, and we have ecplicit checksum
files for those that don't that are cloud agnostic, so we do not generally need the
extra checksums in s3-specific metadata. Computing them has non-zero cost as well, so
users may wish to disable them. Indeed, we almost did so by default a couple years ago
before realizing that they are required by the S3 API if certain other features, like
object locking, are enabled. So while some users may not be able to or want to disable
them, e.g. if they're using object locking, we can provide the option to do so
to those who would want it. This may also be useful to users of certain s3-like
storage services that have different compatibility with different checksums.

Release note (sql change): S3 storage URIs now support the optional AWS_SKIP_CHECKSUM parameter.
Epic: none.
@dt dt force-pushed the s3-checksum-skip branch from 95fdd72 to 6939a7e Compare March 27, 2025 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants