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

schemachanger: add doc.go #104780

Merged
merged 1 commit into from
Jun 15, 2023
Merged

schemachanger: add doc.go #104780

merged 1 commit into from
Jun 15, 2023

Conversation

postamar
Copy link
Contributor

Fixes #104779.

Release note: None

@blathers-crl
Copy link

blathers-crl bot commented Jun 13, 2023

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.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@postamar postamar marked this pull request as ready for review June 13, 2023 14:56
@postamar postamar requested a review from a team as a code owner June 13, 2023 14:56
@postamar
Copy link
Contributor Author

cc @rafiss @Xiang-Gu @chengxiong-ruan @fqazi for some proofreading please

Copy link
Contributor

@chengxiong-ruan chengxiong-ruan left a comment

Choose a reason for hiding this comment

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

looks very good to me. thanks for writing this. I personally probably know most of the stuff, but never be able to describe them systematically like this.

pkg/sql/schemachanger/doc.go Outdated Show resolved Hide resolved
pkg/sql/schemachanger/doc.go Outdated Show resolved Hide resolved
pkg/sql/schemachanger/doc.go Outdated Show resolved Hide resolved
Copy link
Contributor

@Xiang-Gu Xiang-Gu left a comment

Choose a reason for hiding this comment

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

  1. somewhere in the doc, preferably in a notable place, we should explain why it's called "declarative" schema changer.

  2. I think all the efforts we made into testing this framework also deserves a section. In my opinion, it's quite sophisticated and showcases the testability of the framework -- end-to-end, rollback, puase/resume, backup/restore, DML injection, three explains, and mixed version tests.

@postamar
Copy link
Contributor Author

Those are all excellent comments, thank you very much for having given this a proper read-through!

Fixes cockroachdb#104779.

Release note: None
@postamar
Copy link
Contributor Author

I've applied almost all of the suggestions, thanks again!

bors r+

@craig
Copy link
Contributor

craig bot commented Jun 15, 2023

Build succeeded:

@craig craig bot merged commit 3e8657a into cockroachdb:master Jun 15, 2023
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.

schemachanger: document packages in a doc.go file
4 participants