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.

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

Add checkpoint utilities #6900

Merged
merged 22 commits into from
Feb 28, 2023
Merged

Add checkpoint utilities #6900

merged 22 commits into from
Feb 28, 2023

Conversation

breezewish
Copy link
Member

@breezewish breezewish commented Feb 26, 2023 •
edited
Loading

What problem does this PR solve?

Issue Number: ref #6827

Problem Summary:

What is changed and how it works?

This PR introduces these utilities to work with writing and reading PageStorage checkpoints:

  • DB::PS::V3::CPDataFileWriter
  • DB::PS::V3::CPFilesWriter
  • DB::PS::V3::CPManifestFileWriter
  • DB::PS::V3::CPManifestFileReader

Usually, you need to write ManifestFile and DataFile via CPFilesWriter, and then, read the ManifestFile via CPManifestFileReader and read the DataFile via ReadBufferFromFile or something similar.

The manifest file is compressed and the data file is not. Manifest file contains Protobuf data and the file format is designed to be friendly for streaming, i.e. you can read / write data piece by piece (instead of all at once) to avoid OOMs.

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No code

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

None

breezewish and others added 9 commits February 23, 2023 20:56
@breezewish
misc: Decouple compile units
17a602c 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Merge branch 'master' into wenxuan/p1/decouple_cu
55b1f2c
@breezewish
Reformat
8cadf16 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish @JaySon-Huang
Apply suggestions from code review
2868157 
Co-authored-by: JaySon <tshent@qq.com>
@ti-chi-bot
Merge branch 'master' into wenxuan/p1/decouple_cu
dd99c15
@breezewish
Fix tests
2ddca0f 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Merge branches 'wenxuan/p1/decouple_cu' and 'wenxuan/p1/decouple_cu' …
4c04aa1 
…of github.com:breezewish/tiflash into wenxuan/p1/decouple_cu
@breezewish
Add CheckpointFile utils
05a42fc 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Merge upstream
069b950 
Signed-off-by: Wish <breezewish@outlook.com>
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Feb 26, 2023 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • JaySon-Huang
  • lidezhu

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added the release-note-none Denotes a PR that doesn't merit a release note. label Feb 26, 2023
@ti-chi-bot ti-chi-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Feb 26, 2023
@breezewish
Add tests for WriteDataSourceBlobStore
614ec6e 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Support locks
1e4636a 
Signed-off-by: Wish <breezewish@outlook.com>
@ti-chi-bot ti-chi-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 27, 2023
@breezewish
Use JSON output in data file
665caaa 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Add more tests
c165d21 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Merge remote-tracking branch 'origin/master' into wenxuan/p1/2_checkp…
d789c51 
…oint

Signed-off-by: Wish <breezewish@outlook.com>
@ti-chi-bot ti-chi-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 27, 2023
@breezewish
Split define and impl
cb8fb51 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Update comments
a722830 
Signed-off-by: Wish <breezewish@outlook.com>
JaySon-Huang
JaySon-Huang reviewed Feb 27, 2023
View reviewed changes
dbms/src/Storages/Page/V3/CheckpointFile/Proto/manifest_file.proto

*/

message ManifestFilePrefix {
Copy link
Contributor

Choose a reason for hiding this comment

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

do we need to add some fields about the compress algorithm so that we can change the algorithm later?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we can add some settings there when we want to change compression algorithm.

lidezhu
lidezhu reviewed Feb 27, 2023
View reviewed changes
dbms/src/Storages/Page/V3/CheckpointFile/tests/gtest_file_read_write.cpp Outdated
auto edits = universal::PageEntriesEdit{};
{
UniversalWriteBatch wb;
wb.putPage("page_foo", 0, "The flower carriage rocked");
Copy link
Contributor

Choose a reason for hiding this comment

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

How about add a page with data_sizes, and make sure the fields_offset is correct from manifest file?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done. Please take a look again, thanks!

@breezewish
Merge remote-tracking branch 'origin/master' into wenxuan/p1/2_checkp…
29d7f71 
…oint

Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Add tests to check with field size
93047ce 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Fix getFieldSize incorrect
2ea77af 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Merge branch 'master' into wenxuan/p1/2_checkpoint
a67fafc
@breezewish
Copy link
Member Author

/run-all-tests

JaySon-Huang
JaySon-Huang approved these changes Feb 28, 2023
View reviewed changes
Copy link
Contributor

@JaySon-Huang JaySon-Huang left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Feb 28, 2023
@JaySon-Huang
Copy link
Contributor

/rebuild

@JaySon-Huang
Copy link
Contributor

/run-integration-test

lidezhu
lidezhu approved these changes Feb 28, 2023
View reviewed changes
Copy link
Contributor

@lidezhu lidezhu left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Feb 28, 2023
@breezewish
Copy link
Member Author

/merge

@ti-chi-bot
Copy link
Member

@breezewish: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

You only need to trigger /merge once, and if the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

If you have any questions about the PR merge process, please refer to pr process.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: a67fafc

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Feb 28, 2023
@ti-chi-bot ti-chi-bot merged commit 9ea9cf7 into pingcap:master Feb 28, 2023
@JaySon-Huang JaySon-Huang mentioned this pull request Feb 28, 2023
Merged
17 tasks
@breezewish breezewish deleted the wenxuan/p1/2_checkpoint branch February 28, 2023 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flowbehappy flowbehappy flowbehappy left review comments

@JaySon-Huang JaySon-Huang JaySon-Huang approved these changes

@lidezhu lidezhu lidezhu approved these changes

Assignees
No one assigned
Labels
release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@breezewish @ti-chi-bot @JaySon-Huang @flowbehappy @lidezhu