id
stringlengths
36
36
document
stringlengths
3
3k
metadata
stringlengths
23
69
embeddings
listlengths
384
384
bf573990-c2c3-4025-bb10-38998656fe14
sh cd <repository>/tests/config sudo ./install.sh :::note Tests should be - be minimal: only create the minimally needed tables, columns and, complexity, - be fast: not take longer than a few seconds (better: sub-seconds), - be correct and deterministic: fails if and only if the feature-under-test is not working, - b...
{"source_file": "tests.md"}
[ 0.0161278173327446, -0.008318444713950157, -0.025949474424123764, -0.001447641639970243, 0.018172089010477066, -0.11444117873907089, -0.038067352026700974, 0.021431200206279755, -0.12902630865573883, 0.05649113655090332, 0.08403711020946503, -0.02823871187865734, 0.05931159481406212, 0.005...
e40a55a3-4dbb-4fc0-b52f-d8857b9c9ba2
Specifying limits for random settings {#specifying-limits-for-random-settings} A test can specify minimum and maximum allowed values for settings that can be randomized during test run. For .sh tests limits are written as a comment on the line next to tags or on the second line if no tags are specified: ```bash...
{"source_file": "tests.md"}
[ 0.002871187636628747, 0.022463032975792885, -0.08398555219173431, 0.011255443096160889, -0.011577585712075233, -0.09177137911319733, 0.07354997098445892, 0.032188910990953445, -0.07565588504076004, 0.013087247498333454, 0.02597840316593647, -0.020721906796097755, 0.05798637121915817, -0.05...
5f569b8f-b1e7-4c93-9041-a71a7b3ca224
Working with temporary files {#working-with-temporary-files} Sometimes in a shell test you may need to create a file on the fly to work with. Keep in mind that some CI checks run tests in parallel, so if you are creating or removing a temporary file in your script without a unique name this can cause some of the CI c...
{"source_file": "tests.md"}
[ -0.02342742681503296, 0.027141353115439415, -0.03892089053988457, 0.07693879306316376, 0.029760509729385376, -0.13389679789543152, 0.014087510295212269, -0.02029428817331791, 0.02548997290432453, 0.07720707356929779, 0.06987718492746353, 0.0004074655007570982, 0.03946869447827339, -0.02689...
7291a06f-a62e-4613-94b6-1c6da15b075b
Each test run one or multiple queries (possibly with combinations of parameters) in a loop. If you want to improve performance of ClickHouse in some scenario, and if improvements can be observed on simple queries, it is highly recommended to write a performance test. Also, it is recommended to write performance tests...
{"source_file": "tests.md"}
[ 0.013144146651029587, -0.08686954528093338, -0.07057030498981476, 0.06075189635157585, -0.05653879791498184, -0.05883479490876198, 0.007069538347423077, 0.03042002208530903, -0.06793755292892456, 0.002531318925321102, 0.018714316189289093, -0.033731069415807724, 0.05155264958739281, -0.032...
fb2d0e28-ae2c-4195-a663-b543a1340e81
When ClickHouse is already installed on your system, you can build a new clickhouse binary and replace the existing binary: bash $ sudo clickhouse stop $ sudo cp ./clickhouse /usr/bin/ $ sudo clickhouse start Also you can stop system clickhouse-server and run your own with the same configuration but with logging ...
{"source_file": "tests.md"}
[ 0.03281142935156822, -0.07056919485330582, -0.026376554742455482, -0.10302881896495819, -0.04420130327343941, -0.07485464215278625, -0.0035013870801776648, -0.06343252956867218, -0.05789312347769737, -0.015020879916846752, 0.022237565368413925, 0.015619262121617794, -0.024874906986951828, ...
45c5c4f9-bb78-481b-8578-219eade36256
Help from the Compiler {#help-from-the-compiler} Main ClickHouse code (that is located in src directory) is built with -Wall -Wextra -Werror and with some additional enabled warnings. Although these options are not enabled for third-party libraries. Clang has even more useful warnings - you can look for them wi...
{"source_file": "tests.md"}
[ -0.04010181128978729, -0.03509243205189705, -0.03577660769224167, -0.009894458577036858, 0.07204225659370422, -0.07994098216295242, -0.04330672696232796, 0.03645176440477371, -0.037982817739248276, -0.03932925686240196, 0.02099570445716381, -0.061785925179719925, -0.037254687398672104, -0....
8b80959a-7d64-4c72-9d61-100861378124
We also use sophisticated AST-based query fuzzer that is able to find huge amount of corner cases. It does random permutations and substitutions in queries AST. It remembers AST nodes from previous tests to use them for fuzzing of subsequent tests while processing them in random order. You can learn more about this fuz...
{"source_file": "tests.md"}
[ -0.03079702891409397, -0.008105484768748283, -0.050157513469457626, 0.052481431514024734, -0.0030026808381080627, -0.09489762037992477, 0.060248002409935, -0.01213993038982153, 0.027041103690862656, -0.005379884038120508, -0.021822022274136543, 0.028437968343496323, 0.04257979243993759, -0...
af4847dd-867c-498c-9433-e2c5966a4c3d
It is required to protect from faulty hardware (bit rot on storage media, bit flips in RAM on server, bit flips in RAM of network controller, bit flips in RAM of network switch, bit flips in RAM of client, bit flips on the wire). Note that bit flips are common and likely to occur even for ECC RAM and in presence of TCP...
{"source_file": "tests.md"}
[ -0.030068790540099144, 0.05879109352827072, -0.00900242943316698, -0.021235371008515358, -0.027278555557131767, -0.07098086178302765, -0.06169085577130318, 0.03392054885625839, -0.014387985691428185, 0.02891288883984089, 0.037377506494522095, 0.044735558331012726, -0.06348103284835815, -0....
2a324cd0-b2c1-4cf5-b526-691cd784c56a
description: 'Page describing ClickHouse third-party usage and how to add and maintain third-party libraries.' sidebar_label: 'Third-Party Libraries' sidebar_position: 60 slug: /development/contrib title: 'Third-Party Libraries' doc_type: 'reference' Third-Party Libraries ClickHouse utilizes third-party librari...
{"source_file": "contrib.md"}
[ -0.04113971069455147, -0.14508886635303497, -0.10034043341875076, -0.042894572019577026, 0.03736263886094093, -0.00970121007412672, 0.03747956082224846, -0.013738925568759441, -0.008617337793111801, -0.05822981894016266, 0.028884340077638626, 0.03511104732751846, 0.04383315145969391, -0.08...
8d681039-ef6a-4d97-804e-b7489798270b
Patches are only applied against ClickHouse/ branches of external libraries. There are two ways to do that: - you like to make a new fix against a ClickHouse/ -prefix branch in the forked repository, e.g. a sanitizer fix. In that case, push the fix as a branch with ClickHouse/ prefix, e.g. ClickHouse/fix-saniti...
{"source_file": "contrib.md"}
[ -0.05980890989303589, -0.07696324586868286, 0.0035258105490356684, -0.07587426155805588, 0.013944780454039574, -0.04839852824807167, -0.0029713634867221117, 0.05159927159547806, -0.059904105961322784, 0.033504974097013474, 0.06381471455097198, 0.010251834988594055, 0.04632362723350525, -0....
bcf52e3d-b355-4575-bc51-3aea9aadb381
description: 'Index page for Development and Contributing' slug: /development/ title: 'Development and Contributing' doc_type: 'landing-page' In this section of the docs you will find the following pages:
{"source_file": "index.md"}
[ 0.034735847264528275, -0.028324702754616737, 0.026517806574702263, 0.01388789527118206, 0.03897799551486969, -0.0004663339350372553, -0.043718185275793076, 0.012761819176375866, -0.027829904109239578, 0.03255116939544678, -0.010820021852850914, -0.003839569864794612, -0.010058490559458733, ...
6a7011d9-51f0-447f-bf11-7436c1e84fd2
description: 'Coding style guidelines for ClickHouse C++ development' sidebar_label: 'C++ Style Guide' sidebar_position: 70 slug: /development/style title: 'C++ Style Guide' doc_type: 'guide' C++ style guide General recommendations {#general-recommendations} The following are recommendations, not requirements. ...
{"source_file": "style.md"}
[ -0.06214478239417076, 0.06250769644975662, -0.009853866882622242, -0.023885488510131836, -0.05749738961458206, 0.04622766003012657, -0.05325455963611603, 0.07972443848848343, -0.04005597159266472, 0.033005282282829285, 0.041157931089401245, 0.008005066774785519, 0.017236609011888504, -0.09...
e9a07fc3-7986-4346-82ff-fcbd094dcbc4
12. Put a space after a comma, but not before it. The same rule goes for a semicolon inside a for expression. 13. Do not use spaces to separate the [] operator. 14. In a template <...> expression, use a space between template and < ; no spaces after < or before > . cpp template <typename TKey, type...
{"source_file": "style.md"}
[ -0.065220907330513, 0.12043538689613342, 0.05159000679850578, -0.07005808502435684, -0.0007881045457907021, 0.04016841948032379, -0.0031661067623645067, 0.0896318182349205, -0.005155099090188742, 0.02812046743929386, 0.06116608530282974, -0.030311211943626404, -0.05845578387379646, -0.0485...
e3d79e59-85bf-4ebe-9147-4e2adf1e0186
29. In classes and structs, group members and functions separately inside each visibility scope. 30. For small classes and structs, it is not necessary to separate the method declaration from the implementation. The same is true for small methods in any classes or structs. For template classes and structs, do n...
{"source_file": "style.md"}
[ -0.07876704633235931, 0.05037716031074524, -0.10349666327238083, -0.010685423389077187, -0.03990766406059265, -0.015152799896895885, -0.0017209105426445603, 0.0970001220703125, -0.04098241776227951, -0.008658207021653652, 0.06327307969331741, 0.005385881755501032, 0.006664226297289133, -0....
90f60272-af74-4433-8ddd-01b158167905
8. Single-line comments begin with three slashes: /// and multi-line comments begin with /** . These comments are considered "documentation". Note: You can use Doxygen to generate documentation from these comments. But Doxygen is not generally used because it is more convenient to navigate the code in the IDE. ...
{"source_file": "style.md"}
[ -0.13228151202201843, 0.024120306596159935, 0.019245538860559464, -0.019308075308799744, -0.01590353064239025, -0.01743975654244423, -0.03314455971121788, 0.0958871990442276, -0.0072283316403627396, 0.019835570827126503, -0.006209429819136858, -0.01756361313164234, 0.04728558287024498, 0.0...
2cb42ff0-f07e-4641-8c98-2907031f0ce5
For names of classes and functions, keep the uppercase letters in the abbreviation MySQLConnection (not MySqlConnection ). 12. Constructor arguments that are used just to initialize the class members should be named the same way as the class members, but with an underscore at the end. cpp FileQueueProcessor( ...
{"source_file": "style.md"}
[ -0.06176311522722244, 0.034028973430395126, -0.06342373788356781, -0.024133022874593735, -0.1285487860441208, -0.021337322890758514, 0.09193405508995056, 0.09256218373775482, -0.03345127031207085, 0.024614550173282623, 0.054434701800346375, -0.047557149082422256, 0.0853942334651947, -0.017...
f41a4892-a160-4191-b012-509b3ba271b7
if (exception) exception->rethrow(); ``` Never hide exceptions without handling. Never just blindly put all exceptions to log. cpp //Not correct catch (...) {} If you need to ignore some exceptions, do so only for specific ones and rethrow the rest. cpp catch (const DB::Exception & e) { if (e.code() == ...
{"source_file": "style.md"}
[ -0.02010388672351837, 0.08599670976400375, 0.042365480214357376, 0.036579154431819916, 0.05009469762444496, -0.01237933337688446, -0.0333351194858551, 0.12329496443271637, 0.0021933915559202433, 0.04791171848773956, 0.013702231459319592, -0.009547221474349499, 0.017930228263139725, -0.0450...
9c4720a1-eeef-4214-ab25-4b36b49a6a04
Do not try to implement lock-free data structures unless it is your primary area of expertise. 9. Pointers vs references. In most cases, prefer references. 10. const . Use constant references, pointers to constants, const_iterator , and const methods. Consider const to be default and use non- const o...
{"source_file": "style.md"}
[ -0.04545707628130913, 0.03307341784238815, -0.02371564880013466, -0.08819986134767532, -0.0339231938123703, -0.013525412417948246, 0.053591012954711914, 0.08258526027202606, -0.02671988680958748, -0.021090496331453323, -0.009370123036205769, -0.007312116678804159, -0.03684713691473007, -0....
e40b0655-8f61-4797-863d-5273322fff33
18. Encodings. Use UTF-8 everywhere. Use std::string and char * . Do not use std::wstring and wchar_t . 19. Logging. See the examples everywhere in the code. Before committing, delete all meaningless and debug logging, and any other types of debug output. Logging in cycles should be avoided, even on t...
{"source_file": "style.md"}
[ 0.02298213727772236, 0.061868105083703995, -0.03335363790392876, 0.010106528177857399, -0.0074029769748449326, -0.007665826939046383, 0.05915292352437973, 0.07286803424358368, 0.0076768831349909306, 0.028568435460329056, 0.051336027681827545, -0.0972571074962616, 0.060228947550058365, 0.02...
e2806648-b752-4100-86bf-1cb7f2fe6d60
1. We write code for a specific platform. But other things being equal, cross-platform or portable code is preferred. 2. Language: C++20 (see the list of available C++20 features ). 3. Compiler: clang . At the time of writing (March 2025), the code is compiled using clang version >= 19. The standard librar...
{"source_file": "style.md"}
[ -0.05402541533112526, -0.014817245304584503, -0.02819874696433544, 0.02621515281498432, 0.0030450269114226103, -0.032337334007024765, -0.13100992143154144, 0.09280850738286972, -0.07003327459096909, -0.05003424733877182, -0.015263354405760765, -0.03667403757572174, -0.06427400559186935, -0...
f5142257-ad8f-493e-9543-503b7f1dcaf5
6. Code simplification is encouraged. Reduce the size of your code where possible. Additional recommendations {#additional-recommendations} 1. Explicitly specifying std:: for types from stddef.h is not recommended. In other words, we recommend writing size_t instead std::size_t , because it's shorter. I...
{"source_file": "style.md"}
[ -0.06908927857875824, 0.038402486592531204, 0.05977117642760277, -0.033230431377887726, 0.028450047597289085, -0.05756961181759834, 0.04731022194027901, 0.07089051604270935, -0.015357834286987782, 0.01343529112637043, 0.05151418596506119, -0.044388297945261, -0.014434161596000195, -0.02641...
41a2ed7c-3a1c-4d8b-a894-02d0418d222d
description: 'Guide for building ClickHouse from source for the RISC-V 64 architecture' sidebar_label: 'Build on Linux for RISC-V 64' sidebar_position: 30 slug: /development/build-cross-riscv title: 'How to Build ClickHouse on Linux for RISC-V 64' doc_type: 'guide' How to Build ClickHouse on Linux for RISC-V 64 C...
{"source_file": "build-cross-riscv.md"}
[ -0.03006128966808319, -0.04800025746226311, -0.02515999786555767, -0.06732277572154999, 0.005958174355328083, -0.02426590770483017, -0.08719055354595184, 0.011642072349786758, -0.10086338967084885, -0.060543108731508255, 0.052062515169382095, -0.10052727162837982, -0.018900729715824127, -0...
0ae84e43-3f9c-4499-aef4-643f6ff0e61e
description: 'Guide for building ClickHouse from source for the s390x architecture' sidebar_label: 'Build on Linux for s390x (zLinux)' sidebar_position: 30 slug: /development/build-cross-s390x title: 'Build on Linux for s390x (zLinux)' doc_type: 'guide' Build on Linux for s390x (zLinux) ClickHouse has experimenta...
{"source_file": "build-cross-s390x.md"}
[ 0.007759525906294584, 0.0043091182596981525, -0.0633174329996109, -0.0003005322068929672, 0.014588585123419762, -0.021578630432486534, -0.11281478404998779, 0.03127044811844826, -0.06704756617546082, -0.10286352783441544, 0.030638782307505608, -0.008174124173820019, 0.10620243102312088, -0...
735ae1dd-cbc9-4ae2-a505-593be3497805
In another shell run LLDB and attach, replace <Clickhouse Parent Directory> and <build directory> with the values corresponding to your environment. bash lldb-15 (lldb) target create ./clickhouse Current executable set to '/<Clickhouse Parent Directory>/ClickHouse/<build directory>/programs/clickhouse' (s390x). (...
{"source_file": "build-cross-s390x.md"}
[ 0.06596068292856216, -0.1397765874862671, -0.015963176265358925, -0.10443364828824997, 0.013424692675471306, 0.003674639156088233, -0.046811506152153015, 0.009754224680364132, -0.04424150288105011, 0.02196982502937317, -0.02427254058420658, -0.06665101647377014, -0.010672305710613728, -0.0...
1c459317-7647-47b0-a68e-2ad118a31f9d
settings.json {#settingsjson} This would also put different builds under different subfolders of the build folder. json { "cmake.buildDirectory": "${workspaceFolder}/build/${buildKitVendor}-${buildKitVersion}-${variant:toolchain}-${variant:buildType}", "lldb.library": "/usr/lib/x86_64-linux-gnu/liblldb-15....
{"source_file": "build-cross-s390x.md"}
[ 0.0014195170952007174, 0.03173695504665375, -0.039212096482515335, -0.023883512243628502, -0.013150685466825962, 0.02376640774309635, -0.06018517166376114, 0.08269777148962021, -0.012067978270351887, -0.023702820762991905, 0.0012810323387384415, -0.1154482439160347, 0.00027595245046541095, ...
f72b1395-fd7f-4b29-b8f5-1d67710d7403
description: 'Step-by-step guide for building ClickHouse from source on Linux systems' sidebar_label: 'Build on Linux' sidebar_position: 10 slug: /development/build title: 'How to Build ClickHouse on Linux' doc_type: 'guide' How to Build ClickHouse on Linux :::info You don't have to build ClickHouse yourself! You...
{"source_file": "build.md"}
[ -0.02069961465895176, -0.09359181672334671, -0.03359028697013855, -0.03818289563059807, 0.0049482122994959354, -0.06610473990440369, -0.04510105401277542, 0.021674638614058495, -0.12735266983509064, 0.008605710230767727, 0.06923563778400421, -0.05719498544931412, -0.00020467664580792189, -...
b0c18511-3ea6-4e73-a092-8553fea110d0
Optional: If you have multiple compiler versions installed, you can optionally specify the exact compiler to use. sh export CC=clang-19 export CXX=clang++-19 For development purposes, debug builds are recommended. Compared to release builds, they have a lower compiler optimization level ( -O ) which provides a bett...
{"source_file": "build.md"}
[ -0.000810141209512949, 0.0023191131185740232, 0.0011740954359993339, 0.027291862294077873, -0.010823141783475876, 0.01914447918534279, -0.05973530933260918, 0.04181540384888649, -0.09662341326475143, 0.0004642527783289552, 0.0150368707254529, -0.15598279237747192, 0.018712615594267845, -0....
8b7f0b3e-b0fa-4fa4-9d57-59ac24ae8b63
You can also run your custom-built ClickHouse binary with the config file from the ClickHouse package installed on your system: bash sudo service clickhouse-server stop sudo -u clickhouse ClickHouse/build/programs/clickhouse server --config-file /etc/clickhouse-server/config.xml Building on Any Linux {#building-on-...
{"source_file": "build.md"}
[ 0.0028176545165479183, -0.09714297950267792, -0.007866981439292431, -0.051453158259391785, -0.0018737423233687878, -0.07954243570566177, -0.05723005160689354, 0.014109531417489052, -0.08751118183135986, -0.020692940801382065, 0.02916203811764717, -0.07413317263126373, -0.011584118939936161, ...
e2f1edd1-1f26-486d-9d5f-53670ac2ca9d
description: 'Guide for cross-compiling ClickHouse from Linux for macOS systems' sidebar_label: 'Build on Linux for macOS' sidebar_position: 20 slug: /development/build-cross-osx title: 'Build on Linux for macOS' doc_type: 'guide' How to Build ClickHouse on Linux for macOS This is for the case when you have a Lin...
{"source_file": "build-cross-osx.md"}
[ 0.017629463225603104, -0.05080655217170715, 0.002773431595414877, -0.06805671751499176, -0.014686447568237782, -0.07653530687093735, -0.050854675471782684, -0.01730523072183132, -0.10493606328964233, -0.03902840614318848, 0.07479308545589447, -0.10613766312599182, -0.008141408674418926, -0...
3c756766-110b-4138-a6b1-8e5f3f001d1f
description: 'Overview of the ClickHouse continuous integration system' sidebar_label: 'Continuous Integration (CI)' sidebar_position: 55 slug: /development/continuous-integration title: 'Continuous Integration (CI)' doc_type: 'reference' Continuous Integration (CI) When you submit a pull request, some automated ...
{"source_file": "continuous-integration.md"}
[ 0.017474964261054993, -0.07409293204545975, -0.008236308582127094, -0.02821413055062294, 0.0404214933514595, -0.08881150931119919, -0.041517361998558044, -0.06718795001506805, -0.011144425719976425, 0.03350704908370972, 0.07529373466968536, -0.028144724667072296, 0.01245121005922556, -0.05...
4a5ef858-08e0-46d9-8951-b3983d354ab6
Style check {#style-check} Performs various style checks on the code base. Basic checks in the Style Check job: cpp {#cpp} Performs simple regex-based code style checks using the ci/jobs/scripts/check_style/check_cpp.sh script (which can also be run locally). If it fails, fix the style issues according to th...
{"source_file": "continuous-integration.md"}
[ -0.03085235320031643, 0.04367286339402199, 0.041404686868190765, 0.029611483216285706, -0.00610737968236208, -0.11591097712516785, 0.002998006297275424, -0.048981428146362305, -0.0821470394730568, -0.005127204582095146, -0.026589414104819298, 0.0004853142600040883, 0.052162811160087585, -0...
3c275231-d12b-4054-a811-d541eeeb381f
Other Architectures: - Build (ppc64le) - PowerPC 64-bit Little Endian - Build (riscv64) - RISC-V 64-bit - Build (s390x) - IBM System/390 64-bit - Build (loongarch64) - LoongArch 64-bit If the job succeeds, build results will be available in the <repo_root>/ci/tmp/build directory. Note: For builds not in...
{"source_file": "continuous-integration.md"}
[ -0.022364825010299683, 0.06037479266524315, -0.0484224334359169, 0.027150830253958702, 0.010245298035442829, -0.07720721513032913, -0.1546611189842224, 0.016731614246964455, -0.07928114384412766, 0.0008084702421911061, -0.0098988963291049, -0.10867889970541, -0.025086576119065285, 0.010014...
88a3ab45-4e5b-4f9f-ab90-756e4a9778d9
description: 'How to build Clickhouse and run benchmark with DEFLATE_QPL Codec' sidebar_label: 'Building and Benchmarking DEFLATE_QPL' sidebar_position: 73 slug: /development/building_and_benchmarking_deflate_qpl title: 'Build Clickhouse with DEFLATE_QPL' doc_type: 'guide' Build Clickhouse with DEFLATE_QPL Make...
{"source_file": "building_and_benchmarking_deflate_qpl.md"}
[ -0.07334959506988525, 0.01235208660364151, -0.0007732462836429477, 0.00967178214341402, -0.025814665481448174, -0.05055709183216095, -0.039633460342884064, 0.06659016013145447, -0.11133880168199539, -0.04070073738694191, -0.01898861862719059, -0.05784216895699501, 0.0023899979423731565, 0....
31481a46-91c8-4ca1-8c84-2242d9af078e
- Creating tables in ClickHouse - Inserting data. Here should use ./benchmark_sample/rawdata_dir/ssb-dbgen/*.tbl as input data. - Converting "star schema" to de-normalized "flat schema" Set up database with IAA Deflate codec bash $ cd ./database_dir/deflate $ [CLICKHOUSE_EXE] server -C config_deflate.xml >&/dev/n...
{"source_file": "building_and_benchmarking_deflate_qpl.md"}
[ 0.022036852315068245, -0.06542415916919708, -0.09978657960891724, 0.04364198073744774, -0.06225676089525223, -0.02825571596622467, 0.008584780618548393, 0.06755291670560837, -0.1244223490357399, 0.008416854776442051, 0.016402438282966614, -0.11022382974624634, 0.10562042891979218, -0.03247...
c55aa4b9-ad4a-4c20-8a05-86f0f4515e1e
Multi-instance means multiple(2 or 4)servers connected with respective client. The cores of one socket need to be divided equally and assigned to the servers respectively. For multi-instances, must create new folder for each codec and insert dataset by following the similar steps as single instance. There are 2...
{"source_file": "building_and_benchmarking_deflate_qpl.md"}
[ 0.017215760424733162, -0.11502241343259811, -0.1126081794500351, -0.016037093475461006, -0.05893741548061371, -0.04897760599851608, -0.03336910158395767, 0.03632263466715813, -0.03674113005399704, 0.023372692987322807, 0.03206954523921013, -0.06819319725036621, 0.07059145718812943, -0.0607...
29ebdbac-e943-4fa3-92b1-419d5032f7ed
ZSTD: bash $ cd ./database_dir/zstd $ numactl -C 0-29,120-149 [CLICKHOUSE_EXE] server -C config_zstd.xml >&/dev/null& $ cd ./database_dir/zstd_s2 $ numactl -C 30-59,150-179 [CLICKHOUSE_EXE] server -C config_zstd_s2.xml >&/dev/null& $ cd ./client_scripts $ numactl -m 1 -N 1 python3 client_stressing_test.py queries_ss...
{"source_file": "building_and_benchmarking_deflate_qpl.md"}
[ -0.041614796966314316, 0.02240162342786789, -0.10020294785499573, 0.037973515689373016, 0.018672030419111252, -0.1305612474679947, 0.08127935230731964, 0.10637998580932617, -0.03756805881857872, 0.016489917412400246, 0.029892979189753532, -0.04493353143334389, 0.11053086072206497, 0.010595...
e9e2ed1c-1920-4fc8-a731-4c6e0e0ba5b2
description: 'Guide for building ClickHouse from source for the AARCH64 architecture' sidebar_label: 'Build on Linux for AARCH64' sidebar_position: 25 slug: /development/build-cross-arm title: 'How to Build ClickHouse on Linux for AARCH64' doc_type: 'guide' How to Build ClickHouse on Linux for AARCH64 No special ...
{"source_file": "build-cross-arm.md"}
[ 0.004566616844385862, 0.005092530976980925, -0.021628201007843018, -0.03310106694698334, -0.05781039223074913, -0.023269688710570335, -0.07175125181674957, -0.02795659750699997, -0.0946747288107872, 0.00528256269171834, 0.05408915877342224, -0.09571950137615204, -0.03488896042108536, -0.05...
13918e38-345f-4935-9834-d48e85ca23a2
description: 'Guide for building ClickHouse from source for the LoongArch64 architecture' sidebar_label: 'Build on Linux for LoongArch64' sidebar_position: 35 slug: /development/build-cross-loongarch title: 'Build on Linux for LoongArch64' doc_type: 'guide' Build on Linux for LoongArch64 ClickHouse has experiment...
{"source_file": "build-cross-loongarch.md"}
[ 0.013106372207403183, -0.03229231387376785, -0.01124595571309328, -0.08181121200323105, 0.006000048480927944, -0.06404227018356323, -0.11345386505126953, -0.012763690203428268, -0.08391419798135757, -0.06868387758731842, 0.05190100148320198, -0.09283075481653214, -0.027594102546572685, -0....
14c0de4b-94f0-442f-a244-1fd5e0fc3478
slug: /concepts/faq title: 'FAQ' description: 'Landing page for FAQ' pagination_prev: null pagination_next: null doc_type: 'landing-page' keywords: ['FAQ', 'questions', 'answers'] | Page | Description ...
{"source_file": "index.md"}
[ 0.02274765446782112, 0.030920108780264854, 0.013499456457793713, -0.02442934550344944, 0.007373974658548832, 0.005816450342535973, 0.00468234671279788, 0.02529699169099331, -0.04263091832399368, 0.03299309313297272, 0.015591343864798546, -0.021876946091651917, 0.0411921851336956, -0.038963...
cd63e4d6-c869-45c9-be03-fd9e499bfb1b
slug: /starter-guides title: 'Starter Guides' description: 'Landing page for starter guides' pagination_prev: null pagination_next: null doc_type: 'landing-page' keywords: ['beginner', 'tutorial', 'create table', 'insert data', 'select data', 'update data', 'delete data'] In this section of the docs you'll find sta...
{"source_file": "index.md"}
[ 0.0037561417557299137, -0.012612177059054375, -0.02614196203649044, 0.01229914091527462, -0.06891751289367676, 0.0010825973004102707, -0.029469627887010574, -0.0046620056964457035, -0.009296274743974209, 0.058286070823669434, 0.08535141497850418, 0.021214699372649193, 0.07841794937849045, ...
206eae59-800f-491d-aa92-7248cb74af61
slug: /troubleshooting sidebar_label: 'Troubleshooting' doc_type: 'guide' keywords: [ 'clickhouse troubleshooting', 'clickhouse errors', 'database troubleshooting', 'clickhouse connection issues', 'memory limit exceeded', 'clickhouse performance problems', 'database error messages', 'clickhouse configur...
{"source_file": "index.md"}
[ 0.046762846410274506, -0.008601749315857887, -0.027472419664263725, 0.07271156460046768, -0.0160597562789917, -0.060426369309425354, -0.03695301711559296, -0.017609504982829094, -0.11311908066272736, 0.028099671006202698, 0.052685417234897614, 0.039203181862831116, 0.01863103359937668, 0.0...
f009848b-f447-4c3c-8265-1bee0479ca7d
High memory usage, out-of-memory crashes, or need help sizing your ClickHouse deployment. Show memory solutions ### Memory debugging and monitoring: {#memory-debugging-and-monitoring} - [Identify what's using memory](/docs/guides/developer/debugging-memory-issues) - [Check current memory usage](/docs/operations/...
{"source_file": "index.md"}
[ 0.06235187128186226, -0.025930188596248627, -0.07218223065137863, -0.01023120991885662, -0.06681859493255615, -0.03416651114821434, 0.015336578711867332, 0.06105875223875046, -0.11366093903779984, 0.0707755759358406, 0.021044692024588585, 0.03738109767436981, -0.016836240887641907, 0.01399...
0dfe6f56-0d7b-47db-b70b-ab2e366f7f99
### Advanced configuration {#advanced-configuration} - [Set up data replication](/docs/engines/table-engines/mergetree-family/replication) - [Configure distributed tables](/docs/engines/table-engines/special/distributed) - [Set up backup and recovery](/docs/operations/backup) - [Configure monitoring](/docs/operations...
{"source_file": "index.md"}
[ 0.00005128472184878774, -0.13195234537124634, -0.019156862050294876, 0.0074497428722679615, 0.03043944016098976, -0.08445245772600174, -0.022125303745269775, -0.005811998154968023, -0.07008235156536102, 0.1082419604063034, 0.024461574852466583, -0.018814442679286003, 0.06696509569883347, -...
8c6a1d39-8a86-40d5-b36f-3297f63b2b82
description: 'Guide to configuring secure SSL/TLS communication between ClickHouse and ZooKeeper' sidebar_label: 'Secured Communication with Zookeeper' sidebar_position: 45 slug: /operations/ssl-zookeeper title: 'Optional secured communication between ClickHouse and Zookeeper' doc_type: 'guide' Optional secured c...
{"source_file": "ssl-zookeeper.md"}
[ -0.028924018144607544, 0.035711146891117096, -0.05781378597021103, -0.0056667206808924675, -0.03105120174586773, -0.05940753221511841, -0.0023028748109936714, -0.03520891070365906, -0.017102954909205437, 0.008703779429197311, -0.006922111846506596, -0.08192409574985504, 0.08218076825141907, ...
e3a6d433-c553-4664-a27c-63bd3d1b3ed6
description: 'Documentation for Named collections' sidebar_label: 'Named collections' sidebar_position: 69 slug: /operations/named-collections title: 'Named collections' doc_type: 'reference' import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge'; Named collections provide a way to store coll...
{"source_file": "named-collections.md"}
[ -0.10798317939043045, -0.04212656989693642, -0.10803069174289703, 0.01667007803916931, -0.07523291558027267, 0.02193501964211464, 0.024205291643738747, -0.05733872205018997, 0.04052869975566864, 0.015514103695750237, 0.03927929326891899, -0.024720966815948486, 0.09458564221858978, -0.05613...
8f080fad-26b3-45d6-80ea-a817b1922f8a
:::tip In the above example the password_sha256_hex value is the hexadecimal representation of the SHA256 hash of the password. This configuration for the user default has the attribute replace=true as in the default configuration has a plain text password set, and it is not possible to have both plain text an...
{"source_file": "named-collections.md"}
[ -0.008140146732330322, 0.033550746738910675, -0.11836976557970047, -0.026002535596489906, -0.061981040984392166, -0.010685653425753117, -0.002491650404408574, -0.016199536621570587, 0.030228974297642708, 0.04001641646027565, 0.005298612639307976, -0.030484672635793686, 0.051916010677814484, ...
986f7728-077e-478b-a694-9bc155397a9f
sql ALTER NAMED COLLECTION collection2 SET key1=4 OVERRIDABLE Remove the key key2 from collection2 : sql ALTER NAMED COLLECTION collection2 DELETE key2 Change or add the key key1 and delete the key key3 of the collection collection2 : sql ALTER NAMED COLLECTION collection2 SET key1=4, DELETE key3 To for...
{"source_file": "named-collections.md"}
[ -0.04065796360373497, -0.047514356672763824, -0.09104202687740326, -0.02201993018388748, -0.11578798294067383, -0.0373288169503212, 0.017468664795160294, -0.07918491959571838, -0.002034455304965377, 0.045297302305698395, 0.0606791153550148, -0.031017368659377098, 0.07117071747779846, -0.10...
edc19648-d89f-410a-8bfc-240458233301
XML example {#xml-example-2} xml <clickhouse> <named_collections> <mymysql> <user>myuser</user> <password>mypass</password> <host>127.0.0.1</host> <port>3306</port> <database>test</database> <connection_pool_size>8</connection_pool_si...
{"source_file": "named-collections.md"}
[ 0.022528117522597313, -0.020548848435282707, -0.09381487220525742, 0.0011359634809195995, -0.12437162548303604, -0.046417590230703354, 0.019698994234204292, 0.04830782860517502, 0.0018294380279257894, -0.03186924383044243, 0.0736277773976326, -0.0753447636961937, 0.14607003331184387, -0.09...
1d052ea1-be8e-4498-afeb-bdf4c6d335f2
sql CREATE NAMED COLLECTION mypg AS user = 'pguser', password = 'jw8s0F4', host = '127.0.0.1', port = 5432, database = 'test', schema = 'test_schema' Example of configuration: xml <clickhouse> <named_collections> <mypg> <user>pguser</user> <password>jw8s0F4</password> ...
{"source_file": "named-collections.md"}
[ 0.02564668282866478, -0.06767068058252335, -0.12470962852239609, 0.007639097049832344, -0.14671838283538818, -0.046119965612888336, 0.007729857228696346, -0.004120636731386185, -0.03546413406729698, -0.0015092818066477776, 0.02037939243018627, -0.03457370027899742, 0.048348456621170044, -0...
530c58a5-c07f-4587-8317-060fbdcd185f
Example of using named collections with the remote / remoteSecure functions {#example-of-using-named-collections-with-the-remoteremotesecure-functions} ```sql SELECT * FROM remote(remote1, table = one); ┌─dummy─┐ │ 0 │ └───────┘ SELECT * FROM remote(remote1, database = merge(system, '^one')); ┌─dummy─┐ │ ...
{"source_file": "named-collections.md"}
[ -0.02457434870302677, -0.057130686938762665, -0.0727459043264389, 0.005061951465904713, -0.1132153570652008, -0.09131234884262085, -0.0007973958272486925, -0.02018715813755989, 0.014834715984761715, 0.07350035011768341, 0.06012917682528496, -0.01534706074744463, 0.11723436415195465, -0.009...
cc2c95d2-2944-44eb-87b5-6f4e42fe531d
Named collections for accessing MongoDB Table and Dictionary {#named-collections-for-accessing-mongodb-table-and-dictionary} For the description of parameters see mongodb . DDL example {#ddl-example-5} sql CREATE NAMED COLLECTION mymongo AS user = '', password = '', host = '127.0.0.1', port = 27017, database = '...
{"source_file": "named-collections.md"}
[ 0.07991261780261993, -0.008584508672356606, -0.10352619737386703, 0.036527976393699646, -0.08760744333267212, -0.10449893027544022, 0.01734032668173313, 0.013263956643640995, 0.000817290332634002, 0.03460870683193207, 0.06958053261041641, -0.09779127687215805, 0.07193616032600403, -0.04605...
8c3083c2-2c97-4b76-8332-c4abec8dfa25
description: 'Page describing usage recommendations for open-source ClickHouse' sidebar_label: 'OSS usage recommendations' sidebar_position: 58 slug: /operations/tips title: 'OSS usage recommendations' doc_type: 'guide' import SelfManaged from '@site/docs/_snippets/_self_managed_only_automated.md'; CPU Scaling ...
{"source_file": "tips.md"}
[ 0.034696806222200394, -0.0081162229180336, -0.06530099362134933, 0.094374880194664, 0.05998674035072327, -0.10270654410123825, 0.009198724292218685, 0.08045902848243713, -0.07654896378517151, 0.013202656991779804, -0.025862162932753563, 0.042080868035554886, -0.020764334127306938, -0.05783...
360409f8-1f43-40f2-8ca1-336e149fd511
command. - We do not recommend using S3 or Kafka integrations on low-memory machines because they require significant memory for buffers. Storage Subsystem {#storage-subsystem} If your budget allows you to use SSD, use SSD. If not, use HDD. SATA HDDs 7200 RPM will do. Give preference to a lot of servers with loca...
{"source_file": "tips.md"}
[ -0.005599487107247114, -0.026643414050340652, -0.12054964900016785, -0.07689189165830612, -0.03295838460326195, 0.024644173681735992, -0.09856351464986801, 0.06859926879405975, -0.02944459766149521, 0.03229842707514763, -0.046389684081077576, 0.04765204340219498, 0.028248203918337822, -0.0...
24ad1342-78c7-4678-9efe-21301d9e7f86
While ClickHouse can work over NFS, it is not the best idea. Linux Kernel {#linux-kernel} Don't use an outdated Linux kernel. Network {#network} If you are using IPv6, increase the size of the route cache. The Linux kernel prior to 3.2 had a multitude of problems with IPv6 implementation. Use at least a 10 GB...
{"source_file": "tips.md"}
[ 0.00446720514446497, -0.05505203455686569, -0.03350087255239487, -0.02712045982480049, 0.01313581969588995, -0.1051107719540596, -0.10676983743906021, -0.02297109365463257, -0.08948595821857452, 0.013549755327403545, 0.013531822711229324, 0.11710596829652786, -0.05227365344762802, -0.04821...
09003670-a2a2-42b4-bdf2-645ad2debb49
You can have ZooKeeper observers in an ensemble but ClickHouse servers should not interact with observers. Do not change minSessionTimeout setting, large values may affect ClickHouse restart stability. With the default settings, ZooKeeper is a time bomb: The ZooKeeper server won't delete files from old snapsh...
{"source_file": "tips.md"}
[ -0.056450363248586655, -0.0005488788592629135, 0.03243064507842064, 0.03066926635801792, 0.03334755077958107, -0.05277632921934128, -0.025659840553998947, -0.026769977062940598, 0.016360430046916008, 0.04362766072154045, -0.09713464230298996, -0.021776506677269936, 0.013795604929327965, 0....
20ce7967-a611-444e-8018-c49f398a1c7a
coordinates updates. For higher update throughput at thes slight expense of read throughput the leader can be configured to not accept clients and focus on coordination. leaderServes=yes standaloneEnabled=false dynamicConfigFile=/etc/zookeeper-{{ '{{' }} cluster['name'] {{ '}}' }}/conf/zoo.cfg.dynamic ``` Jav...
{"source_file": "tips.md"}
[ 0.004502894356846809, 0.04678613319993019, -0.0765935406088829, -0.013544402085244656, 0.027753274887800217, -0.06147310882806778, -0.017509890720248222, -0.005292493384331465, -0.0031515993177890778, 0.03818965330719948, 0.011596142314374447, -0.04161075875163078, 0.03636632859706879, 0.0...
ecd1d512-ff45-4f3d-8697-d38fe45f7983
ZOOCFG="$ZOOCFGDIR/zoo.cfg" ZOO_LOG_DIR=/var/log/$NAME USER=zookeeper GROUP=zookeeper PIDDIR=/var/run/$NAME PIDFILE=$PIDDIR/$NAME.pid SCRIPTNAME=/etc/init.d/$NAME JAVA=/usr/local/jdk-11/bin/java ZOOMAIN="org.apache.zookeeper.server.quorum.QuorumPeerMain" ZOO_LOG4J_PROP="INFO,ROLLINGFILE" JMXLOCALONLY=false JAVA_OPTS="-...
{"source_file": "tips.md"}
[ 0.04294174164533615, 0.03766482323408127, -0.05365518853068352, -0.04152866452932358, -0.019895657896995544, -0.012668859213590622, 0.01767715997993946, 0.08041101694107056, -0.025613827630877495, 0.04264916107058525, 0.04351775720715523, -0.08266724646091461, 0.04092361405491829, 0.025485...
224d6cfe-2a23-4da9-a1eb-f6ce5203417c
description: 'Guide to using and configuring the query cache feature in ClickHouse' sidebar_label: 'Query cache' sidebar_position: 65 slug: /operations/query-cache title: 'Query cache' doc_type: 'guide' Query cache The query cache allows to compute SELECT queries just once and to serve further executions of the...
{"source_file": "query-cache.md"}
[ -0.011520135216414928, -0.027104008942842484, 0.024341069161891937, 0.05769922584295273, -0.08645375818014145, -0.1398490071296692, 0.036676835268735886, -0.0845908373594284, 0.06190713495016098, -0.03671297803521156, 0.008971638046205044, 0.09201203286647797, 0.0031509289983659983, -0.069...
6f200f61-27bf-46ae-942a-04078ecd87b4
sql SELECT some_expensive_calculation(column_1, column_2) FROM table SETTINGS use_query_cache = true; will store the query result in the query cache. Subsequent executions of the same query (also with parameter use_query_cache = true ) will read the computed result from the cache and return it immediately. :::note...
{"source_file": "query-cache.md"}
[ -0.009567467495799065, -0.03805484250187874, -0.0838017463684082, 0.08343882858753204, -0.028335321694612503, -0.07220323383808136, 0.07376179844141006, -0.019929010421037674, 0.07185612618923187, 0.053915198892354965, 0.022446593269705772, -0.012214033864438534, 0.004477695561945438, -0.0...
c55f8ff4-70c0-46c6-95f0-176ef32f3404
If the query was aborted due to an exception or user cancellation, no entry is written into the query cache. The size of the query cache in bytes, the maximum number of cache entries and the maximum size of individual cache entries (in bytes and in records) can be configured using different server configuration opti...
{"source_file": "query-cache.md"}
[ 0.08439622074365616, 0.020156966522336006, -0.06975828111171722, 0.013710899278521538, -0.10962971299886703, -0.050883352756500244, 0.023706451058387756, 0.03725342079997063, -0.07309132069349289, 0.016924407333135605, -0.01058912742882967, 0.05632578581571579, 0.07099555432796478, -0.1006...
5571f7be-af9b-4b8d-8370-b831fc6c11d8
Entries in the query cache are compressed by default. This reduces the overall memory consumption at the cost of slower writes into / reads from the query cache. To disable compression, use setting query_cache_compress_entries . Sometimes it is useful to keep multiple results for the same query cached. This can be a...
{"source_file": "query-cache.md"}
[ 0.016490302979946136, 0.03774920850992203, -0.08617992699146271, 0.04296477138996124, -0.054472919553518295, -0.09534387290477753, 0.07037630677223206, -0.035723745822906494, 0.010912199504673481, 0.03440593555569649, 0.006040130741894245, 0.028969278559088707, 0.047448866069316864, -0.112...
81151050-dc34-43e2-8f32-cfa60d6fdd68
information_schema.tables ) are not cached by default. To force caching of results of queries with system tables regardless, use setting query_cache_system_table_handling . Finally, entries in the query cache are not shared between users due to security reasons. For example, user A must not be able to bypass a row p...
{"source_file": "query-cache.md"}
[ 0.061277009546756744, -0.055303845554590225, -0.029587164521217346, -0.02583470568060875, -0.039487119764089584, -0.06848981976509094, 0.038305241614580154, -0.07065755128860474, -0.027574660256505013, 0.0036667927633970976, 0.028369084000587463, 0.058928389102220535, 0.03132696449756622, ...
ecfd8bba-dc68-4f38-a9c3-930d959bab39
description: 'Page detailing allocation profiling in ClickHouse' sidebar_label: 'Allocation profiling' slug: /operations/allocation-profiling title: 'Allocation profiling' doc_type: 'guide' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; Allocation profiling ClickHouse uses jemalloc as i...
{"source_file": "allocation-profiling.md"}
[ 0.08703623712062836, -0.036818988621234894, -0.14526936411857605, 0.01465738657861948, 0.038813114166259766, -0.036150939762592316, 0.11002808064222336, 0.002330497605726123, -0.10200221836566925, 0.04976123198866844, -0.010482321493327618, -0.06431170552968979, -0.0025285910815000534, -0....
a4c1d5be-4ace-4820-9679-64bae7fbf7c8
:::note If ClickHouse was started with jemalloc_enable_global_profiler , you don't have to enable jemalloc_enable_profiler . Same is true for jemalloc_collect_global_profile_samples_in_trace_log and jemalloc_collect_profile_samples_in_trace_log . ::: We will flush the system.trace_log : sql SYSTEM FLUSH LOG...
{"source_file": "allocation-profiling.md"}
[ 0.0836753249168396, -0.04461638256907463, -0.055413637310266495, 0.06220531836152077, -0.016323905438184738, -0.04395580664277077, 0.09004314243793488, 0.025982117280364037, -0.06648305058479309, 0.03712514042854309, -0.01919109933078289, -0.07551583647727966, 0.03566150739789009, -0.07108...
096582de-4c1f-478e-93b3-166683524f22
For Keeper, the default file is /tmp/jemalloc_keeper._pid_._seqnum_.heap , and follows the same rules. You can tell jemalloc to flush the current profile by running: sql SYSTEM JEMALLOC FLUSH PROFILE It will return the location of the flushed profile. sh echo jmfp | nc localhost 9181 A differen...
{"source_file": "allocation-profiling.md"}
[ 0.011059832759201527, -0.01823933608829975, -0.15440569818019867, -0.02063431404531002, -0.028496528044342995, -0.02799191325902939, 0.05631174147129059, 0.048203252255916595, -0.0850704088807106, 0.03993088752031326, 0.007091153878718615, -0.03596705198287964, 0.04781532287597656, -0.0572...
ea1a2109-b0bc-402e-bcb8-e6fdd1cce6a1
sh cat result.collapsed | /path/to/FlameGraph/flamegraph.pl --color=mem --title="Allocation Flame Graph" --width 2400 > result.svg Another interesting tool is speedscope that allows you to analyze collected stacks in a more interactive way. Additional options for the profiler {#additional-options-for-profiler} ...
{"source_file": "allocation-profiling.md"}
[ 0.014462544582784176, 0.03970613703131676, -0.11723362654447556, 0.02844633162021637, 0.021851668134331703, -0.053459152579307556, 0.009310238994657993, 0.07540819048881531, -0.037808310240507126, -0.04070395231246948, -0.05881110206246376, -0.03604118153452873, -0.040093157440423965, -0.0...
89d2cae3-066b-4d30-b895-eea20c981d87
description: 'Guide to testing and benchmarking hardware performance with ClickHouse' sidebar_label: 'Testing Hardware' sidebar_position: 54 slug: /operations/performance-test title: 'How to Test Your Hardware with ClickHouse' doc_type: 'guide' import SelfManaged from '@site/docs/_snippets/_self_managed_only_no_roa...
{"source_file": "performance-test.md"}
[ -0.008593942038714886, -0.03699863702058792, -0.04175075516104698, 0.022492898628115654, -0.04149062559008598, -0.14174695312976837, -0.04151526093482971, -0.016408123075962067, -0.1379241943359375, -0.019032759591937065, 0.03142455965280533, -0.04370107501745224, 0.010443859733641148, -0....
33a4c88f-4c80-41f4-acf4-b6eaa906396c
description: 'Documentation for Workload Scheduling' sidebar_label: 'Workload scheduling' sidebar_position: 69 slug: /operations/workload-scheduling title: 'Workload scheduling' doc_type: 'reference' When ClickHouse execute multiple queries simultaneously, they may be using shared resources (e.g. disks and CPU core...
{"source_file": "workload-scheduling.md"}
[ 0.022257160395383835, -0.03810763359069824, -0.07614541798830032, 0.08809491246938705, -0.0442843921482563, -0.05962013825774193, 0.02181946113705635, 0.05200871080160141, -0.044895123690366745, 0.036493707448244095, -0.04389036074280739, 0.06013653799891472, 0.04501722753047943, 0.0042913...
b0f03b77-0eed-4c20-850d-1e6bf58aceb4
Note that server configuration options have priority over SQL way to define resources. Workload markup {#workload_markup} Queries can be marked with setting workload to distinguish different workloads. If workload is not set, than value "default" is used. Note that you are able to specify the other value using ...
{"source_file": "workload-scheduling.md"}
[ 0.005414661951363087, -0.021274633705615997, -0.015001269057393074, 0.04513508081436157, -0.062143873423337936, -0.057992856949567795, 0.05055319890379906, 0.011452065780758858, -0.053225837647914886, -0.008152905851602554, 0.00578523613512516, -0.018491044640541077, 0.08164756745100021, 0...
f9d762dc-e213-40ad-9064-ad64b551c112
To be able to use the full capacity of the underlying resource, you should use inflight_limit . Note that a low number of max_requests or max_cost could lead to not full resource utilization, while too high numbers could lead to empty queues inside the scheduler, which in turn will result in policies being ignored...
{"source_file": "workload-scheduling.md"}
[ -0.027708586305379868, 0.031494081020355225, -0.03231078386306763, -0.006834310945123434, -0.016024695709347725, -0.09280600398778915, 0.016808364540338516, 0.008491188287734985, -0.0531032532453537, 0.038633354008197784, -0.1047639399766922, 0.009518647566437721, -0.017786601558327675, 0....
68efaf2f-38be-4da7-9845-80daeb00833d
Workload hierarchy {#workloads} ClickHouse provides convenient SQL syntax to define scheduling hierarchy. All resources that were created with CREATE RESOURCE share the same structure of the hierarchy, but could differ in some aspects. Every workload created with CREATE WORKLOAD maintains a few automatically crea...
{"source_file": "workload-scheduling.md"}
[ -0.06178303435444832, -0.04312850162386894, -0.07069021463394165, 0.08151456713676453, -0.06840695440769196, -0.10137898474931717, -0.0018422799184918404, -0.0032217977568507195, -0.03563319519162178, 0.027375096455216408, 0.0027984995394945145, -0.03901577368378639, 0.06928487122058868, -...
2ae6389d-fccc-483a-908f-64e0bc1940e3
Also note that workload or resource could not be dropped if it is referenced from another workload. To update a definition of a workload use CREATE OR REPLACE WORKLOAD query. :::note Workload settings are translated into a proper set of scheduling nodes. For lower-level details, see the description of the schedulin...
{"source_file": "workload-scheduling.md"}
[ -0.036745477467775345, -0.05366921424865723, -0.02343117631971836, 0.06281737983226776, -0.07544582337141037, -0.10127196460962296, 0.04183794558048248, -0.04799976572394371, 0.007279560435563326, 0.019874120131134987, -0.024348074570298195, 0.03620953857898712, 0.009928854182362556, -0.04...
63493361-99ad-4e3f-88e6-664dfade3b37
Limiting the concurrency of master threads will not limit the number of concurrent queries. CPU slots could be released in the middle of the query execution and reacquired by other threads. For example, 4 concurrent queries with 2 concurrent master thread limit could all be executed in parallel. In this case, every que...
{"source_file": "workload-scheduling.md"}
[ -0.02162100374698639, -0.0275577325373888, -0.03165304288268089, 0.02905595488846302, -0.09515637159347534, -0.04344967380166054, 0.05865301564335823, -0.02405250445008278, -0.017436908558011055, 0.02560783177614212, -0.043096281588077545, -0.01856728084385395, 0.04109756648540497, -0.0200...
149f2035-0b34-4d65-becd-07776ddbe55b
:::note Declaring CPU resource disables effect of concurrent_threads_soft_limit_num and concurrent_threads_soft_limit_ratio_to_cores settings. Instead, workload setting max_concurrent_threads is used to limit the number of CPUs allocated for a specific workload. To achieve the previous behavior create only WORKER...
{"source_file": "workload-scheduling.md"}
[ -0.07963677495718002, 0.009611839428544044, -0.028707370162010193, 0.05644313618540764, -0.01468685269355774, -0.037345755845308304, 0.005815949756652117, -0.011373819783329964, 0.03661429509520531, 0.015071763657033443, -0.01833777315914631, -0.011176680214703083, -0.007470768876373768, -...
6b608681-ab72-4daa-9634-bb0dca95466c
Let's consider an example of configuration that combines both CPU throttling and thread number limits: sql CREATE RESOURCE cpu (MASTER THREAD, WORKER THREAD) CREATE WORKLOAD all SETTINGS max_concurrent_threads_ratio_to_cores = 2 CREATE WORKLOAD admin IN all SETTINGS max_concurrent_threads = 2, priority = -1 CREATE WO...
{"source_file": "workload-scheduling.md"}
[ -0.020523453131318092, -0.045781854540109634, -0.028400888666510582, 0.026285625994205475, -0.04985050857067108, -0.07432123273611069, 0.004714496433734894, -0.039106082171201706, -0.009380294941365719, -0.01144507434219122, -0.012148608453571796, 0.0008086866582743824, 0.03679463639855385, ...
f28fe875-5588-459e-ae25-14cfd3b8e4bd
Workload settings max_queries_per_second and max_burst_queries limit number of queries for the workload with a token bucket throttler. It guarantees that during any time interval T no more than max_queries_per_second * T + max_burst_queries new queries will start execution. Workload setting max_waiting_queri...
{"source_file": "workload-scheduling.md"}
[ -0.03563258424401283, -0.008801093325018883, -0.010232868604362011, 0.005806667730212212, -0.036676112562417984, -0.09043039381504059, 0.013154329732060432, -0.0023257629945874214, -0.005201214458793402, 0.07907088100910187, -0.05852874368429184, -0.014836042188107967, -0.002646839478984475,...
9d939a60-b6be-403f-85fc-32bae018895a
Another use case is different configuration for different nodes in a heterogeneous cluster. Strict resource access {#strict_resource_access} To enforce all queries to follow resource scheduling policies there is a server setting throw_on_unknown_workload . If it is set to true then every query is required to use...
{"source_file": "workload-scheduling.md"}
[ -0.028804590925574303, 0.0645478218793869, -0.023566067218780518, 0.11001329869031906, -0.019725525751709938, -0.029013322666287422, -0.012394563294947147, -0.036258988082408905, -0.03524938225746155, 0.002578185871243477, -0.021075192838907242, 0.0007737077539786696, -0.017852909862995148, ...
f0122509-5546-4f65-abe6-3109d210d1df
description: 'Guide to configuring and managing resource usage quotas in ClickHouse' sidebar_label: 'Quotas' sidebar_position: 51 slug: /operations/quotas title: 'Quotas' doc_type: 'guide' :::note Quotas in ClickHouse Cloud Quotas are supported in ClickHouse Cloud but must be created using the DDL syntax . The XML...
{"source_file": "quotas.md"}
[ -0.007736729457974434, 0.022235948592424393, -0.04134887084364891, 0.024403460323810577, -0.05816672742366791, -0.03616435080766678, 0.019798992201685905, -0.01395315583795309, 0.030453363433480263, 0.029913533478975296, -0.007553177885711193, -0.029017282649874687, 0.07541994005441666, -0...
9717db4c-f513-4174-bd87-373b5a55617d
Here are the amounts that can be restricted: queries – The total number of requests. query_selects – The total number of select requests. query_inserts – The total number of insert requests. errors – The number of queries that threw an exception. result_rows – The total number of rows given as a result. ...
{"source_file": "quotas.md"}
[ -0.011790459044277668, -0.022793453186750412, -0.0689050555229187, 0.04267679527401924, -0.052024614065885544, -0.036817003041505814, -0.01899806223809719, 0.04630150645971298, 0.01629718579351902, 0.051610104739665985, -0.04041285812854767, -0.003536839736625552, 0.11181022971868515, -0.0...
2092e9ff-4e86-4892-b5b7-8b600685b5c6
description: 'caching mechanism that allows for caching of data in in-process memory rather than relying on the OS page cache.' sidebar_label: 'Userspace page cache' sidebar_position: 65 slug: /operations/userspace-page-cache title: 'Userspace page cache' doc_type: 'reference' Userspace page cache Overview {#ove...
{"source_file": "userspace-page-cache.md"}
[ -0.009813116863369942, -0.017225658521056175, -0.01647036336362362, 0.01033720187842846, -0.016096094623208046, -0.05602307245135307, 0.013976610265672207, -0.01957063376903534, 0.06614556163549423, 0.0794970765709877, 0.02460147626698017, 0.12384629249572754, 0.005696097854524851, -0.0815...
009fcfca-62c2-4d1e-9351-c43be3b353b6
| Setting | Description ...
{"source_file": "userspace-page-cache.md"}
[ 0.0273667573928833, 0.04266985505819321, -0.006559492088854313, -0.007316181436181068, -0.06094277277588844, 0.07176969945430756, 0.012952437624335289, 0.047629036009311676, 0.028226379305124283, -0.05743034929037094, 0.021556850522756577, -0.04850621894001961, -0.025508733466267586, -0.05...
4e609264-d684-4fe6-b8bb-30c56fcbd9c9
1000 | | page_cache_policy | Userspace page cache policy name. ...
{"source_file": "userspace-page-cache.md"}
[ 0.0018328825244680047, 0.00475149042904377, -0.11384468525648117, 0.014674008823931217, -0.018726404756307602, -0.021521035581827164, 0.027930159121751785, -0.006128111854195595, -0.04962422326207161, -0.009656899608671665, 0.05754408985376358, 0.06440749764442444, 0.002032445976510644, -0...
57a37f8a-928c-43ae-9999-51beeeef4bd1
Related content {#related-content} Filesystem cache ClickHouse v25.3 Release Webinar
{"source_file": "userspace-page-cache.md"}
[ -0.0035867555998265743, -0.07441461086273193, -0.05780106037855148, -0.06291677802801132, 0.053964629769325256, -0.04513683542609215, -0.013428142294287682, -0.09689870476722717, -0.04354486241936684, -0.017700545489788055, 0.10900546610355377, 0.059445083141326904, -0.038535889238119125, ...
c69af3c2-5dbb-49b7-8d7b-d2ce16dd368f
description: 'Documentation for cluster discovery in ClickHouse' sidebar_label: 'Cluster discovery' slug: /operations/cluster-discovery title: 'Cluster discovery' doc_type: 'guide' Cluster discovery Overview {#overview} ClickHouse's Cluster Discovery feature simplifies cluster configuration by allowing nodes to...
{"source_file": "cluster-discovery.md"}
[ 0.004278145730495453, -0.07132136821746826, -0.03138948231935501, 0.037550631910562515, 0.03304494917392731, -0.004988338798284531, -0.027692724019289017, -0.1196083351969719, -0.012307269498705864, 0.028419148176908493, 0.05677422881126404, -0.04033268615603447, 0.05348573625087738, -0.01...
3c98943c-6cbe-42a7-b812-fd1d11d808d7
xml <discovery> <path>/clickhouse/discovery/cluster_name</path> <observer/> </discovery> Discovery of clusters {#discovery-of-clusters} Sometimes you may need to add and remove not only hosts in clusters, but clusters themselves. You can use the <multicluster_root_path> node with root path for several clu...
{"source_file": "cluster-discovery.md"}
[ 0.016744356602430344, -0.09247290343046188, -0.04514077305793762, 0.054909396916627884, 0.058737561106681824, -0.05193120613694191, 0.004070304334163666, -0.0834682509303093, 0.019696662202477455, 0.010799894109368324, 0.05745447054505348, -0.10629594326019287, 0.04106270894408226, -0.0201...
3dd72c00-2cc6-412e-b7f2-f21fd43d7b9f
```sql CREATE TABLE event_table ON CLUSTER default (event_time DateTime, value String) ENGINE = ReplicatedMergeTree('/clickhouse/tables/event_table', '{replica}') ORDER BY event_time PARTITION BY toYYYYMM(event_time); INSERT INTO event_table ... ``` Then, we add a new node to the cluster, starting a new node with t...
{"source_file": "cluster-discovery.md"}
[ 0.025296568870544434, -0.07546321302652359, 0.009481086395680904, 0.07441896200180054, -0.020265640690922737, -0.032824765890836716, -0.03519132733345032, -0.025569580495357513, -0.00692885322496295, 0.10831042379140854, 0.03579796105623245, -0.05264175683259964, 0.04333321377635002, -0.06...
1fada436-637c-4221-8246-75bb95c882dc
description: 'Guide to configuring and using SQL startup scripts in ClickHouse for automatic schema creation and migrations' sidebar_label: 'Startup scripts' slug: /operations/startup-scripts title: 'Startup scripts' doc_type: 'guide' Startup scripts ClickHouse can run arbitrary SQL queries from the server conf...
{"source_file": "startup-scripts.md"}
[ 0.04746353626251221, -0.04511941596865654, -0.04365703836083412, 0.051078490912914276, -0.03086225315928459, -0.010285572148859501, 0.024219200015068054, 0.01859309710562229, -0.08751899749040604, 0.025899050757288933, 0.0994400829076767, -0.040960777550935745, 0.08246064186096191, -0.0624...
73721319-1dd1-4e8c-8ab8-0dc32889239f
description: 'Documentation for Update' sidebar_title: 'Self-managed Upgrade' slug: /operations/update title: 'Self-managed Upgrade' doc_type: 'guide' ClickHouse upgrade overview {#clickhouse-upgrade-overview} This document contains: - general guidelines - a recommended plan - specifics for upgrading the binaries...
{"source_file": "update.md"}
[ 0.03274352476000786, -0.028439601883292198, 0.03880443423986435, -0.05390443652868271, 0.02968197502195835, -0.06227100268006325, -0.04618089646100998, -0.06504783034324646, -0.10020923614501953, 0.05266617238521576, 0.07122919708490372, 0.020278777927160263, 0.007471384014934301, 0.001689...
9bd17c39-5e16-49dc-a5a6-48985edcb32e
We never recommend running different versions in the same cluster when the release dates are more than one year. While we do not expect that you will have data loss, the cluster may become unusable. The issues that you should expect if you have more than one year difference in versions include: the cluster may not ...
{"source_file": "update.md"}
[ 0.013945357874035835, -0.03252560272812843, 0.07392249256372452, -0.018820470198988914, -0.004846683703362942, -0.06576158106327057, -0.10201345384120941, -0.051311686635017395, -0.07276976853609085, -0.01840858906507492, 0.02822730876505375, 0.0017242179019376636, 0.00807943008840084, -0....
2f2f5aa9-6c83-4169-abf5-d290ae0b19c2
If you installed ClickHouse using something other than the recommended deb packages, use the appropriate update method. :::note You can update multiple servers at once as soon as there is no moment when all replicas of one shard are offline. ::: The upgrade of older version of ClickHouse to specific version: As...
{"source_file": "update.md"}
[ 0.03747444599866867, -0.12685871124267578, 0.0012482275487855077, -0.08797366917133331, -0.03352927044034004, -0.061461061239242554, -0.04681757837533951, -0.11271041631698608, -0.040079470723867416, 0.0017061292892321944, 0.05559549480676651, 0.03622731938958168, -0.005544769112020731, 0....
16df5d4f-c13f-4a56-95ed-6d9651aa9f13
description: 'This page explains how ClickHouse server can be configured with configuration files in XML or YAML syntax.' sidebar_label: 'Configuration Files' sidebar_position: 50 slug: /operations/configuration-files title: 'Configuration Files' doc_type: 'guide' :::note XML-based settings profiles and configura...
{"source_file": "configuration-files.md"}
[ 0.05409931018948555, -0.06567448377609253, -0.03578456491231918, -0.019450047984719276, -0.07217279821634293, 0.015611979179084301, 0.031476736068725586, -0.009230316616594791, -0.07173151522874832, 0.00431528314948082, 0.07697012275457382, 0.01337048877030611, 0.0643104836344719, -0.06045...
f1b7c442-b5f9-441f-bbe9-1caf53a8980b
For example, given two configuration files: xml title="config.xml" <clickhouse> <config_a> <setting_1>1</setting_1> </config_a> <config_b> <setting_2>2</setting_2> </config_b> <config_c> <setting_3>3</setting_3> </config_c> </clickhouse> and xml title="config.d/othe...
{"source_file": "configuration-files.md"}
[ -0.00917763076722622, 0.00556735647842288, -0.019044524058699608, 0.0009304778650403023, -0.03066575899720192, -0.016821669414639473, 0.048806726932525635, 0.010692465119063854, -0.0745316669344902, -0.025651371106505394, 0.062446366995573044, -0.0035170982591807842, 0.10173055529594421, -...
e9c8dded-9212-42db-ad22-d102517f61fe
Substitution with file content {#substitution-with-file-content} It is also possible to replace parts of the configuration by file contents. This can be done in two ways: Substituting Values : If an element has the attribute incl , its value will be replaced by the content of the referenced file. By default, the...
{"source_file": "configuration-files.md"}
[ -0.004602164030075073, 0.06346576660871506, 0.03376534953713417, 0.025282997637987137, 0.06925934553146362, -0.04628567770123482, 0.024569127708673477, -0.013371605426073074, -0.027101408690214157, 0.013373884372413158, 0.03488976135849953, -0.05617738515138626, 0.05637189373373985, -0.015...
b0b0589d-0cbd-47fb-b807-d9bad7cce1ba
``` The attributes from_env and from_zk can also be applied to encryption_codecs : ```xml <encryption_codecs> <aes_128_gcm_siv> <key_hex from_env="CLICKHOUSE_KEY_HEX"/> </aes_128_gcm_siv> </encryption_codecs> <interserver_http_credentials> <user>admin</user> <password encrypted_by="...
{"source_file": "configuration-files.md"}
[ -0.08613049238920212, 0.05750017613172531, -0.12533175945281982, -0.03322957083582878, 0.02392101287841797, -0.03977988287806511, 0.048508889973163605, 0.026263311505317688, -0.023534610867500305, -0.017338061705231667, 0.03328143432736397, -0.048004891723394394, 0.08490792661905289, -0.03...
78fa95ec-9411-42c6-bcf5-c6c82ea0f22b
XML example {#example} For example, you can have a separate config file for each user like this: bash $ cat /etc/clickhouse-server/users.d/alice.xml xml <clickhouse> <users> <alice> <profile>analytics</profile> <networks> <ip>::/0</ip> </networks> ...
{"source_file": "configuration-files.md"}
[ 0.04944944009184837, -0.014221162535250187, -0.09087783098220825, -0.03204183280467987, -0.04628530517220497, -0.037595298141241074, 0.06962255388498306, 0.004565408919006586, -0.03464654088020325, -0.03453441709280014, 0.07247039675712585, -0.00895793829113245, 0.08158215135335922, -0.064...
1b9f0e53-3244-460a-8107-8e1da5e9de25
description: 'Guide to backing up and restoring ClickHouse databases and tables' sidebar_label: 'Backup and restore' sidebar_position: 10 slug: /operations/backup title: 'Backup and restore' doc_type: 'guide' Backup and restore Backup to a local disk Configuring backup/restore to use an S3 endpoint Backup/r...
{"source_file": "backup.md"}
[ -0.01337988581508398, -0.08407678455114365, -0.042037565261125565, 0.005367433652281761, 0.051217783242464066, 0.022695178166031837, 0.010043058544397354, -0.005184378009289503, -0.11214654892683029, 0.0015670236898586154, 0.04459120333194733, 0.011990109458565712, 0.13234606385231018, -0....
e432cf37-d34f-402e-b975-d9471e654af8
Backup to a local disk {#backup-to-a-local-disk} Configure a backup destination {#configure-a-backup-destination} In the examples below you will see the backup destination specified like Disk('backups', '1.zip') . To prepare the destination add a file to /etc/clickhouse-server/config.d/backup_disk.xml specifyin...
{"source_file": "backup.md"}
[ -0.03582439944148064, -0.027610672637820244, -0.08502928912639618, 0.027563564479351044, -0.0034443726763129234, -0.014143412001430988, -0.01842948980629444, -0.002200855640694499, -0.05021100118756294, 0.06701551377773285, 0.03774327039718628, 0.005076720379292965, 0.09401917457580566, -0...
901416ac-c7ab-42e3-94eb-2abfb158aa05
Usage examples {#usage-examples} Backup and then restore a table: sql BACKUP TABLE test.table TO Disk('backups', '1.zip') Corresponding restore: sql RESTORE TABLE test.table FROM Disk('backups', '1.zip') :::note The above RESTORE would fail if the table test.table contains data, you would have to drop the tab...
{"source_file": "backup.md"}
[ -0.037424348294734955, -0.03528448939323425, -0.02780969813466072, 0.059466537088155746, 0.012658683583140373, -0.0389929823577404, -0.0053146351128816605, -0.023361999541521072, -0.09252354502677917, 0.06165635958313942, 0.0362570583820343, 0.04913976043462753, 0.09779287129640579, -0.037...
c371fc94-00f0-421a-bb66-b33024d7503c
sql BACKUP TABLE test.table TO Disk('backups', '1.tar.gz') The supported compression file suffixes are tar.gz , .tgz tar.bz2 , tar.lzma , .tar.zst , .tzst and .tar.xz . Check the status of backups {#check-the-status-of-backups} The backup command returns an id and status , and that id can be used to...
{"source_file": "backup.md"}
[ -0.08535976707935333, 0.024416586384177208, -0.040312640368938446, 0.05177689343690872, 0.04621497541666031, -0.10605408251285553, 0.005404777824878693, 0.015937015414237976, -0.051431939005851746, 0.09419501572847366, -0.027835380285978317, 0.018592804670333862, 0.039478953927755356, -0.0...
dfea7c58-1929-450b-b480-de577956245b
2 rows in set. Elapsed: 0.075 sec. ``` Configuring BACKUP/RESTORE to use an S3 Endpoint {#configuring-backuprestore-to-use-an-s3-endpoint} To write backups to an S3 bucket you need three pieces of information: - S3 endpoint, for example https://mars-doc-test.s3.amazonaws.com/backup-S3/ - Access key ID, for ex...
{"source_file": "backup.md"}
[ -0.006376621779054403, -0.06244876608252525, -0.06573363393545151, -0.018466107547283173, -0.011824284680187702, 0.002231837948784232, 0.00998720433562994, -0.00031451330869458616, -0.016250312328338623, 0.09372087568044662, 0.0059277331456542015, -0.011316685006022453, 0.13060414791107178, ...