id
stringlengths
36
36
document
stringlengths
3
3k
metadata
stringlengths
23
69
embeddings
listlengths
384
384
c27023ad-0ab5-4c8e-906a-3bf85f91f1fd
Using several discrete yet overlapping data systems in a machine learning pipeline may introduce an unnecessary, and often costly, overhead of shipping data around from one to another. A great illustration of this tradeoff is the vector database. Vector databases are designed for the hyper-specific machine learning t...
{"source_file": "01_machine_learning.md"}
[ -0.013637298718094826, -0.06687142699956894, -0.0023670520167797804, 0.015007670037448406, 0.021364668384194374, -0.02686675265431404, -0.060998715460300446, -0.03796939179301262, -0.0504889078438282, -0.03468446061015129, -0.07957156747579575, 0.006634314078837633, 0.02540505677461624, 0....
6269d079-317c-4d5e-a7ac-e074d0c7f2e1
ClickHouse also has an extensive suite of pre-built statistical and aggregation functions that scale over petabytes of data, making it easy to write and maintain simple SQL that executes complex computations. With support for the most granular precision data types and codecs, you don't need to worry about reducing the ...
{"source_file": "01_machine_learning.md"}
[ -0.044019218534231186, -0.024549057707190514, 0.0008167890482582152, 0.02201198972761631, -0.058428555727005005, -0.11231739073991776, -0.028611496090888977, -0.000189643120393157, -0.05656491219997406, -0.030073843896389008, -0.024741280823946, 0.0011103433789685369, 0.03503956273198128, ...
59a015fb-7857-46e5-bea7-9dfee557c593
At this point, features will have been split into training, validation, and test sets. These data sets are versioned, and then utilized by their respective stages. It is common in this phase of the pipeline to introduce yet another specialized tool to the machine learning data layer - the feature store. A feature sto...
{"source_file": "01_machine_learning.md"}
[ -0.056912198662757874, -0.00011906771396752447, -0.026118364185094833, 0.06803859770298004, 0.0183323435485363, -0.0009375234949402511, 0.0023814705200493336, -0.01438484899699688, -0.07090345025062561, 0.01716511882841587, 0.013293731026351452, 0.008275188505649567, 0.01796361245214939, -...
0950d781-65ee-4efd-864f-2cd914a9e22c
With capabilities to read data from multiple sources and apply transformations via SQL queries, the results of these queries can also be persisted in ClickHouse via INSERT INTO SELECT statements. With transformations often grouped by an entity ID and returning a number of columns as results, ClickHouse’s schema infer...
{"source_file": "01_machine_learning.md"}
[ -0.041846733540296555, -0.007871013134717941, -0.008379541337490082, 0.06712929904460907, 0.04454904794692993, -0.024550389498472214, 0.024649541825056076, -0.057128772139549255, -0.013089009560644627, -0.06031478941440582, -0.049052320420742035, -0.015597782097756863, -0.021596945822238922,...
1aa668ac-101a-4700-96a5-a4542409678a
Many modern systems require both offline and online stores, and it is easy to jump to the conclusion that two specialized feature stores are required here. However, this introduces the additional complexity of keeping both of these stores in sync, which of course also includes the cost of replicating data between them....
{"source_file": "01_machine_learning.md"}
[ -0.04446566477417946, -0.04461483284831047, -0.05615945905447006, 0.08714223653078079, 0.04255688562989235, -0.013204825110733509, -0.07008913159370422, 0.0010087545961141586, -0.018613703548908234, -0.006092760246247053, 0.02581171691417694, 0.014859567396342754, 0.037942852824926376, -0....
891b15c8-8cc9-4ea4-9161-0388dd451010
The issue with this new class of tools is that many general-purpose databases, including ClickHouse, provide vector support out-of-the-box, and also often have implementations of those approximate approaches built-in. ClickHouse, in particular, is designed for high-performance large-scale analytics - allowing you to pe...
{"source_file": "01_machine_learning.md"}
[ -0.06506728380918503, -0.02828143909573555, -0.03737080097198486, 0.07742936164140701, 0.0447830930352211, -0.10350459814071655, -0.027988407760858536, -0.04149951785802841, -0.10674278438091278, 0.004140464123338461, -0.059950634837150574, 0.03924797847867012, 0.019825078547000885, -0.010...
38ca7e58-d36f-46aa-ae5b-253af6a72da2
slug: /cloud/get-started/cloud/use-cases/AI_ML/agent_facing_analytics title: 'Agent facing analytics' description: 'Build agent-facing analytics systems with ClickHouse Cloud for AI agents and autonomous systems requiring real-time data access' keywords: ['use cases', 'Machine Learning', 'Generative AI', 'agent facing ...
{"source_file": "02_agent_facing_analytics.md"}
[ -0.03526052460074425, 0.008023706264793873, -0.09000753611326218, 0.05140344426035881, 0.0945749282836914, -0.04322637617588043, 0.07923722267150879, 0.0004189193423371762, -0.057516466826200485, 0.03772798553109169, 0.06499025970697403, -0.045759622007608414, 0.0972723513841629, -0.001327...
24e6a0b2-f2de-4bfa-a1a0-df937efe2ee2
Tools can also be used to simplify the implementation of Retrieval-Augmented Generation (RAG) pipelines. Instead of relying only on what an AI model learned during training, RAG lets the model pull in relevant information before formulating a response. Here's an example: Using an AI assistant to help with customer supp...
{"source_file": "02_agent_facing_analytics.md"}
[ -0.09904567152261734, -0.016779938712716103, 0.0019094239687547088, 0.03944588080048561, 0.03521839529275894, 0.014533496461808681, -0.018365591764450073, 0.08796299993991852, 0.05982838571071625, -0.015676889568567276, -0.03428742289543152, 0.03031996823847294, 0.03464934974908829, -0.004...
385a6158-3c72-4024-abcf-8bcbc44f53a0
Some properties make real-time databases especially suitable for such workloads. For example, real-time analytics databases are designed to work with near real-time data, allowing them to process and deliver insights almost immediately as new data arrives. This is crucial for AI agents, as they can require up-to-date i...
{"source_file": "02_agent_facing_analytics.md"}
[ -0.05495226010680199, -0.031331516802310944, -0.07413146644830704, 0.08102239668369293, 0.003571628127247095, -0.04442596808075905, 0.036697808653116226, -0.01083613745868206, 0.010257961228489876, -0.009633672423660755, -0.05234817788004875, -0.01380749698728323, 0.019915906712412834, 0.0...
3417854c-91f7-4f96-9c12-540f5a14268a
Over the years, real-time databases have had the time to adapt to human interactive users, directly connected to the system or via a middleware application layer. Classic personas examples include database administrators, business analysts, data scientists, or software developers building applications on top of the ...
{"source_file": "02_agent_facing_analytics.md"}
[ -0.041545264422893524, -0.0871778056025505, -0.016954971477389336, 0.02760135568678379, -0.02003241889178753, -0.00787471141666174, 0.02044145204126835, 0.016269268468022346, -0.07753220945596695, -0.028079291805624962, -0.1017155647277832, -0.016344474628567696, -0.0021811884362250566, 0....
e770267a-2292-43e3-8763-6bb9d5211f71
slug: /cloud/guides/data-masking sidebar_label: 'Data masking' title: 'Data masking in ClickHouse' description: 'A guide to data masking in ClickHouse' keywords: ['data masking'] doc_type: 'guide' Data masking in ClickHouse Data masking is a technique used for data protection, in which the original data is replac...
{"source_file": "03_data-masking.md"}
[ -0.0459730327129364, 0.11419463902711868, 0.05046756565570831, 0.04455622658133507, 0.02799900248646736, -0.053531501442193985, 0.02387356013059616, -0.07560735195875168, 0.0039796121418476105, -0.012795478105545044, 0.044533055275678635, 0.008734175004065037, 0.08405355364084244, -0.09781...
9100288e-9609-480c-8ef7-567f9c8faef9
Or you could mask a social security number, leaving only the last 4 digits using the replaceRegexpAll function. sql title="Query" SELECT replaceRegexpAll( 'SSN: 123-45-6789', '(\d{3})-(\d{2})-(\d{4})', 'XXX-XX-\3' ) AS masked_ssn; In the query above \3 is used to substitute the third capture group i...
{"source_file": "03_data-masking.md"}
[ -0.09056103974580765, 0.06478957831859589, -0.03543134406208992, 0.04421896114945412, -0.08933409303426743, 0.059145115315914154, 0.07835406810045242, -0.09638851881027222, 0.03500455245375633, -0.08741088211536407, 0.02617621049284935, -0.01820114441215992, 0.10337936133146286, -0.0688757...
0e638caf-91ee-43da-83ad-f55c9c0382cc
Select the data from the view: sql title="Query" SELECT * FROM masked_orders response title="Response" ┌─user_id─┬─name─────────┬─email──────────────┬─phone────────┬─total_amount─┬─order_date─┬─shipping_address──────────┐ │ 1001 │ John **** │ jo****@gmail.com │ 555-***-4567 │ 299.99 │ 2024-01-15 │ ***...
{"source_file": "03_data-masking.md"}
[ 0.003862421726807952, -0.03186384215950966, 0.0714469701051712, 0.10002386569976807, -0.030992621555924416, -0.03741604834794998, 0.04618270322680473, -0.12683290243148804, 0.06323862075805664, -0.013803011737763882, 0.06382225453853607, -0.07647483050823212, 0.0034580836072564125, -0.0630...
58a1815a-c7d4-4abb-80fc-ef7153f5b928
Taking the example before, instead of creating a separate VIEW for the masked data, we'll now create masked columns using MATERIALIZED : ```sql DROP TABLE IF EXISTS orders; CREATE TABLE orders ( user_id UInt32, name String, name_masked String MATERIALIZED replaceRegexpOne(name, '^([A-Za-z]+)\s+(. )$', ...
{"source_file": "03_data-masking.md"}
[ -0.04767750948667526, 0.019604679197072983, 0.06888362020254135, 0.02631344459950924, -0.08363726735115051, -0.04923532158136368, 0.028335291892290115, -0.06501641124486923, -0.0067492215894162655, 0.006786898709833622, 0.037196721881628036, -0.11500703543424606, 0.0318077988922596, -0.084...
c43ad6b5-dd43-4bf4-9cbd-e9280295c019
sql title="Query" SELECT *, name_masked, email_masked, phone_masked, shipping_address_masked FROM orders ORDER BY user_id ASC response title="Response" ┌─user_id─┬─name──────────┬─email─────────────────────┬─phone────────┬─total_amount─┬─order_date─┬─shipping_address───────────────────┬─name_ma...
{"source_file": "03_data-masking.md"}
[ -0.03414351865649223, -0.05003258213400841, 0.09256611764431, 0.08861088752746582, -0.06695172935724258, -0.06396947056055069, 0.056644126772880554, -0.09951498359441757, 0.027283821254968643, -0.0031433040276169777, 0.062716044485569, -0.07982324063777924, 0.04099229350686073, -0.08829066...
f579445a-83e0-4504-98c7-6d9d32d9efd5
```sql DROP TABLE IF EXISTS orders; CREATE TABLE orders ( user_id UInt32, name String EPHEMERAL, name_masked String MATERIALIZED replaceRegexpOne(name, '^([A-Za-z]+)\s+(. )$', '\1 '), email String EPHEMERAL, email_masked String MATERIALIZED replaceRegexpOne(email, '^(.{2})[^@] (@.*)$', '\1 \2'), ...
{"source_file": "03_data-masking.md"}
[ -0.002549362601712346, 0.07144150137901306, 0.09985502809286118, -0.01947708986699581, -0.10497716069221497, -0.028474021703004837, 0.06391264498233795, 0.004367843270301819, -0.021709691733121872, 0.06885833293199539, 0.05375799536705017, -0.08963170647621155, 0.06440751999616623, -0.1333...
9a6658e1-f892-40e3-b01e-41f1beeb2971
For users of ClickHouse OSS wishing to mask log data specifically, you can make use of query masking rules (log masking) to mask data. To do so, you can define regular expression-based masking rules in the server configuration. These rules are applied to queries and all log messages before they are stored in server...
{"source_file": "03_data-masking.md"}
[ -0.007379018701612949, 0.07565329223871231, -0.024990199133753777, 0.02889268286526203, -0.0156975369900465, -0.04133191704750061, 0.08356190472841263, -0.10272891819477081, 0.031776368618011475, -0.027123423293232918, 0.010869933292269707, -0.009264699183404446, 0.09047672897577286, -0.02...
e66918fc-cdb4-4d0e-aac4-02465eb471da
sidebar_label: 'Data encryption' slug: /cloud/security/cmek title: 'Data encryption' description: 'Learn more about data encryption in ClickHouse Cloud' doc_type: 'guide' keywords: ['ClickHouse Cloud', 'encryption', 'CMEK', 'KMS key poller'] import Image from '@theme/IdealImage'; import EnterprisePlanFeatureBadge f...
{"source_file": "04_cmek.md"}
[ -0.04345319792628288, 0.03330978751182556, -0.0488436184823513, 0.002327089197933674, 0.03077569790184498, 0.033954448997974396, 0.0772729441523552, -0.021778743714094162, 0.055563051253557205, 0.05675893649458885, 0.0010776214767247438, 0.017485637217760086, 0.042040709406137466, -0.05976...
532571b1-88d2-4777-b78f-540e1abc5855
Enable CMEK with AWS KMS 1. In ClickHouse Cloud, select the encrypted service 2. Click on the Settings on the left 3. At the bottom of the screen, expand the Network security information 4. Copy the Encryption role ID (AWS) or Encryption Service Account (GCP) - you will need this in a future step 5. [Create a KMS key...
{"source_file": "04_cmek.md"}
[ -0.01628800295293331, 0.029680470004677773, -0.016275320202112198, -0.006478568073362112, -0.0007003158680163324, 0.05708835646510124, 0.019497385248541832, -0.04524753987789154, 0.04288569837808609, 0.0940602496266365, -0.051628053188323975, -0.06427166610956192, 0.04934967681765556, -0.0...
608e8b5e-0a71-426a-9cf7-b917a6aa9716
Performance {#performance} Database encryption leverages ClickHouse's built-in Virtual File System for Data Encryption feature to encrypt and protect your data. The algorithm in use for this feature is AES_256_CTR , which is expected to have a performance penalty of 5-15% depending on the workload:
{"source_file": "04_cmek.md"}
[ -0.004491785075515509, 0.029935386031866074, -0.10488074272871017, 0.008164571598172188, 0.003810381516814232, -0.08766146749258041, 0.022302798926830292, -0.02355263940989971, 0.04105547070503235, 0.013818777166306973, -0.05546645075082779, 0.058481547981500626, 0.03622500225901604, -0.04...
decfa702-8e2b-4431-bf86-ec3c11e15655
slug: /cloud/guides/data-sources title: 'Data sources' hide_title: true description: 'Table of contents page for the ClickHouse Cloud guides section' doc_type: 'landing-page' keywords: ['cloud guides', 'documentation', 'how-to', 'cloud features', 'tutorials'] Cloud integrations {#cloud-integrations} This section ...
{"source_file": "index.md"}
[ -0.020096778869628906, -0.03129227086901665, 0.010865537449717522, 0.017413128167390823, 0.05779934674501419, -0.005979358218610287, 0.0003485368797555566, -0.06439533829689026, 0.009182633832097054, 0.013341869227588177, 0.021119561046361923, 0.011032945476472378, 0.05399994179606438, -0....
c6d676e4-ea73-4ee7-af26-b5f75e1e9735
slug: /manage/data-sources/cloud-endpoints-api sidebar_label: 'Cloud IP addresses' title: 'Cloud IP addresses' description: 'This page documents the Cloud Endpoints API security features within ClickHouse. It details how to secure your ClickHouse deployments by managing access through authentication and authorization m...
{"source_file": "01_cloud-endpoints-api.md"}
[ 0.02593284659087658, 0.04032788798213005, -0.023764388635754585, -0.027773117646574974, 0.0013605720596387982, -0.020968765020370483, 0.05124550685286522, -0.049528393894433975, -0.041182126849889755, 0.07349581271409988, 0.05324952304363251, -0.04237860441207886, 0.0989425778388977, -0.02...
2a8f19b4-e20a-4c62-9751-a72063251cda
slug: /cloud/data-sources/secure-s3 sidebar_label: 'Accessing S3 data securely' title: 'Accessing S3 data securely' description: 'This article demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service(S3) and access their data securely.' keywords: ['RB...
{"source_file": "02_accessing-s3-data-securely.md"}
[ -0.05214160308241844, 0.05038296803832054, -0.09709127247333527, -0.034530021250247955, 0.048238180577754974, -0.005634882487356663, 0.08047907054424286, -0.022612934932112694, 0.021381450816988945, -0.005325921345502138, 0.039942845702171326, 0.05436628311872482, 0.14058397710323334, -0.0...
9990ec07-0823-4d8b-bdf0-da23b8f18df6
3 - Enter (or paste) the IAM Role belong to the ClickHouse service 4 - Configure the CloudFormation stack. Below is additional information about these parameters. | Parameter | Default Value | Description ...
{"source_file": "02_accessing-s3-data-securely.md"}
[ -0.034498266875743866, -0.0712476298213005, -0.04020809009671211, -0.025053532794117928, -0.016661813482642174, 0.04301773011684418, 0.062321972101926804, -0.08148735016584396, 0.015627950429916382, 0.03515714034438133, -0.019698023796081543, -0.11249597370624542, 0.0864928662776947, -0.04...
6d13eb2b-283b-4d0e-9bd9-ed060e988044
4 - Copy the new IAM Role Arn after creation. This is what needed to access your S3 bucket. Access your S3 bucket with the ClickHouseAccess role {#access-your-s3-bucket-with-the-clickhouseaccess-role} ClickHouse Cloud has a new feature that allows you to specify extra_credentials as part of the S3 table functio...
{"source_file": "02_accessing-s3-data-securely.md"}
[ -0.006669558584690094, -0.0403919517993927, -0.08631214499473572, 0.0038567695301026106, -0.044901568442583084, 0.008989470079541206, 0.0593610480427742, -0.04118446633219719, 0.028438745066523552, 0.01730727031826973, -0.003549314336851239, -0.12330256402492523, 0.10812026262283325, -0.06...
8ca794bd-d99d-4e05-91d2-3ae03c6fff8e
sidebar_title: 'Query API Endpoints' slug: /cloud/get-started/query-endpoints description: 'Easily spin up REST API endpoints from your saved queries' keywords: ['api', 'query api endpoints', 'query endpoints', 'query rest api'] title: 'Query API Endpoints' doc_type: 'guide' import Image from '@theme/IdealImage'; i...
{"source_file": "query-endpoints.md"}
[ 0.006284186150878668, 0.021498695015907288, -0.044799238443374634, 0.054957471787929535, -0.018533140420913696, 0.04234239459037781, -0.016366997733712196, 0.025493303313851357, -0.031333405524492264, 0.05232692137360573, 0.014535052701830864, -0.024433961138129234, 0.09649074822664261, -0...
4f15c16a-0fa6-4808-8cb8-077eb02193be
Note that this query contains a parameter ( year ) which is highlighted in the snippet above. You can specify query parameters using curly brackets { } together with the type of the parameter. The SQL console query editor automatically detects ClickHouse query parameter expressions and provides an input for each par...
{"source_file": "query-endpoints.md"}
[ 0.03229360654950142, -0.03436514735221863, -0.043622784316539764, 0.07454308867454529, -0.0882570892572403, 0.1195400059223175, -0.07288355380296707, -0.005351439118385315, -0.057336609810590744, 0.02008960396051407, -0.06896860152482986, -0.10184437781572342, 0.02968515083193779, 0.015240...
36a84d54-2ac9-4502-ae81-2875c940f29f
When to use GET: - Simple queries without complex nested data - Parameters can be easily URL-encoded - Caching benefits from HTTP GET semantics When to use POST: - Complex query variables (arrays, objects, large strings) - When request body is preferred for security/privacy - Streaming file uploads or large data ...
{"source_file": "query-endpoints.md"}
[ -0.08279699087142944, 0.09777531027793884, -0.04240710660815239, 0.06949527561664581, -0.08616835623979568, -0.052780285477638245, -0.03412371873855591, 0.0034008342772722244, 0.02413591369986534, -0.03303665295243263, -0.007509149610996246, -0.050003666430711746, 0.04514017328619957, -0.0...
1975c32f-bc88-4cb6-9232-80e4a265e44b
Error handling best practices {#error-handling-best-practices} Ensure valid authentication credentials are included in the request Validate the queryEndpointId and queryVariables before sending Implement graceful error handling with appropriate error messages Upgrading endpoint versions {#upgrading-en...
{"source_file": "query-endpoints.md"}
[ 0.02004649117588997, 0.016095519065856934, -0.009150268509984016, -0.007277120836079121, -0.02275158278644085, -0.044555407017469406, -0.04135995730757713, 0.00017205937183462083, -0.041219327598810196, 0.03983169421553612, -0.022430820390582085, -0.04400467872619629, 0.0854479968547821, -...
952ee9a1-b758-41b7-92bf-ba5b1de818d8
javascript fetch( "https://console-api.clickhouse.cloud/.api/query-endpoints/<endpoint id>/run?format=JSONEachRow", { method: "POST", headers: { Authorization: "Basic <base64_encoded_credentials>", "Content-Type": "application/json", "x-clickhouse-endpoint-version": "2", }, } ) .th...
{"source_file": "query-endpoints.md"}
[ 0.01923130825161934, -0.009209997020661831, -0.013832297176122665, 0.017429690808057785, -0.035054828971624374, -0.023329665884375572, -0.06449012458324432, 0.022477800026535988, 0.02494545839726925, -0.03596743196249008, 0.026843378320336342, -0.03171635419130325, 0.015346975065767765, 0....
91b08424-da68-42f6-b9a2-f134daa5f7df
Query API Endpoint SQL: sql INSERT INTO default.t_arr VALUES ({arr: Array(Array(Array(UInt32)))}); bash curl -X POST 'https://console-api.clickhouse.cloud/.api/query-endpoints/<endpoint id>/run' \ --user '<openApiKeyId:openApiKeySecret>' \ -H 'Content-Type: application/json' \ -H 'x-clickhouse-endpoint-version:...
{"source_file": "query-endpoints.md"}
[ 0.03180376812815666, 0.02230830118060112, -0.08513205498456955, -0.00024483934976160526, -0.07827236503362656, -0.039824869483709335, 0.002920052269473672, -0.0038135636132210493, 0.05400474742054939, -0.004071357659995556, 0.004736233968287706, -0.025556735694408417, 0.04254131019115448, ...
2c36aaab-3622-4895-a0e5-0df4cb3c7b6f
const reader = response.body as unknown as Readable; reader.on("data", (chunk) => { console.log(chunk.toString()); }); reader.on("end", () => { console.log("Stream ended."); }); reader.on("error", (err) => { console.error("Stream error:", err); }); } const endpointUrl = "https://console-api....
{"source_file": "query-endpoints.md"}
[ -0.0011311538983136415, 0.049642328172922134, -0.016073696315288544, 0.03166717290878296, 0.00516989640891552, -0.02316313609480858, -0.03524111211299896, 0.05421364679932594, 0.05661533400416374, 0.01660301350057125, -0.05875357240438461, 0.0160137377679348, -0.022234704345464706, 0.02031...
9e19f1ce-2768-4d87-abee-89e79bdd3b3f
slug: /cloud/guides/sql-console/gather-connection-details sidebar_label: 'Gather your connection details' title: 'Gather your connection details' description: 'Gather your connection details' doc_type: 'guide' keywords: ['connection details', 'credentials', 'connection string', 'setup', 'configuration'] import Conn...
{"source_file": "connection_details.md"}
[ 0.025101343169808388, -0.0373239628970623, -0.08596492558717728, 0.00243061943911016, -0.06392689794301987, -0.006226543337106705, 0.021578149870038033, -0.027338067069649696, -0.024123726412653923, 0.04372687637805939, -0.023115720599889755, -0.012896541506052017, 0.05535836145281792, -0....
06f3335a-41de-4d3a-aaca-e814d05b0d0a
slug: /cloud/bestpractices/usage-limits sidebar_label: 'Service limits' title: 'Usage limits' description: 'Describes the recommended usage limits in ClickHouse Cloud' doc_type: 'reference' keywords: ['usage limits', 'quotas', 'best practices', 'resource management', 'cloud features'] While ClickHouse is known for ...
{"source_file": "usagelimits.md"}
[ -0.010466460138559341, -0.0018443510634824634, 0.007066564634442329, -0.04832593351602554, 0.00242138234898448, -0.040094561874866486, 0.027754900977015495, 0.0002723856014199555, -0.04000137001276016, 0.02907821536064148, 0.025388095527887344, 0.040783826261758804, 0.046865444630384445, -...
21368494-3706-413c-b7d0-33e886c63e8e
slug: /cloud/bestpractices/multi-tenancy sidebar_label: 'Multi tenancy' title: 'Multi tenancy' description: 'Best practices to implement multi tenancy' doc_type: 'guide' keywords: ['multitenancy', 'isolation', 'best practices', 'architecture', 'multi-tenant'] On a SaaS data analytics platform, it is common for mult...
{"source_file": "multitenancy.md"}
[ 0.04285800829529762, -0.04829035699367523, -0.061262525618076324, 0.008449695073068142, -0.041612688452005386, -0.008893021382391453, -0.013523638248443604, -0.061017680913209915, -0.016203587874770164, 0.0358256958425045, 0.06146702170372009, -0.006863573100417852, 0.10495663434267044, 0....
8f717d8b-e1db-4f16-a18e-f71cf6cead2d
Let's insert fake data. sql -- Insert some dummy rows INSERT INTO events (tenant_id, id, type, timestamp, user_id, data) VALUES (1, '7b7e0439-99d0-4590-a4f7-1cfea1e192d1', 'user_login', '2025-03-19 08:00:00', 1001, '{"device": "desktop", "location": "LA"}'), (1, '846aa71f-f631-47b4-8429-ee8af87b4182', 'purchase', '20...
{"source_file": "multitenancy.md"}
[ -0.0011032653274014592, 0.07600067555904388, -0.013857352547347546, 0.023227015510201454, -0.0902038961648941, -0.028122566640377045, 0.07653047889471054, -0.04026348143815994, 0.06388697028160095, 0.00354396621696651, 0.08883975446224213, -0.06137224659323692, 0.01886039599776268, 0.02545...
6aa9bfff-1a92-415f-bf13-0cfe394f7b84
Now you can connect as user_1 and run a simple select. Only rows from the first tenant are returned. ```sql -- Logged as user_1 SELECT * FROM events ┌─tenant_id─┬─id───────────────────────────────────┬─type────────┬───────────timestamp─┬─user_id─┬─data────────────────────────────────────┐ 1. │ 1 │ 7b7e04...
{"source_file": "multitenancy.md"}
[ 0.01779751107096672, -0.025526732206344604, -0.01371307484805584, 0.010442349128425121, -0.1175772026181221, -0.019491814076900482, 0.0959727093577385, -0.028096714988350868, 0.028906330466270447, 0.005661866627633572, 0.06604178249835968, -0.061650972813367844, -0.014416541904211044, -0.0...
7e0221f6-7e3d-46fb-8684-093ed84d92dd
-- Create table for tenant 2 CREATE TABLE events_tenant_2 ( id UUID, -- Unique event ID type LowCardinality(String), -- Type of event timestamp DateTime, -- Timestamp of the event user_id UInt32, -- ID of the user who triggered the event data String, ...
{"source_file": "multitenancy.md"}
[ 0.06718207895755768, 0.04701567813754082, -0.020574677735567093, 0.022831207141280174, -0.09615873545408249, -0.037182923406362534, 0.06546232104301453, -0.00756363570690155, 0.040388599038124084, 0.030881933867931366, 0.10628586262464523, -0.0907466784119606, 0.0232401080429554, 0.0183823...
567f9ce0-2841-472e-9f43-8738a88932fb
```sql -- Logged as user_1 SELECT * FROM default.events_tenant_1 ┌─id───────────────────────────────────┬─type────────┬───────────timestamp─┬─user_id─┬─data────────────────────────────────────┐ 1. │ 7b7e0439-99d0-4590-a4f7-1cfea1e192d1 │ user_login │ 2025-03-19 08:00:00 │ 1001 │ {"device": "desktop", "location": ...
{"source_file": "multitenancy.md"}
[ 0.019323309883475304, 0.010497205890715122, 0.0334794782102108, -0.001629079575650394, -0.053299110382795334, -0.0019476443994790316, 0.14016634225845337, -0.03053717315196991, 0.05974006652832031, 0.05060310661792755, 0.09643474221229553, -0.09769371151924133, -0.007110057398676872, 0.000...
48b2751a-c710-4d93-8f6b-73da4009555f
Let's insert fake data. ```sql INSERT INTO tenant_1.events (id, type, timestamp, user_id, data) VALUES ('7b7e0439-99d0-4590-a4f7-1cfea1e192d1', 'user_login', '2025-03-19 08:00:00', 1001, '{"device": "desktop", "location": "LA"}'), ('846aa71f-f631-47b4-8429-ee8af87b4182', 'purchase', '2025-03-19 08:05:00', 1002, '{"it...
{"source_file": "multitenancy.md"}
[ -0.009669000282883644, 0.07994507253170013, -0.0066756331361830235, 0.03309870511293411, -0.08260377496480942, -0.03553008660674095, 0.07042019069194794, -0.022218825295567513, 0.05485711991786957, 0.009470481425523758, 0.057829201221466064, -0.050831764936447144, 0.011012312024831772, 0.0...
5270ed44-5451-4378-81ee-72cf08e0ade0
Compute-compute separation {#compute-compute-separation} The three approaches described above can also be further isolated by using Warehouses . Data is shared through a common object storage but each tenant can have its own compute service thanks to compute-compute separation with different CPU/Memory ratio. U...
{"source_file": "multitenancy.md"}
[ -0.009555158205330372, -0.010403672233223915, -0.057363882660865784, -0.03926601633429527, -0.07733649760484695, -0.03526918962597847, 0.010524366050958633, -0.08058842271566391, 0.0366307869553566, 0.06721534579992294, 0.03753429651260376, -0.060683537274599075, 0.07190226763486862, 0.042...
255fae06-13eb-4413-8f24-9a037d623f8b
Now you can connect as user_1 on the service for tenant 1 and run a simple select. Only rows from the first tenant are returned. ```sql -- Logged as user_1 SELECT * FROM events ┌─id───────────────────────────────────┬─type────────┬───────────timestamp─┬─user_id─┬─data────────────────────────────────────┐ 1. │ 7b...
{"source_file": "multitenancy.md"}
[ 0.000876881938893348, -0.04857439547777176, -0.023233752697706223, -0.00805917289108038, -0.11275541037321091, -0.013077044859528542, 0.1029898002743721, -0.03627563267946243, 0.03515240550041199, 0.017379703000187874, 0.06595486402511597, -0.05516061931848526, 0.005997045896947384, 0.0197...
851102df-c496-480b-901c-b43482e0eed5
slug: /cloud/bestpractices keywords: ['Cloud', 'Best Practices', 'Bulk Inserts', 'Asynchronous Inserts', 'Avoid Mutations', 'Avoid Nullable Columns', 'Avoid Optimize Final', 'Low Cardinality Partitioning Key', 'Multi Tenancy', 'Usage Limits'] title: 'Overview' hide_title: true description: 'Landing page for Best Practi...
{"source_file": "index.md"}
[ 0.008490200154483318, -0.008044284768402576, -0.028029872104525566, 0.027110373601317406, 0.06190729886293411, -0.002131069079041481, -0.0288737490773201, -0.02013544924557209, -0.030106298625469208, 0.11064466089010239, 0.05512893199920654, -0.0015581664629280567, 0.09845857322216034, -0....
744150c7-b199-45a4-ab3a-87710ab16ec9
sidebar_label: 'Review and restore backups' sidebar_position: 0 slug: /cloud/manage/backups/overview title: 'Overview' keywords: ['backups', 'cloud backups', 'restore'] description: 'Provides an overview of backups in ClickHouse Cloud' doc_type: 'guide' import CloudNotSupportedBadge from '@theme/badges/CloudNotSupp...
{"source_file": "01_review-and-restore-backups.md"}
[ -0.058158740401268005, 0.05718250200152397, -0.007538944948464632, 0.06894510239362717, 0.06466790288686752, 0.025398874655365944, 0.016496211290359497, 0.007160583510994911, -0.027878211811184883, 0.05079401656985283, 0.045305509120225906, 0.015383233316242695, 0.10297787934541702, -0.077...
dfda51ea-8f66-4ebb-acf7-96e9cc52abbc
The new service will show in the services list as Provisioning until it is ready: Working with your restored service {#working-with-your-restored-service} After a backup has been restored, you will now have two similar services: the original service that needed to be restored, and a new restored service tha...
{"source_file": "01_review-and-restore-backups.md"}
[ -0.10590425133705139, -0.06995385885238647, 0.037752676755189896, -0.0520794652402401, -0.0004007259267382324, -0.030217690393328667, -0.009741728194057941, -0.12308498471975327, -0.0829678550362587, 0.024085933342576027, 0.03432413935661316, 0.07312965393066406, 0.0523441918194294, -0.029...
33399390-3f44-40fd-b89f-e83a17d95e09
sql CREATE TABLE db.table ... ENGINE = ReplicatedMergeTree ORDER BY ... Use the remoteSecure function to pull the data from the newly restored ClickHouse Cloud service into your original service: sql INSERT INTO db.table SELECT * FROM remoteSecure('source-hostname', db, table, 'exporter', 'password-he...
{"source_file": "01_review-and-restore-backups.md"}
[ -0.05160381272435188, -0.09355770796537399, 0.012851415202021599, 0.03988218307495117, -0.002782651921734214, -0.03905881568789482, 0.01986626908183098, -0.09946584701538086, -0.03027796745300293, 0.09620870649814606, 0.07507901638746262, 0.008763873018324375, 0.12092287093400955, -0.05642...
df6dfbb6-e0d0-41a1-8c30-4b64f0501a45
sidebar_label: 'Configure backup schedules' slug: /cloud/manage/backups/configurable-backups description: 'Guide showing how to configure backups' title: 'Configure backup schedules' keywords: ['backups', 'cloud backups', 'restore'] doc_type: 'guide' import backup_settings from '@site/static/images/cloud/manage/bac...
{"source_file": "02_configurable-backups.md"}
[ -0.07883868366479874, 0.018809432163834572, -0.008721908554434776, 0.07211989909410477, -0.010445253923535347, 0.05071341246366501, -0.03931225836277008, 0.005953730549663305, -0.021131323650479317, 0.017423070967197418, -0.012668713927268982, 0.017652714625000954, 0.09738899022340775, -0....
5e031da1-40eb-4888-a1d8-b571721ba13b
slug: /cloud/manage/backups title: 'Backups' description: 'Table of contents page for backups.' keywords: ['backups', 'configurable backups', 'export backups to own cloud'] doc_type: 'landing-page' | Page | Descript...
{"source_file": "index.md"}
[ -0.010456383228302002, 0.01999548450112343, 0.020363733172416687, 0.035471826791763306, 0.048506688326597214, 0.004558729939162731, -0.024354835972189903, -0.021943850442767143, 0.02716423012316227, 0.033150214701890945, -0.013284770771861076, -0.034269582480192184, 0.07947501540184021, -0...
a4cca036-9039-4ae0-8620-9ca20b3aa50d
sidebar_label: 'SAML SSO setup' slug: /cloud/security/saml-setup title: 'SAML SSO setup' description: 'How to set up SAML SSO with ClickHouse Cloud' doc_type: 'guide' keywords: ['ClickHouse Cloud', 'SAML', 'SSO', 'single sign-on', 'IdP', 'Okta', 'Google'] import Image from '@theme/IdealImage'; import samlOrgId from...
{"source_file": "04_saml-sso-setup.md"}
[ -0.06212345138192177, 0.004348136950284243, -0.07734030485153198, 0.02244795672595501, -0.013553343713283539, 0.016600126400589943, 0.09132120013237, -0.05007796362042427, 0.01319293025881052, 0.02475564554333687, 0.06630048155784607, 0.012754732742905617, 0.11539364606142044, 0.0604056604...
d0e218b4-0a7f-4da7-b15b-008002089a0f
- Application username: `email` - Attribute mapping: `email = user.email` - Direct link to access your organization: `https://console.clickhouse.cloud/?connection={organizationid}` For specific configuration steps, refer to your specific identity provider below. Obtain your connection information ...
{"source_file": "04_saml-sso-setup.md"}
[ -0.012749586254358292, -0.033738020807504654, -0.039273813366889954, -0.010725414380431175, -0.005505654029548168, 0.015285312198102474, 0.03368094190955162, -0.04875198379158974, 0.03316685929894447, 0.008558094501495361, 0.0036071434151381254, -0.03974991291761398, 0.06459998339414597, 0...
483a95e8-865c-4efa-978b-931fb7bf472c
7. Click **Assign people** to assign users you would like to have access to this ClickHouse organization. 2. Create a bookmark app to enable users to seamlessly log in 1. Select **Applications** on the left, then select the **Applications** subheading. 2. Click **Browse App Catalog**. 3. Search f...
{"source_file": "04_saml-sso-setup.md"}
[ -0.05951347202062607, -0.08084474503993988, -0.10462098568677902, 0.06190751865506172, -0.059784628450870514, 0.04988484084606171, 0.033280592411756516, -0.07726757228374481, 0.012933339923620224, 0.03781875967979431, 0.00283300643786788, -0.038648054003715515, 0.060317181050777435, 0.0037...
3ade2fd2-32ab-4c37-8d52-ac305fa216d5
3. Click **Add app** from the top menu, then select **Add custom SAML app**. 4. Enter a name for the app and click **Continue**. 5. Gather these two items and go to Submit a Support Case above to submit the information to us. NOTE: If you complete the setup before copying this data, click **DOWNLOAD METADATA** ...
{"source_file": "04_saml-sso-setup.md"}
[ -0.07467021048069, 0.01060586329549551, -0.08989802747964859, 0.0028490941040217876, 0.0027603257913142443, 0.020705897361040115, -0.020168961957097054, -0.023381585255265236, 0.025845222175121307, 0.054862868040800095, 0.018839212134480476, -0.10270290076732635, 0.06492619961500168, 0.031...
2d27bbc2-ddd1-49c0-b3a1-d2ec2219c86e
11. Add (A) or update (U) the following under Attributes & Claims: | Claim name | Format | Source attribute | |--------------------------------------|---------------|------------------| | (U) Unique User Identifier (Name ID) | Email address | user.mail | ...
{"source_file": "04_saml-sso-setup.md"}
[ -0.1526101976633072, 0.0031800277065485716, -0.023335564881563187, -0.04695168137550354, -0.033731408417224884, 0.03771556168794632, 0.06533513218164444, -0.0052780150435864925, 0.007373554166406393, -0.005833454430103302, 0.05751211568713188, -0.02275744453072548, 0.1003187745809555, 0.02...
54583d1c-9ec0-404b-827f-f1fa00c33bb5
Security is our top priority when it comes to authentication. For this reason, we made a few decisions when implementing SSO that we need you to know. We only process service provider-initiated authentication flows. Users must navigate to https://console.clickhouse.cloud and enter an email address to be redire...
{"source_file": "04_saml-sso-setup.md"}
[ -0.034402575343847275, -0.039444051682949066, -0.008033677004277706, 0.0071739377453923225, 0.01774965040385723, 0.02519996464252472, 0.05340002104640007, -0.0003371488128323108, 0.022497348487377167, -0.0004978355136699975, 0.0077420868910849094, 0.011208059266209602, 0.029917975887656212, ...
a8a178a0-6750-4279-b32b-5c0a0f94e33d
sidebar_label: 'Manage database users' slug: /cloud/security/manage-database-users title: 'Manage database users' description: 'This page describes how administrators can add database users, manage assignments, and remove database users' doc_type: 'guide' keywords: ['database users', 'access management', 'security', 'p...
{"source_file": "04_manage-database-users.md"}
[ 0.024956777691841125, -0.012830287218093872, -0.08898157626390457, 0.05053429678082466, -0.017651183530688286, 0.06412546336650848, 0.11026682704687119, -0.018761886283755302, -0.013021901249885559, 0.08116471022367477, 0.034017663449048996, 0.038184754550457, 0.0990862175822258, 0.0079693...
862211b7-1da0-49d1-bf22-e22eeed21b38
:::tip Generate passwords securely Since users with less than administrative privileges cannot set their own password, ask the user to hash their password using a generator such as this one before providing it to the admin to setup the account. ::: sql CREATE USER userName IDENTIFIED WITH sha256_hash BY 'hash'; ...
{"source_file": "04_manage-database-users.md"}
[ -0.012052938342094421, -0.049462925642728806, -0.06994407624006271, -0.01620553806424141, -0.10892140120267868, 0.04657924920320511, 0.11220310628414154, -0.015549910254776478, -0.021385572850704193, 0.039801593869924545, 0.05547868087887764, -0.03269576281309128, 0.11165376007556915, -0.0...
44ca35ba-4aa3-4a9f-b737-193c2cf5e036
sql CREATE USER userID IDENTIFIED WITH sha256_hash by 'hashed_password'; GRANT default_role to userID; Users can use a SHA256 hash generator or code function such as hashlib in Python to convert a 12+ character password with appropriate complexity to a SHA256 string to provide to the system administrator as the...
{"source_file": "04_manage-database-users.md"}
[ 0.050429780036211014, -0.016426870599389076, -0.10852115601301193, 0.019384829327464104, -0.09168685227632523, 0.022885123267769814, 0.08218181133270264, -0.005771721713244915, -0.07850324362516403, -0.010129071772098541, -0.050963159650564194, 0.05127555876970291, 0.08455979079008102, -0....
56d2f1df-73e5-456e-9782-04f15820e10a
sidebar_label: 'Common access management queries' title: 'Common access management queries' slug: /cloud/security/common-access-management-queries description: 'This article shows the basics of defining SQL users and roles and applying those privileges and permissions to databases, tables, rows, and columns.' keywords:...
{"source_file": "05_common-access-management-queries.md"}
[ 0.006672120187431574, -0.09010016918182373, -0.08595810830593109, 0.02943495847284794, -0.04554660618305206, 0.0031488353852182627, 0.11118020117282867, -0.09332366287708282, -0.03987432271242142, 0.029137590900063515, 0.0544036440551281, 0.022083092480897903, 0.10712028294801712, -0.04303...
2ee47bb1-34f6-4784-b2d6-62139260372a
sql CREATE ROLE OR REPLACE sql-console-role:<email>; GRANT <some grants> TO sql-console-role:<email>; When a matching role is detected, it will be assigned to the user instead of the boilerplate roles. This introduces more complex access control configurations, such as creating roles like sql_console_sa_role and s...
{"source_file": "05_common-access-management-queries.md"}
[ 0.035244766622781754, -0.08191680908203125, -0.04321903735399246, -0.016834691166877747, -0.07744313776493073, 0.04244251176714897, 0.08570937812328339, 0.03736790269613266, 0.002398660173639655, 0.038638707250356674, -0.05912903696298599, -0.06060880795121193, 0.05124518275260925, 0.04849...
84489055-1c4f-4e30-9a9a-4f5d6bbac2b8
sidebar_label: 'Cloud access management' slug: /cloud/security/cloud_access_management title: 'Cloud access management' description: 'Learn more about cloud access management' doc_type: 'landing-page' keywords: ['access management', 'security', 'user management', 'permissions', 'authentication'] Cloud access manage...
{"source_file": "index.md"}
[ -0.011211346834897995, -0.019907912239432335, -0.046582676470279694, 0.021204717457294464, -0.017743827775120735, 0.06955568492412567, 0.09451738744974136, -0.0684523805975914, -0.010881141759455204, 0.07708223909139633, 0.026669492945075035, 0.009401701390743256, 0.04940794035792351, -0.0...
6326ac99-8d9b-4372-a548-ce200c7881ef
sidebar_label: 'Manage my account' slug: /cloud/security/manage-my-account title: 'Manage my account' description: 'This page describes how users can accept invitations, manage MFA settings, and reset passwords' doc_type: 'guide' keywords: ['account management', 'user profile', 'security', 'cloud console', 'settings'] ...
{"source_file": "01_manage-my-account.md"}
[ -0.015897385776042938, -0.01880280300974846, 0.00473054451867938, 0.06484631448984146, 0.016092384234070778, 0.04616968333721161, 0.03041197918355465, -0.09223944693803787, 0.013892950490117073, 0.057781580835580826, 0.03131768852472305, -0.040512774139642715, 0.024077879264950752, 0.02260...
0e2c27c8-a2ac-4a4f-9f10-b294a67d4f41
Click your initials in the upper left corner next to the ClickHouse logo Select Profile Select Security on the left Click Set up in the Authenticator app tile Use an authenticator app such as Authy, 1Password or Google Authenticator to scan the QR code Enter the code to confirm On the next screen, copy the ...
{"source_file": "01_manage-my-account.md"}
[ -0.10557043552398682, -0.003647072473540902, 0.012036255560815334, -0.035690777003765106, 0.05775466933846474, 0.0889926478266716, -0.011691742576658726, -0.05934691056609154, 0.015636010095477104, 0.04100865498185158, 0.056608203798532486, -0.0525534562766552, 0.047524306923151016, -0.041...
f551edda-6833-43d4-b28c-498a906215c2
Lost MFA and recovery code {#lost-mfa-and-recovery-code} If you lost your MFA device AND recovery code or you lost your MFA device and never obtained a recovery code, follow these steps to request a reset: Submit a ticket : If you are in an organization that has other administrative users, even if you are attemptin...
{"source_file": "01_manage-my-account.md"}
[ -0.035202812403440475, -0.07850717753171921, 0.008529954589903355, 0.05342250317335129, 0.07972303777933121, 0.06272194534540176, -0.02757425419986248, -0.057393431663513184, -0.06480608135461807, -0.0174981988966465, 0.04707206040620804, -0.03426622599363327, 0.012871074490249157, -0.0336...
c3228a9a-32f0-4c8d-82c0-3efd7541c905
sidebar_label: 'Manage cloud users' slug: /cloud/security/manage-cloud-users title: 'Manage cloud users' description: 'This page describes how administrators can add users, manage assignments, and remove users' doc_type: 'guide' keywords: ['cloud users', 'access management', 'security', 'permissions', 'team management'...
{"source_file": "02_manage-cloud-users.md"}
[ -0.02579088881611824, 0.02726413868367672, -0.04263991862535477, 0.06264146417379379, 0.03198447450995445, -0.0032196766696870327, 0.061420317739248276, -0.019855570048093796, -0.07170389592647552, 0.048588212579488754, 0.05355421453714371, 0.015876727178692818, 0.10508201271295547, -0.038...
cab10f12-315a-446d-821d-0ea3a619d765
Users assigned the Organization Admin role may update permissions for other users at any time. Access organization settings {#access-organization-settings} From the services page, select the name of your organization: Access users and roles {#access-users-and-roles} Select the Users and roles menu item fr...
{"source_file": "02_manage-cloud-users.md"}
[ -0.011961858719587326, -0.021298428997397423, -0.05243785306811333, -0.013010233640670776, -0.03839005157351494, 0.029012979939579964, 0.04171387106180191, -0.06133256480097771, 0.0009820486884564161, 0.05730711668729782, -0.03494514152407646, 0.0417843721807003, -0.03961142525076866, 0.00...
4e6f51fe-d0a6-4c49-b488-5df4a92d11de
slug: /cloud/guides/sql-console/manage-sql-console-role-assignments sidebar_label: 'Manage SQL console role assignments' title: 'Manage SQL console role assignments' description: 'Guide showing how to manage SQL console role assignments' doc_type: 'guide' keywords: ['sql console', 'role assignments', 'access management...
{"source_file": "03_manage-sql-console-role-assignments.md"}
[ 0.017535299062728882, -0.03294713422656059, -0.04965084791183472, 0.02123940922319889, 0.023342011496424675, 0.008873207494616508, 0.05669811740517616, 0.05347828567028046, -0.0712660476565361, 0.044161755591630936, 0.04240043833851814, 0.013166808523237705, 0.11418124288320541, 0.00207251...
7232fa7e-505c-4fd2-aaf4-1f66fffa78e2
sidebar_label: 'Setting IP filters' slug: /cloud/security/setting-ip-filters title: 'Setting IP filters' description: 'This page explains how to set IP filters in ClickHouse Cloud to control access to ClickHouse services.' doc_type: 'guide' keywords: ['IP filters', 'IP access list'] import Image from '@theme/IdealI...
{"source_file": "01_setting-ip-filters.md"}
[ -0.021622171625494957, 0.021804068237543106, -0.008646993897855282, -0.04264555126428604, 0.018712885677814484, -0.028430283069610596, 0.08799012005329132, -0.12811800837516785, -0.02639489807188511, 0.00525281298905611, 0.040678929537534714, 0.016328301280736923, 0.03708864003419876, -0.0...
492004f7-9f62-4cdf-aaa7-1afcc56e8b63
IP access list for API keys When you create an API key, the default setting for the IP allow list is 'Allow from anywhere.' From the API key list, click the three dots next to the API key under the **Actions** column and select **Edit**. At the bottom of the screen you will find the IP access list and options to...
{"source_file": "01_setting-ip-filters.md"}
[ -0.04012071341276169, -0.00810993928462267, 0.008454977534711361, -0.06933960318565369, -0.06127340346574783, 0.03265279158949852, 0.03627049922943115, -0.11579001694917679, -0.024767782539129257, 0.017826024442911148, 0.016000615432858467, 0.0341523140668869, 0.007868417538702488, -0.0254...
8729eab7-1203-4cee-a324-6f6a60970c54
sidebar_label: 'Database audit log' slug: /cloud/security/audit-logging/database-audit-log title: 'Database audit log' description: 'This page describes how users can review the database audit log' doc_type: 'guide' keywords: ['audit logging', 'database logs', 'compliance', 'security', 'monitoring'] Database audit ...
{"source_file": "02_database-audit-log.md"}
[ 0.03717181459069252, -0.035913120955228806, -0.04356160759925842, 0.03804159164428711, 0.07649941742420197, -0.01817016489803791, 0.11246467381715775, -0.016815073788166046, 0.041695788502693176, 0.05031820386648178, 0.06848639994859695, 0.031206784769892693, 0.05515250191092491, -0.021382...
658c72d6-f9bb-4ddc-a920-3c6321f7b77c
sidebar_label: 'BYOC security playbook' slug: /cloud/security/audit-logging/byoc-security-playbook title: 'BYOC security playbook' description: 'This page illustrates methods customers can use to identify potential security events' doc_type: 'guide' keywords: ['byoc', 'security', 'playbook', 'best practices', 'complian...
{"source_file": "03_byoc-security-playbook.md"}
[ -0.0375317707657814, -0.020074281841516495, -0.1045546680688858, -0.08120857924222946, 0.027018358930945396, 0.06258131563663483, 0.10327885299921036, -0.03600051626563072, 0.086075060069561, 0.05394457280635834, 0.03938233479857445, 0.01957441121339798, 0.04768980294466019, -0.05443640053...
9287e432-ccb2-49c1-9406-3b3124dfa13f
Review user accessing Kubernetes secrets, filter out service roles sql fields @timestamp,user.extra.sessionName.0, requestURI, verb,userAgent, @message, @logStream, @log | sort @timestamp desc | filter requestURI like /secret/ | filter verb="get" | filter ispresent(user.extra.sessionName.0) | filter user.username not ...
{"source_file": "03_byoc-security-playbook.md"}
[ 0.027894364669919014, 0.06761922687292099, 0.05062082037329674, -0.022344645112752914, -0.0379064679145813, -0.007974007166922092, 0.11587031185626984, -0.08837639540433884, 0.004342487081885338, 0.007794180419296026, -0.01868516393005848, -0.09224280714988708, -0.010598015040159225, 0.010...
4e1ac3cd-8371-4096-884a-b61502502dcd
sidebar_label: 'Audit logging' slug: /cloud/security/audit_logging title: 'Audit logging' hide_title: true description: 'Table of contents page for the ClickHouse Cloud audit logging section' doc_type: 'landing-page' keywords: ['audit logging', 'compliance', 'security', 'logging', 'monitoring'] Audit logging | Pa...
{"source_file": "index.md"}
[ 0.010102024301886559, 0.05964739993214607, 0.002013350836932659, 0.026636188849806786, 0.0971817672252655, 0.007336131762713194, 0.08109117299318314, -0.10550250858068466, 0.026415608823299408, 0.04774774610996246, 0.02936389297246933, -0.045131731778383255, 0.02677220106124878, -0.0291793...
0a273399-caea-47ae-a134-b5924609422c
sidebar_label: 'Console audit log' slug: /cloud/security/audit-logging/console-audit-log title: 'Console audit log' description: 'This page describes how users can review the cloud audit log' doc_type: 'guide' keywords: ['audit log'] import Image from '@theme/IdealImage'; import activity_log_1 from '@site/static/im...
{"source_file": "01_console-audit-log.md"}
[ 0.05149667337536812, 0.015931131318211555, -0.009808112867176533, -0.010753757320344448, 0.1360548585653305, 0.0043218438513576984, 0.08753819018602371, -0.014117795042693615, 0.07965134084224701, 0.0955740287899971, 0.02732415683567524, -0.0038943460676819086, 0.04753003641963005, 0.02870...
09c9296e-6bdb-4dc2-aa94-5d0d9405b3a5
sidebar_label: 'HIPAA onboarding' slug: /cloud/security/compliance/hipaa-onboarding title: 'HIPAA onboarding' description: 'Learn more about how to onboard to HIPAA compliant services' doc_type: 'guide' keywords: ['hipaa', 'compliance', 'healthcare', 'security', 'data protection'] import BetaBadge from '@theme/badg...
{"source_file": "hipaa-onboarding.md"}
[ -0.028519051149487495, 0.062378011643886566, -0.06510334461927414, -0.0739385113120079, 0.02651171013712883, 0.004736573435366154, 0.05189036950469017, 0.01587505452334881, -0.025653114542365074, 0.010943099856376648, 0.044697355479002, 0.024629320949316025, 0.07901919633150101, -0.0300620...
59f705d8-9597-4a1c-b4f4-81212550fb8d
If migration from standard to HIPAA compliant regions is required, follow these steps to perform self-service migrations: Select the service to be migrated. Click Backups on the left. Select the three dots to the left of the backup to be restored. Select the Region type to restore the backup to a HIPAA co...
{"source_file": "hipaa-onboarding.md"}
[ 0.013833455741405487, 0.029981182888150215, 0.019181156530976295, -0.10615597665309906, -0.031161967664957047, 0.009683975949883461, -0.04010777547955513, -0.09196167439222336, 0.02280123345553875, 0.03981627896428108, 0.008901536464691162, 0.01163832750171423, 0.02433682791888714, -0.0213...
7edc42ff-0455-4ac7-b645-1124ccd9273d
sidebar_label: 'PCI onboarding' slug: /cloud/security/compliance/pci-onboarding title: 'PCI onboarding' description: 'Learn more about how to onboard to PCI compliant services' doc_type: 'guide' keywords: ['pci', 'compliance', 'payment security', 'data protection', 'security'] import BetaBadge from '@theme/badges/B...
{"source_file": "pci-onboarding.md"}
[ -0.07686872035264969, 0.022063376381993294, -0.07112378627061844, -0.041825275868177414, 0.037714190781116486, -0.012588311918079853, 0.08154552429914474, -0.0302071925252676, -0.03533407300710678, -0.05639396607875824, 0.07383181154727936, -0.020012227818369865, 0.055272966623306274, 0.01...
8214b897-ce62-4efa-a4dd-1c1cbcdeb8d1
If migration from standard to PCI compliant regions is required, follow these steps to perform self-service migrations: Select the service to be migrated. Click Backups on the left. Select the three dots to the left of the backup to be restored. Select the Region type to restore the backup to a PCI compli...
{"source_file": "pci-onboarding.md"}
[ 0.028241444379091263, -0.007443610113114119, 0.06067287549376488, -0.07260888814926147, 0.025865113362669945, -0.010381207801401615, -0.043501678854227066, -0.13086619973182678, -0.019278747960925102, -0.005186670925468206, 0.045114416629076004, -0.004618980456143618, 0.008282314985990524, ...
c3bec3aa-fba1-4bfa-a622-75a9bb58fb7f
title: 'GCP private service connect' description: 'This document describes how to connect to ClickHouse Cloud using Google Cloud Platform (GCP) Private Service Connect (PSC), and how to disable access to your ClickHouse Cloud services from addresses other than GCP PSC addresses using ClickHouse Cloud IP access lists.' ...
{"source_file": "03_gcp-private-service-connect.md"}
[ -0.060518041253089905, 0.005113193299621344, -0.006365846376866102, 0.0058302669785916805, -0.022564709186553955, 0.031788937747478485, 0.061075061559677124, -0.05494154617190361, -0.012109707109630108, 0.028051650151610374, 0.054238468408584595, 0.03619598597288132, 0.033376120030879974, ...
d0a1aac7-d5e6-4b33-b9b1-fe578492b714
Cross-region connectivity is not supported. The producer and consumer regions must be the same. However, you can connect from other regions within your VPC by enabling Global Access at the Private Service Connect (PSC) level. Please complete the following to enable GCP PSC : 1. Obtain GCP service attachment for Pri...
{"source_file": "03_gcp-private-service-connect.md"}
[ -0.026089392602443695, -0.09189186245203018, -0.014084937050938606, -0.019663378596305847, 0.010335450060665607, 0.032876480370759964, -0.035982660949230194, -0.13298305869102478, -0.015063551254570484, 0.051090169697999954, -0.01700618676841259, -0.04638532176613808, 0.012548400089144707, ...
241ef75f-25c9-444a-9f2c-e47fa058060b
Option 1: ClickHouse Cloud console {#option-1-clickhouse-cloud-console} In the ClickHouse Cloud console, open the service that you would like to connect via Private Service Connect, then open the Settings menu. Click on the Set up private endpoint button. Make a note of the Service name ( endpointServiceId ) a...
{"source_file": "03_gcp-private-service-connect.md"}
[ 0.009010705165565014, -0.04007792845368385, -0.01348545216023922, -0.04591257497668266, -0.07326331734657288, 0.04936520382761955, -0.07204828411340714, -0.05874467268586159, 0.04215797409415245, 0.0642617791891098, 0.0007638672832399607, -0.04695712774991989, -0.007455176208168268, 0.0145...
7d24fbcf-1206-4845-b856-28c94274a569
To create the PSC Endpoint, use the ADD ENDPOINT button. The Status column will change from Pending to Accepted once the connection is approved. Copy PSC Connection ID , we are going to use it as Endpoint ID in the next steps. Option 2: Using Terraform {#option-2-using-terraform} ```json provider "...
{"source_file": "03_gcp-private-service-connect.md"}
[ -0.06890125572681427, -0.0460188202559948, -0.022852720692753792, 0.012242269702255726, -0.055604904890060425, -0.007165639661252499, 0.007764511276036501, -0.06585658341646194, -0.014837984926998615, 0.12900908291339874, -0.039141468703746796, -0.0637294203042984, 0.02569747529923916, 0.0...
271546d0-5b11-4127-9856-8da7281faa54
Set these environment variables before running any commands: Replace ENDPOINT_ID below by value from Endpoint ID from Adding a Private Service Connection step To add an endpoint, run: bash cat <<EOF | tee pl_config_org.json { "privateEndpoints": { "add": [ { "cloudProvider": "gcp", ...
{"source_file": "03_gcp-private-service-connect.md"}
[ 0.008767166174948215, 0.04300917312502861, 0.012120791710913181, -0.016284773126244545, -0.00908165518194437, 0.020223209634423256, -0.009848101995885372, -0.045813240110874176, 0.0470150001347065, 0.06613373011350632, 0.00810216274112463, -0.02604416385293007, -0.008955639787018299, 0.027...
e206cd85-8807-4aff-afe5-7fb9952decf2
Getting private DNS hostname {#getting-private-dns-hostname} Option 1: ClickHouse Cloud console {#option-1-clickhouse-cloud-console-3} In the ClickHouse Cloud console, navigate to Settings . Click on the Set up private endpoint button. In the opened flyout, copy the DNS Name . Option 2: API {#option-2-api-3...
{"source_file": "03_gcp-private-service-connect.md"}
[ 0.003156336024403572, 0.030973924323916435, -0.03197702392935753, -0.016777608543634415, -0.03974098712205887, -0.013481473550200462, -0.03399237245321274, -0.07057406008243561, 0.08448218554258347, 0.02831408381462097, -0.007966602221131325, -0.01872427947819233, -0.04549127444624901, -0....
22c5a010-7ece-457f-bac9-9cc8da5e59dc
According to the GCP Private Service Connect documentation : Service-oriented design: Producer services are published through load balancers that expose a single IP address to the consumer VPC network. Consumer traffic that accesses producer services is unidirectional and can only access the service IP address, ra...
{"source_file": "03_gcp-private-service-connect.md"}
[ -0.0390063039958477, -0.09094113856554031, 0.02079661563038826, -0.02185690402984619, -0.06472685188055038, 0.04132918640971184, 0.03610078990459442, -0.11167259514331818, -0.000060185539041412994, 0.039163585752248764, 0.029946254566311836, 0.0073327356949448586, 0.024971209466457367, -0....
b73e275e-32a9-4183-af53-eee1c82d36b4
title: 'Azure Private Link' sidebar_label: 'Azure Private Link' slug: /cloud/security/azure-privatelink description: 'How to set up Azure Private Link' keywords: ['azure', 'private link', 'privatelink'] doc_type: 'guide' import Image from '@theme/IdealImage'; import ScalePlanFeatureBadge from '@theme/badges/ScalePl...
{"source_file": "04_azure-privatelink.md"}
[ -0.026931844651699066, 0.06198356673121452, -0.041558727622032166, 0.08456425368785858, 0.061001937836408615, 0.05865752696990967, 0.03713570907711983, 0.01372468750923872, -0.021049221977591515, 0.11689982563257217, 0.12097833305597305, -0.005264651495963335, 0.1136036142706871, 0.0393862...
bb3bca72-a553-424c-96e0-0a5f5882c985
Create a Private Endpoint in Azure Add the Private Endpoint Resource ID to your ClickHouse Cloud organization Add the Private Endpoint Resource ID to your service(s) allow list Access your ClickHouse Cloud service using Private Link :::note ClickHouse Cloud Azure PrivateLink has switched from using resourceGU...
{"source_file": "04_azure-privatelink.md"}
[ -0.004650741349905729, -0.03140442073345184, -0.01668982394039631, 0.02941017411649227, 0.02047475427389145, 0.055953122675418854, 0.030000915750861168, -0.1535647064447403, 0.019127000123262405, 0.10405411571264267, 0.021747777238488197, -0.0011274080025032163, 0.059677157551050186, 0.067...
434075b9-30dd-4111-939c-38293fd6f929
Obtain your Azure connection alias and Private DNS hostname for Private Link: bash curl --silent --user "${KEY_ID:?}:${KEY_SECRET:?}" "https://api.clickhouse.cloud/v1/organizations/${ORG_ID:?}/services/${INSTANCE_ID:?}/privateEndpointConfig" | jq .result { "endpointServiceId": "production-westus3-0-0.xxxxxxxx-xxxx...
{"source_file": "04_azure-privatelink.md"}
[ -0.015427583828568459, 0.003316943533718586, -0.056259457021951675, 0.012938406318426132, -0.05530311167240143, 0.025943869724869728, 0.0036361138336360455, -0.09919971972703934, 0.058209169656038284, 0.09684813022613525, 0.033682238310575485, -0.052639227360486984, 0.05457650125026703, 0....
c660396b-4911-4a9e-b17b-17866e6f4999
Click the Next: Tags button. Optionally, you can attach tags to your Private Endpoint. Click the Next: Review + create button. Finally, click the Create button. The Connection status of the created Private Endpoint will be in Pending state. It will change to Approved state once you add thi...
{"source_file": "04_azure-privatelink.md"}
[ 0.012565746903419495, 0.022292183712124825, -0.041083741933107376, 0.010627214796841145, -0.003932267427444458, 0.05293475463986397, 0.00762349646538496, -0.06372810900211334, 0.019608762115240097, 0.12983494997024536, 0.009315920993685722, -0.07028388231992722, 0.06293760985136032, 0.0666...
2c4688ed-908d-468b-8bee-b95a5864150b
Select + Record set. For Name, type * . For IP Address, type the IP address you see for Private Endpoint. Select OK . Option 2: Using Terraform Use the following Terraform template to create a wildcard DNS record: json resource "azurerm_private_dns_a_record" "example" { name = "*" z...
{"source_file": "04_azure-privatelink.md"}
[ -0.004903440363705158, 0.010704521089792252, -0.023486677557229996, 0.029635325074195862, -0.05250658839941025, 0.07545588910579681, 0.01617632992565632, -0.060382742434740067, 0.03458140045404434, 0.11829473823308945, -0.03261354938149452, -0.06259305775165558, 0.06669901311397552, 0.0120...
f666173e-9b1c-44c0-8fe0-e7a9b9831017
You can also run the following command to remove a Private Endpoint: bash cat <<EOF | tee pl_config_org.json { "privateEndpoints": { "remove": [ { "cloudProvider": "azure", "id": "${ENDPOINT_ID:?}", "region": "${REGION:?}" } ] } } EOF After adding or removing a Privat...
{"source_file": "04_azure-privatelink.md"}
[ -0.009048866108059883, 0.04733551666140556, -0.02254641056060791, -0.0016001067124307156, -0.0026699574664235115, 0.03729451820254326, -0.015158528462052345, -0.127370223402977, 0.08168596774339676, 0.0984683707356453, 0.03908494859933853, 0.004655227065086365, 0.033282507210969925, 0.0261...
26eae042-8ee3-4489-91d6-ed0f124062d7
Obtaining the private DNS hostname {#obtaining-the-private-dns-hostname} Option 1: ClickHouse Cloud console {#option-1-clickhouse-cloud-console-3} In the ClickHouse Cloud console, navigate to Settings . Click on the Set up private endpoint button. In the opened flyout, copy the DNS Name . Option 2: API {#op...
{"source_file": "04_azure-privatelink.md"}
[ 0.011967360973358154, 0.026852797716856003, -0.026418892666697502, -0.010282507166266441, -0.022985680028796196, -0.008747006766498089, -0.052190426737070084, -0.08095495402812958, 0.08124712854623795, 0.0363176129758358, -0.02108573168516159, -0.040737368166446686, -0.053913190960884094, ...
59b63b18-f2c2-4b5c-8d4d-f7564f5ad4ab
Checking private endpoint filters {#checking-private-endpoint-filters} Set the following environment variables before running any commands: bash KEY_ID=<Key ID> KEY_SECRET=<Key secret> ORG_ID=<please set ClickHouse organization ID> INSTANCE_ID=<Instance ID> Run the following command to check Private Endpoint filt...
{"source_file": "04_azure-privatelink.md"}
[ 0.04525483772158623, 0.04524124041199684, -0.05186644196510315, 0.010731026530265808, 0.01128141488879919, 0.011724754236638546, 0.012647013179957867, -0.11601525545120239, 0.07279219478368759, 0.06600039452314377, 0.014566201716661453, -0.06169211119413376, 0.0017869406146928668, 0.036798...
f0532680-7c25-4281-81bc-4f11cd41836f
slug: /cloud/security/connectivity/private-networking title: 'Private networking' hide_title: true description: 'Table of contents page for the ClickHouse Cloud private networking section' doc_type: 'landing-page' keywords: ['private networking', 'network security', 'vpc', 'connectivity', 'cloud features'] Private ...
{"source_file": "index.md"}
[ -0.008541354909539223, -0.040691010653972626, -0.005937764886766672, -0.00341674592345953, -0.016172491014003754, 0.11455545574426651, 0.02528087981045246, -0.07513529807329178, 0.007136449683457613, 0.08151532709598541, 0.08385097980499268, 0.02271338365972042, -0.0013469335390254855, -0....
b340a08b-aa65-46de-bb7d-85db8050322d
title: 'AWS PrivateLink' description: 'This document describes how to connect to ClickHouse Cloud using AWS PrivateLink.' slug: /manage/security/aws-privatelink keywords: ['PrivateLink'] doc_type: 'guide' import Image from '@theme/IdealImage'; import ScalePlanFeatureBadge from '@theme/badges/ScalePlanFeatureBadge';...
{"source_file": "02_aws-privatelink.md"}
[ -0.03228222578763962, 0.032612044364213943, -0.06530734896659851, 0.053830720484256744, 0.08299439400434494, 0.04574484005570412, 0.010913873091340065, 0.022985730320215225, 0.011168972589075565, 0.05651365593075752, 0.10435692965984344, -0.023793021216988564, 0.06400007009506226, 0.022245...
da8d107d-074a-4fb7-a5fc-00791cdb6ac3
Find Terraform examples here . Important considerations {#considerations} ClickHouse attempts to group your services to reuse the same published service endpoint within the AWS region. However, this grouping is not guaranteed, especially if you spread your services across multiple ClickHouse organizations. If yo...
{"source_file": "02_aws-privatelink.md"}
[ 0.006078951992094517, -0.08167776465415955, -0.007049529813230038, -0.00889564398676157, -0.00044718009303323925, 0.02770080603659153, -0.03444645553827286, -0.09674657881259918, 0.02475420944392681, 0.06181519106030464, -0.008522944524884224, -0.0318262055516243, 0.0384194515645504, 0.015...
8cdb6fa3-987c-4ede-aa1d-293f605adc6a
Please note that ClickHouse is not responsible for configuring the required AWS VPC endpoints, security group rules or DNS records. If you previously enabled "private DNS names" while setting up PrivateLink and are experiencing difficulties configuring new services via PrivateLink, please contact ClickHouse support...
{"source_file": "02_aws-privatelink.md"}
[ -0.045653894543647766, -0.09055919200181961, -0.045116692781448364, 0.00017570416093803942, -0.007621560245752335, 0.0482654944062233, -0.02900180220603943, -0.04603564366698265, -0.0019082266371697187, 0.02904769778251648, 0.016470892354846, -0.05171763524413109, 0.0013134124455973506, 0....
bfa0cbc0-053e-4acf-b24f-22f138c318d6
Option 3: Terraform {#option-3-terraform} service_name below is Service name console or endpointServiceId API you got from Obtain Endpoint "Service name" step json resource "aws_vpc_endpoint" "this" { vpc_id = var.vpc_id service_name = "<pls see comment above>" vpc_endpoint_type = "Int...
{"source_file": "02_aws-privatelink.md"}
[ -0.07491301000118256, -0.002950690919533372, -0.056284379214048386, -0.01631084457039833, -0.013952507637441158, 0.03686925023794174, -0.03153286874294281, -0.04727655649185181, 0.03454088792204857, 0.05371158942580223, -0.061046719551086426, -0.06923838704824448, 0.018762893974781036, 0.0...
cbcb451e-db22-489b-8de1-20201fa6dfb0
To remove an endpoint ID from an allow-list: ```bash cat <<EOF | tee pl_config.json { "privateEndpointIds": { "remove": [ "${ENDPOINT_ID:?}" ] } } EOF curl --silent --user "${KEY_ID:?}:${KEY_SECRET:?}" \ -X PATCH -H "Content-Type: application/json" \ "https://api.clickhouse.cloud/v1/organizations/...
{"source_file": "02_aws-privatelink.md"}
[ -0.038115859031677246, 0.0910278931260109, 0.004673262592405081, -0.021450860425829887, 0.006242399103939533, 0.012480607256293297, 0.01694389246404171, -0.0764881893992424, 0.025471925735473633, 0.039910878986120224, 0.023334747180342674, 0.014389783143997192, 0.021901583299040794, -0.001...
69a10166-239b-4ee1-b3e5-2b09b1519023
Checking endpoint filters {#checking-endpoint-filters} Set the following environment variables before running any commands: bash KEY_ID=<Key ID> KEY_SECRET=<Key secret> ORG_ID=<please set ClickHouse organization ID> INSTANCE_ID=<Instance ID> You can retrieve INSTANCE_ID from step . shell curl --silent --user...
{"source_file": "02_aws-privatelink.md"}
[ 0.015732528641819954, 0.02610502392053604, -0.08499519526958466, 0.020927852019667625, 0.007410655729472637, 0.0005274497088976204, 0.004411124624311924, -0.07224799692630768, 0.06532768160104752, 0.022551340982317924, 0.011147900484502316, -0.048885270953178406, 0.0350768081843853, -0.054...
3fe494d5-a2b1-433d-8c0a-b3b67cf5cffb
title: 'ClickHouse Government' slug: /cloud/infrastructure/clickhouse-government keywords: ['government', 'fips', 'fedramp', 'gov cloud'] description: 'Overview of ClickHouse Government offering' doc_type: 'reference' import Image from '@theme/IdealImage'; import private_gov_architecture from '@site/static/images/c...
{"source_file": "03_clickhouse-government.md"}
[ -0.07903894782066345, -0.028988730162382126, -0.011610481888055801, -0.04480878636240959, 0.034823909401893616, -0.07194621860980988, 0.023314664140343666, -0.03769095987081528, 0.026471469551324844, 0.06174715235829353, 0.019987544044852257, 0.027039267122745514, 0.007215996738523245, -0....