Skip to content

Persistent databases in clickhouse-local#71722

Merged
alexey-milovidov merged 40 commits intomasterfrom
clickhouse-local-persistency
Apr 14, 2025
Merged

Persistent databases in clickhouse-local#71722
alexey-milovidov merged 40 commits intomasterfrom
clickhouse-local-persistency

Conversation

@alexey-milovidov
Copy link
Copy Markdown
Member

@alexey-milovidov alexey-milovidov commented Nov 11, 2024 •
edited
Loading

Changelog category (leave one):

  • Improvement

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

clickhouse-local will retain its databases after restart if you specify the --path command line argument. This closes #50647. This closes #49947.

Information about CI checks: https://clickhouse.com/docs/en/development/continuous-integration/

CI Settings (Only check the boxes if you know what you are doing):

  • Allow: All Required Checks
  • Allow: Stateless tests
  • Allow: Stateful tests
  • Allow: Integration Tests
  • Allow: Performance tests
  • Allow: All Builds
  • Allow: batch 1, 2 for multi-batch jobs
  • Allow: batch 3, 4, 5, 6 for multi-batch jobs
  • Exclude: Style check
  • Exclude: Fast test
  • Exclude: All with ASAN
  • Exclude: All with TSAN, MSAN, UBSAN, Coverage
  • Exclude: All with aarch64, release, debug
  • Run only fuzzers related jobs (libFuzzer fuzzers, AST fuzzers, etc.)
  • Exclude: AST fuzzers
  • Do not test
  • Woolen Wolfdog
  • Upload binaries for special builds
  • Disable merge-commit
  • Disable CI cache

@robot-ch-test-poll1 robot-ch-test-poll1 added the pr-improvement Pull request with some product improvements label Nov 11, 2024
@robot-ch-test-poll4
Copy link
Copy Markdown
Contributor

robot-ch-test-poll4 commented Nov 11, 2024 •
edited by robot-clickhouse-ci-1
Loading

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

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

Check nameDescriptionStatus
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests❌ failure
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Successful checks
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✅ success
BuildsThere'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
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. Integration 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
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
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors✅ 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
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✅ success

@Algunenano
Copy link
Copy Markdown
Member

Algunenano commented Nov 11, 2024

Note that we need a setting to enable or disable this (#50647 (comment))

I use clickhouse local for temporal things almost exclusively, so for me having it in /tmp (which is temporal and will be deleted on restart if anything is left, such as during a crash) and being non persistent is a feature. When I want persistence I have clickhouse server.

@alexey-milovidov
Copy link
Copy Markdown
Member Author

alexey-milovidov commented Nov 11, 2024

Yes, this adds a flag --tmp, but it is still in question - should we use the temporary path or the current path by default. It is likely that we will retain the behavior with temporary paths by default.

@alexey-milovidov alexey-milovidov force-pushed the clickhouse-local-persistency branch from 7de2ba8 to 211a421 Compare November 11, 2024 18:33
@alexey-milovidov
Copy link
Copy Markdown
Member Author

alexey-milovidov commented Nov 12, 2024

I decided to split it into two parts. In the first part, it will retain data only if you explicitly specify the --path.

@alexey-milovidov alexey-milovidov marked this pull request as ready for review November 12, 2024 23:57
@alexey-milovidov alexey-milovidov mentioned this pull request Dec 31, 2024
Closed
76 tasks
@clickhouse-gh
Copy link
Copy Markdown
Contributor

clickhouse-gh bot commented Feb 9, 2025 •
edited
Loading

Workflow [PR], commit [6c532f8]

@alexey-milovidov alexey-milovidov self-assigned this Apr 14, 2025
@alexey-milovidov alexey-milovidov merged commit 3fb7c4d into master Apr 14, 2025
116 of 120 checks passed
@alexey-milovidov alexey-milovidov deleted the clickhouse-local-persistency branch April 14, 2025 19:01
@robot-clickhouse-ci-2 robot-clickhouse-ci-2 added the pr-synced-to-cloud The PR is synced to the cloud repo label Apr 14, 2025
@alexey-milovidov alexey-milovidov added v25.4-must-backport and removed submodule changed At least one submodule changed in this PR. labels Apr 14, 2025
@robot-ch-test-poll2 robot-ch-test-poll2 mentioned this pull request Apr 14, 2025
Merged
robot-ch-test-poll2 added a commit that referenced this pull request Apr 14, 2025
@robot-ch-test-poll2
Merge pull request #79174 from ClickHouse/cherrypick/25.4/71722
5997191 
Cherry pick #71722 to 25.4: Persistent databases in clickhouse-local
robot-clickhouse added a commit that referenced this pull request Apr 14, 2025
@robot-clickhouse
Backport #71722 to 25.4: Persistent databases in clickhouse-local
9f399b6
@robot-ch-test-poll2 robot-ch-test-poll2 mentioned this pull request Apr 14, 2025
Merged
@robot-ch-test-poll4 robot-ch-test-poll4 added the pr-backports-created-cloud deprecated label, NOOP label Apr 14, 2025
@robot-ch-test-poll1 robot-ch-test-poll1 added the pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore label Apr 14, 2025
@tavplubix tavplubix mentioned this pull request Apr 15, 2025
Closed
alexey-milovidov added a commit that referenced this pull request Apr 16, 2025
@alexey-milovidov
Merge pull request #79175 from ClickHouse/backport/25.4/71722
a68547d 
Backport #71722 to 25.4: Persistent databases in clickhouse-local
@tuanpach tuanpach mentioned this pull request Apr 25, 2025
Merged
1 task
This was referenced Jun 12, 2025
Closed
Merged
@robot-clickhouse robot-clickhouse added the pr-must-backport-synced The `*-must-backport` labels are synced into the cloud Sync PR label Jul 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@alexey-milovidov alexey-milovidov

Labels

pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore pr-backports-created-cloud deprecated label, NOOP pr-improvement Pull request with some product improvements pr-must-backport-synced The `*-must-backport` labels are synced into the cloud Sync PR pr-synced-to-cloud The PR is synced to the cloud repo

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Slightly better persistency in clickhouse-local How to load the data stored in '_local' by ClickHouse-local on a previous run?

6 participants

@alexey-milovidov @robot-ch-test-poll4 @Algunenano @robot-clickhouse @robot-ch-test-poll1 @robot-clickhouse-ci-2