Skip to content

Add QVD to ClickHouse data transfer guide #3437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
514Ben wants to merge 10 commits into
base: main
Choose a base branch
from
+401 −6
Open

Add QVD to ClickHouse data transfer guide #3437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
31b4364
Add QVD to ClickHouse data transfer guide
514Ben Feb 3, 2026
4920c5b
Merge branch 'main' into qvd-to-clickhouse-guide
514Ben Feb 3, 2026
8af8c86
Rewrite guide to focus on using the pipeline, not implementing it
514Ben Feb 3, 2026
fb75f19
Fix CTACards component usage for build
514Ben Feb 3, 2026
28a3258
fix: correct example to avoid overwriting Pydantic model with OlapTable
514Ben Feb 3, 2026
b3a03f1
Address PR feedback for performant-dashboards guide
514Ben Feb 3, 2026
35a8619
Remove ClickHouse Tracking section from QVD guide
514Ben Feb 3, 2026
a02f9ec
Make QVD to ClickHouse guide publicly visible
514Ben Feb 3, 2026
4288daa
Revert QVD guide to draft status
514Ben Feb 3, 2026
4739016
Set NAV_VARIANT to draft in Vercel builds
514Ben Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions apps/framework-docs-v2/content/guides/performant-dashboards.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ previewVariant: "dashboards"
languages: ["typescript"]
---

import { CTACards, CTACard, Callout, BulletPointsCard, ToggleBlock } from "@/components/mdx";
import { CTACards, CTACard, Callout, BulletPointsCard, ToggleBlock, ConditionalContent, CustomizePanel, CustomizeGrid, SelectField } from "@/components/mdx";
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 3, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if newly imported components are used in the file
for comp in ConditionalContent CustomizePanel CustomizeGrid SelectField; do
  echo "=== Checking usage of $comp ==="
  rg "<${comp}" apps/framework-docs-v2/content/guides/performant-dashboards.mdx || echo "Not found"
done

Repository: 514-labs/moosestack

Length of output: 266

Remove unused component imports.

The imports ConditionalContent, CustomizePanel, CustomizeGrid, and SelectField are not used anywhere in the file and should be removed from line 8.

🤖 Prompt for AI Agents 
In `@apps/framework-docs-v2/content/guides/performant-dashboards.mdx` at line 8,
The import statement on line 8 includes unused components—ConditionalContent,
CustomizePanel, CustomizeGrid, and SelectField—which should be removed to
eliminate dead imports; update the import list that currently contains CTACards,
CTACard, Callout, BulletPointsCard, ToggleBlock, ConditionalContent,
CustomizePanel, CustomizeGrid, SelectField to only include the actually used
symbols (e.g., CTACards, CTACard, Callout, BulletPointsCard, ToggleBlock) by
deleting the unused component names from that import.


# Improving the Performance of Your Dashboards

Expand Down Expand Up @@ -131,11 +131,11 @@ Engineering can ship new dashboards, metrics, and breakdowns as routine product

This tutorial assumes you already have a dashboard or report running in production, and you want to make it faster using OLAP best practices. You'll work through:

1. Setting up your local dev environment
1. Setting up your local dev environment (with a remote ClickHouse database)
2. Migrating your dashboard business logic from OLTP to MooseStack/ClickHouse
3. Shipping your changes to production on Boreal Cloud

**AI copilot (optional but recommended):** We recommend using an AI copilot to accelerate the migration to handle complex query translations. However, you can complete every step manually if you prefer. Any AI-enabled editor (Claude Code, Cursor, Codex, Opencode, Github Copilot, Windsurf, etc.) will work.
**AI copilot (optional but recommended):** We recommend using an AI copilot that supports MCP (Model Context Protocol) to accelerate the migration and handle complex query translations. However, you can complete every step manually if you prefer. Any AI-enabled editor with MCP support (Claude Code, Cursor, Windsurf, etc.) will work.

<Callout type="tip" title="AI copilot tips (optional)">
If you use a copilot, these two prompts tend to help most in this guide:
Expand All @@ -146,6 +146,10 @@ If you use a copilot, these two prompts tend to help most in this guide:

**Language:** This guide is written for TypeScript developers. Python developers can follow along—the concepts translate directly, and MooseStack supports both languages. The main differences are syntax and framework-specific patterns. If you'd like to see Python-specific examples, let us know and we'll prioritize creating them.

<Callout type="info" title="Need help?">
Join our [community Slack](https://join.slack.com/t/moose-community/shared_invite/zt-2fjh5n3wz-cnOmM9Xe9DYAgQrNu8xKxg) to get support, ask questions, or share your progress. We're here to help you migrate successfully.
</Callout>

### Setting up your development environment

In this section, you'll:
Expand Down Expand Up @@ -715,7 +719,13 @@ moose seed clickhouse --connection-string <PRODUCTION_CONNECTION_STRING> --all

**Important:** `moose seed clickhouse` uses ClickHouse's HTTPS protocol. Use a HTTPS connection string (e.g., `https://username:password@host:8443/database`).

If you already use Boreal, you can locate your connection string in your project overview dashboard.
**Finding your connection string in Boreal:**
1. Open your Boreal project dashboard
2. Navigate to the project overview page
3. Look for the "Connection Details" or "Database Credentials" section
4. Copy the HTTPS connection string (it will start with `https://`)

If you're using a different ClickHouse provider, consult their documentation for obtaining the HTTPS connection string.


Optionally set it as an environment variable:
Expand Down Expand Up @@ -1120,7 +1130,16 @@ Verify the response time is significantly improved compared to the original OLTP

Add the files you created above (or just the functional files if you don't want to commit your test scripts) and push to your version control. Create a Pull Request.

This branch will later be used in Boreal for a Branch Deployment, automatically triggered by creating the PR.
This branch will later be used in Boreal for a Branch Deployment, automatically triggered by creating the PR.

<Callout type="success" title="Local development complete">
You've successfully:
- Set up your local MooseStack development environment
- Migrated your dashboard logic from OLTP to ClickHouse
- Tested your new OLAP-backed endpoints locally

Now you're ready to deploy these changes to production using Boreal Cloud, which provides managed ClickHouse infrastructure and automated deployments.
</Callout>

### Going to production

Expand Down
Loading
Loading