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

Add support for reading and writing backups as tar archives #59535

Merged
merged 36 commits into from
Mar 1, 2024

Conversation

josh-hildred
Copy link
Contributor

@josh-hildred josh-hildred commented Feb 2, 2024

Changelog category (leave one):

  • New Feature

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Support reading and writing backups as tar archives.

Documentation entry for user-facing changes

  • Documentation is written (mandatory for new features)

This change allows tables to be backed up as tar archives. I.E BACKUP TABLE test.table TO Disk('backups', '1.tar') and RESTORE TABLE test.table FROM Disk('backups', '1.tar'). Compressing the archives and setting passwords is not currently supported.

@josh-hildred josh-hildred marked this pull request as ready for review February 5, 2024 18:59
@robot-clickhouse robot-clickhouse added the pr-feature Pull request with new product feature label Feb 6, 2024
@robot-clickhouse
Copy link
Member

robot-clickhouse commented Feb 6, 2024

This is an automated comment for commit 58a8658 with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Successful checks
Check nameDescriptionStatus
A SyncThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docs checkBuilds and tests the documentation✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests✅ success
Mergeable CheckChecks if all other necessary checks are successful✅ success
PR CheckThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool✅ success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help❌ failure
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR⏳ pending
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors❌ failure
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts❌ failure

src/IO/Archives/IArchiveWriter.h Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.h Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
@alexey-milovidov alexey-milovidov added the can be tested Allows running workflows for external contributors label Feb 14, 2024
@antonio2368 antonio2368 self-assigned this Feb 14, 2024
src/IO/Archives/IArchiveWriter.h Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/createArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
docs/en/operations/backup.md Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveReader.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.h Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/LibArchiveWriter.cpp Outdated Show resolved Hide resolved
src/IO/Archives/createArchiveWriter.cpp Outdated Show resolved Hide resolved
@robot-clickhouse-ci-2 robot-clickhouse-ci-2 added the submodule changed At least one submodule changed in this PR. label Feb 21, 2024
@antonio2368
Copy link
Member

@josh-hildred can you please update the branch with master one more time just so I see that checks are okay

josh-hildred and others added 21 commits February 29, 2024 05:20
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
Co-authored-by: Antonio Andelic <antonio2368@users.noreply.github.com>
@antonio2368 antonio2368 merged commit 5104029 into ClickHouse:master Mar 1, 2024
245 of 253 checks passed
@robot-ch-test-poll robot-ch-test-poll added the pr-synced-to-cloud The PR is synced to the cloud repo label Mar 1, 2024
@josh-hildred
Copy link
Contributor Author

josh-hildred commented Mar 1, 2024

Thank you @antonio2368 for helping get this across the line!

@antonio2368
Copy link
Member

Thanks for implementing this @josh-hildred! And with clean code and good tests, can't ask for more. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
can be tested Allows running workflows for external contributors pr-feature Pull request with new product feature pr-synced-to-cloud The PR is synced to the cloud repo submodule changed At least one submodule changed in this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants