clickhouse-ci-integration SKILL.md View full skill →

Configure ClickHouse CI/CD integration with GitHub Actions and testing.

ReadWriteEditBash(gh:*)

ClickHouse CI Integration

Overview

Set up CI/CD pipelines for ClickHouse integrations with automated testing.

Prerequisites

GitHub repository with Actions enabled
ClickHouse test API key
npm/pnpm project configured

Instructions

Step 1: Create GitHub Actions Workflow

Create .github/workflows/clickhouse-integration.yml:


name: ClickHouse Integration Tests

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  CLICKHOUSE_API_KEY: ${{ secrets.CLICKHOUSE_API_KEY }}

jobs:
  test:
    runs-on: ubuntu-latest
    env:
      CLICKHOUSE_API_KEY: ${{ secrets.CLICKHOUSE_API_KEY }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'
      - run: npm ci
      - run: npm test -- --coverage
      - run: npm run test:integration

Step 2: Configure Secrets


gh secret set CLICKHOUSE_API_KEY --body "sk_test_***"

Step 3: Add Integration Tests


describe('ClickHouse Integration', () => {
  it.skipIf(!process.env.CLICKHOUSE_API_KEY)('should connect', async () => {
    const client = getClickHouseClient();
    const result = await client.healthCheck();
    expect(result.status).toBe('ok');
  });
});

Output

Automated test pipeline
PR checks configured
Coverage reports uploaded
Release workflow ready

Error Handling

Issue	Cause	Solution
Secret not found	Missing configuration	Add secret via `gh secret set`
Tests timeout	Network issues	Increase timeout or mock
Auth failures	Invalid key	Check secret value

Examples

Release Workflow


on:
  push:
    tags: ['v*']

jobs:
  release:
    runs-on: ubuntu-latest
    env:
      CLICKHOUSE_API_KEY: ${{ secrets.CLICKHOUSE_API_KEY_PROD }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - name: Verify ClickHouse production readiness
        run: npm run test:integration
      - run: npm run build
      - run: npm publish

Branch Protection


required_status_checks:
  - "test"
  - "clickhouse-integration"

Resources

Next St

clickhouse-common-errors SKILL.md View full skill →

Diagnose and fix ClickHouse common errors and exceptions.

ReadGrepBash(curl:*)

clickhouse-core-workflow-a SKILL.md View full skill →

Execute ClickHouse primary workflow: Core Workflow A.

ReadWriteEditBash(npm:*)Grep

clickhouse-core-workflow-b SKILL.md View full skill →

Execute ClickHouse secondary workflow: Core Workflow B.

ReadWriteEditBash(npm:*)Grep

clickhouse-cost-tuning SKILL.md View full skill →

Optimize ClickHouse costs through tier selection, sampling, and usage monitoring.

ReadGrep

ClickHouse Cost Tuning

Overview

Optimize ClickHouse costs through smart tier selection, sampling, and usage monitoring.

Prerequisites

Access to ClickHouse billing dashboard
Understanding of current usage patterns
Database for usage tracking (optional)
Alerting system configured (optional)

Pricing Tiers

Tier	Monthly Cost	Included	Overage
Free	$0	1,000 requests	N/A
Pro	$99	100,000 requests	$0.001/request
Enterprise	Custom	Unlimited	Volume discounts

Cost Estimation


interface UsageEstimate {
  requestsPerMonth: number;
  tier: string;
  estimatedCost: number;
  recommendation?: string;
}

function estimateClickHouseCost(requestsPerMonth: number): UsageEstimate {
  if (requestsPerMonth <= 1000) {
    return { requestsPerMonth, tier: 'Free', estimatedCost: 0 };
  }

  if (requestsPerMonth <= 100000) {
    return { requestsPerMonth, tier: 'Pro', estimatedCost: 99 };
  }

  const proOverage = (requestsPerMonth - 100000) * 0.001;
  const proCost = 99 + proOverage;

  return {
    requestsPerMonth,
    tier: 'Pro (with overage)',
    estimatedCost: proCost,
    recommendation: proCost > 500
      ? 'Consider Enterprise tier for volume discounts'
      : undefined,
  };
}

Usage Monitoring


class ClickHouseUsageMonitor {
  private requestCount = 0;
  private bytesTransferred = 0;
  private alertThreshold: number;

  constructor(monthlyBudget: number) {
    this.alertThreshold = monthlyBudget * 0.8; // 80% warning
  }

  track(request: { bytes: number }) {
    this.requestCount++;
    this.bytesTransferred += request.bytes;

    if (this.estimatedCost() > this.alertThreshold) {
      this.sendAlert('Approaching ClickHouse budget limit');
    }
  }

  estimatedCost(): number {
    return estimateClickHouseCost(this.requestCount).estimatedCost;
  }

  private sendAlert(message: string) {
    // Send to Slack, email, PagerDuty, etc.
  }
}

Cost Reduction Strategies

Step 1: Request Sampling


function shouldSample(samplingRate = 0.1): boolean {
  return Math.random() < samplingRate;
}

// Use for non-critical telemetry
if (shouldSample(0.1)) { // 10% sample
  await clickhouseClient.trackEvent(event);
}

Step 2: Batching Requests


// Instead of N individual calls
await Promise.all(ids.map(id => clickhouseClient.get(id)));

// Use batch endpoint (1 call)
await clickhouseClient.batchGet(ids);

Step 3: Caching (from P16)

Cache frequently accesse

clickhouse-data-handling SKILL.md View full skill →

Implement ClickHouse PII handling, data retention, and GDPR/CCPA compliance patterns.

ReadWriteEdit

ClickHouse Data Handling

Overview

Handle sensitive data correctly when integrating with ClickHouse.

Prerequisites

Understanding of GDPR/CCPA requirements
ClickHouse SDK with data export capabilities
Database for audit logging
Scheduled job infrastructure for cleanup

Data Classification

Category	Examples	Handling
PII	Email, name, phone	Encrypt, minimize
Sensitive	API keys, tokens	Never log, rotate
Business	Usage metrics	Aggregate when possible
Public	Product names	Standard handling

PII Detection


const PII_PATTERNS = [
  { type: 'email', regex: /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g },
  { type: 'phone', regex: /\b\d{3}[-.]?\d{3}[-.]?\d{4}\b/g },
  { type: 'ssn', regex: /\b\d{3}-\d{2}-\d{4}\b/g },
  { type: 'credit_card', regex: /\b\d{4}[- ]?\d{4}[- ]?\d{4}[- ]?\d{4}\b/g },
];

function detectPII(text: string): { type: string; match: string }[] {
  const findings: { type: string; match: string }[] = [];

  for (const pattern of PII_PATTERNS) {
    const matches = text.matchAll(pattern.regex);
    for (const match of matches) {
      findings.push({ type: pattern.type, match: match[0] });
    }
  }

  return findings;
}

Data Redaction


function redactPII(data: Record<string, any>): Record<string, any> {
  const sensitiveFields = ['email', 'phone', 'ssn', 'password', 'apiKey'];
  const redacted = { ...data };

  for (const field of sensitiveFields) {
    if (redacted[field]) {
      redacted[field] = '[REDACTED]';
    }
  }

  return redacted;
}

// Use in logging
console.log('ClickHouse request:', redactPII(requestData));

Data Retention Policy

Retention Periods

Data Type	Retention	Reason
API logs	30 days	Debugging
Error logs	90 days	Root cause analysis
Audit logs	7 years	Compliance
PII	Until deletion request	GDPR/CCPA

Automatic Cleanup


async function cleanupClickHouseData(retentionDays: number): Promise<void> {
  const cutoff = new Date();
  cutoff.setDate(cutoff.getDate() - retentionDays);

  await db.clickhouseLogs.deleteMany({
    createdAt: { $lt: cutoff },
    type: { $nin: ['audit', 'compliance'] },
  });
}

// Schedule daily cleanup
cron.schedule('0 3 * * *', () => cleanupClic


                
                  
                  
                  clickhouse-debug-bundle
                  SKILL.md
                  View full skill →
                
                
                  Collect ClickHouse debug evidence for support tickets and troubleshooting.
                  
                      ReadBash(grep:*)Bash(curl:*)Bash(tar:*)Grep
                    
                
                
                  ClickHouse Debug Bundle
Overview
Collect all necessary diagnostic information for ClickHouse support tickets.
Prerequisites

ClickHouse SDK installed
Access to application logs
Permission to collect environment info

Instructions
Step 1: Create Debug Bundle Script

#!/bin/bash
# clickhouse-debug-bundle.sh

BUNDLE_DIR="clickhouse-debug-$(date +%Y%m%d-%H%M%S)"
mkdir -p "$BUNDLE_DIR"

echo "=== ClickHouse Debug Bundle ===" > "$BUNDLE_DIR/summary.txt"
echo "Generated: $(date)" >> "$BUNDLE_DIR/summary.txt"

Step 2: Collect Environment Info

# Environment info
echo "--- Environment ---" >> "$BUNDLE_DIR/summary.txt"
node --version >> "$BUNDLE_DIR/summary.txt" 2>&1
npm --version >> "$BUNDLE_DIR/summary.txt" 2>&1
echo "CLICKHOUSE_API_KEY: ${CLICKHOUSE_API_KEY:+[SET]}" >> "$BUNDLE_DIR/summary.txt"

Step 3: Gather SDK and Logs

# SDK version
npm list @clickhouse/sdk 2>/dev/null >> "$BUNDLE_DIR/summary.txt"

# Recent logs (redacted)
grep -i "clickhouse" ~/.npm/_logs/*.log 2>/dev/null | tail -50 >> "$BUNDLE_DIR/logs.txt"

# Configuration (redacted - secrets masked)
echo "--- Config (redacted) ---" >> "$BUNDLE_DIR/summary.txt"
cat .env 2>/dev/null | sed 's/=.*/=***REDACTED***/' >> "$BUNDLE_DIR/config-redacted.txt"

# Network connectivity test
echo "--- Network Test ---" >> "$BUNDLE_DIR/summary.txt"
echo -n "API Health: " >> "$BUNDLE_DIR/summary.txt"
curl -s -o /dev/null -w "%{http_code}" https://api.clickhouse.com/health >> "$BUNDLE_DIR/summary.txt"
echo "" >> "$BUNDLE_DIR/summary.txt"

Step 4: Package Bundle

tar -czf "$BUNDLE_DIR.tar.gz" "$BUNDLE_DIR"
echo "Bundle created: $BUNDLE_DIR.tar.gz"

Output

clickhouse-debug-YYYYMMDD-HHMMSS.tar.gz archive containing:
summary.txt - Environment and SDK info
logs.txt - Recent redacted logs
config-redacted.txt - Configuration (secrets removed)

Error Handling

Item
Purpose
Included


Environment versions
Compatibility check
✓


SDK version
Version-specific bugs
✓


Error logs (redacted)
Root cause analysis
✓


Config (redacted)
Configuration issues
                
              
                
                  
                  
                  clickhouse-deploy-integration
                  SKILL.md
                  View full skill →
                
                
                  Deploy ClickHouse integrations to Vercel, Fly.
                  
                      ReadWriteEditBash(vercel:*)Bash(fly:*)Bash(gcloud:*)
                    
                
                
                  ClickHouse Deploy Integration
Overview
Deploy ClickHouse-powered applications to popular platforms with proper secrets management.
Prerequisites

ClickHouse API keys for production environment
Platform CLI installed (vercel, fly, or gcloud)
Application code ready for deployment
Environment variables documented

Vercel Deployment
Environment Setup

# Add ClickHouse secrets to Vercel
vercel secrets add clickhouse_api_key sk_live_***
vercel secrets add clickhouse_webhook_secret whsec_***

# Link to project
vercel link

# Deploy preview
vercel

# Deploy production
vercel --prod

vercel.json Configuration

{
  "env": {
    "CLICKHOUSE_API_KEY": "@clickhouse_api_key"
  },
  "functions": {
    "api/**/*.ts": {
      "maxDuration": 30
    }
  }
}

Fly.io Deployment
fly.toml

app = "my-clickhouse-app"
primary_region = "iad"

[env]
  NODE_ENV = "production"

[http_service]
  internal_port = 3000
  force_https = true
  auto_stop_machines = true
  auto_start_machines = true

Secrets

# Set ClickHouse secrets
fly secrets set CLICKHOUSE_API_KEY=sk_live_***
fly secrets set CLICKHOUSE_WEBHOOK_SECRET=whsec_***

# Deploy
fly deploy

Google Cloud Run
Dockerfile

FROM node:20-slim
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
CMD ["npm", "start"]

Deploy Script

#!/bin/bash
# deploy-cloud-run.sh

PROJECT_ID="${GOOGLE_CLOUD_PROJECT}"
SERVICE_NAME="clickhouse-service"
REGION="us-central1"

# Build and push image
gcloud builds submit --tag gcr.io/$PROJECT_ID/$SERVICE_NAME

# Deploy to Cloud Run
gcloud run deploy $SERVICE_NAME \
  --image gcr.io/$PROJECT_ID/$SERVICE_NAME \
  --region $REGION \
  --platform managed \
  --allow-unauthenticated \
  --set-secrets=CLICKHOUSE_API_KEY=clickhouse-api-key:latest

Environment Configuration Pattern

// config/clickhouse.ts
interface ClickHouseConfig {
  apiKey: string;
  environment: 'development' | 'staging' | 'production';
  webhookSecret?: string;
}

export function getClickHouseConfig(): ClickHouseConfig {
  const env = process.env.NODE_ENV || 'development';

  return {
    apiKey: process.env.CLICKHOUSE_API_KEY!,
    environment: env as ClickHouseConfig['environment'],
    webhookSecret: process.env.CLICKHOUSE_WEBHOOK_SECRET,
  };
}

Health Check Endpoint

// api/health.ts
export async function GET() {
  const clickhouseS

                

              

                
                  
                  
                  clickhouse-enterprise-rbac
                  SKILL.md
                  View full skill →
                
                
                  Configure ClickHouse enterprise SSO, role-based access control, and organization management.
                  
                      ReadWriteEdit
                    
                
                
                  ClickHouse Enterprise RBAC
Overview
Configure enterprise-grade access control for ClickHouse integrations.
Prerequisites

ClickHouse Enterprise tier subscription
Identity Provider (IdP) with SAML/OIDC support
Understanding of role-based access patterns
Audit logging infrastructure

Role Definitions

Role
Permissions
Use Case


Admin
Full access
Platform administrators


Developer
Read/write, no delete
Active development


Viewer
Read-only
Stakeholders, auditors


Service
API access only
Automated systems


Role Implementation

enum ClickHouseRole {
  Admin = 'admin',
  Developer = 'developer',
  Viewer = 'viewer',
  Service = 'service',
}

interface ClickHousePermissions {
  read: boolean;
  write: boolean;
  delete: boolean;
  admin: boolean;
}

const ROLE_PERMISSIONS: Record<ClickHouseRole, ClickHousePermissions> = {
  admin: { read: true, write: true, delete: true, admin: true },
  developer: { read: true, write: true, delete: false, admin: false },
  viewer: { read: true, write: false, delete: false, admin: false },
  service: { read: true, write: true, delete: false, admin: false },
};

function checkPermission(
  role: ClickHouseRole,
  action: keyof ClickHousePermissions
): boolean {
  return ROLE_PERMISSIONS[role][action];
}

SSO Integration
SAML Configuration

// ClickHouse SAML setup
const samlConfig = {
  entryPoint: 'https://idp.company.com/saml/sso',
  issuer: 'https://clickhouse.com/saml/metadata',
  cert: process.env.SAML_CERT,
  callbackUrl: 'https://app.yourcompany.com/auth/clickhouse/callback',
};

// Map IdP groups to ClickHouse roles
const groupRoleMapping: Record<string, ClickHouseRole> = {
  'Engineering': ClickHouseRole.Developer,
  'Platform-Admins': ClickHouseRole.Admin,
  'Data-Team': ClickHouseRole.Viewer,
};

OAuth2/OIDC Integration

import { OAuth2Client } from '@clickhouse/sdk';

const oauthClient = new OAuth2Client({
  clientId: process.env.CLICKHOUSE_OAUTH_CLIENT_ID!,
  clientSecret: process.env.CLICKHOUSE_OAUTH_CLIENT_SECRET!,
  redirectUri: 'https://app.yourcompany.com/auth/clickhouse/callback',
  scopes: ['read', 'write'],
});

Organization Management

interface ClickHouseOrganization {
  id: string;
  name: string;
  ssoEnabled: boolean;
  enforceSso: boolean;
  allowedDomains: string[];
  defaultRole: ClickHouseRole;
}

async function createOrganization(
  config: C

                

              

                
                  
                  
                  clickhouse-hello-world
                  SKILL.md
                  View full skill →
                
                
                  Create a minimal working ClickHouse example.
                  
                      ReadWriteEdit
                    
                
                
                  ClickHouse Hello World
Overview
Minimal working example demonstrating core ClickHouse functionality.
Prerequisites

Completed clickhouse-install-auth setup
Valid API credentials configured
Development environment ready

Instructions
Step 1: Create Entry File
Create a new file for your hello world example.
Step 2: Import and Initialize Client

import { ClickHouseClient } from '@clickhouse/sdk';

const client = new ClickHouseClient({
  apiKey: process.env.CLICKHOUSE_API_KEY,
});

Step 3: Make Your First API Call

async function main() {
  // Your first API call here
}

main().catch(console.error);

Output

Working code file with ClickHouse client initialization
Successful API response confirming connection
Console output showing:


Success! Your ClickHouse connection is working.

Error Handling

Error
Cause
Solution


Import Error
SDK not installed
Verify with npm list or pip show


Auth Error
Invalid credentials
Check environment variable is set


Timeout
Network issues
Increase timeout or check connectivity


Rate Limit
Too many requests
Wait and retry with exponential backoff


Examples
TypeScript Example

import { ClickHouseClient } from '@clickhouse/sdk';

const client = new ClickHouseClient({
  apiKey: process.env.CLICKHOUSE_API_KEY,
});

async function main() {
  // Your first API call here
}

main().catch(console.error);

Python Example

from clickhouse import ClickHouseClient

client = ClickHouseClient()

# Your first API call here

Resources

ClickHouse Getting Started
ClickHouse API Reference
ClickHouse Examples

Next Steps
Proceed to clickhouse-local-dev-loop for development workflow setup.
                
              

                
                  
                  
                  clickhouse-incident-runbook
                  SKILL.md
                  View full skill →
                
                
                  Execute ClickHouse incident response procedures with triage, mitigation, and postmortem.
                  
                      ReadGrepBash(kubectl:*)Bash(curl:*)
                    
                
                
                  ClickHouse Incident Runbook
Overview
Rapid incident response procedures for ClickHouse-related outages.
Prerequisites

Access to ClickHouse dashboard and status page
kubectl access to production cluster
Prometheus/Grafana access
Communication channels (Slack, PagerDuty)

Severity Levels

Level
Definition
Response Time
Examples


P1
Complete outage
< 15 min
ClickHouse API unreachable


P2
Degraded service
< 1 hour
High latency, partial failures


P3
Minor impact
< 4 hours
Webhook delays, non-critical errors


P4
No user impact
Next business day
Monitoring gaps


Quick Triage

# 1. Check ClickHouse status
curl -s https://status.clickhouse.com | jq

# 2. Check our integration health
curl -s https://api.yourapp.com/health | jq '.services.clickhouse'

# 3. Check error rate (last 5 min)
curl -s localhost:9090/api/v1/query?query=rate(clickhouse_errors_total[5m])

# 4. Recent error logs
kubectl logs -l app=clickhouse-integration --since=5m | grep -i error | tail -20

Decision Tree

ClickHouse API returning errors?
├─ YES: Is status.clickhouse.com showing incident?
│   ├─ YES → Wait for ClickHouse to resolve. Enable fallback.
│   └─ NO → Our integration issue. Check credentials, config.
└─ NO: Is our service healthy?
    ├─ YES → Likely resolved or intermittent. Monitor.
    └─ NO → Our infrastructure issue. Check pods, memory, network.

Immediate Actions by Error Type
401/403 - Authentication

# Verify API key is set
kubectl get secret clickhouse-secrets -o jsonpath='{.data.api-key}' | base64 -d

# Check if key was rotated
# → Verify in ClickHouse dashboard

# Remediation: Update secret and restart pods
kubectl create secret generic clickhouse-secrets --from-literal=api-key=NEW_KEY --dry-run=client -o yaml | kubectl apply -f -
kubectl rollout restart deployment/clickhouse-integration

429 - Rate Limited

# Check rate limit headers
curl -v https://api.clickhouse.com 2>&1 | grep -i rate

# Enable request queuing
kubectl set env deployment/clickhouse-integration RATE_LIMIT_MODE=queue

# Long-term: Contact ClickHouse for limit increase

500/503 - ClickHouse Errors

# Enable graceful degradation
kubectl set env deployment/clickhouse-integration CLICKHOUSE_FALLBACK=true

# Notify users of degraded service
# Update status page

# Monitor ClickHouse status for resolution

Communication Templates
Internal (Slack)

🔴 P1 INC

                

              

                
                  
                  
                  clickhouse-install-auth
                  SKILL.md
                  View full skill →
                
                
                  Install and configure ClickHouse SDK/CLI authentication.
                  
                      ReadWriteEditBash(npm:*)Bash(pip:*)Grep
                    
                
                
                  ClickHouse Install & Auth
Overview
Set up ClickHouse SDK/CLI and configure authentication credentials.
Prerequisites

Node.js 18+ or Python 3.10+
Package manager (npm, pnpm, or pip)
ClickHouse account with API access
API key from ClickHouse dashboard

Instructions
Step 1: Install SDK

# Node.js
npm install @clickhouse/sdk

# Python
pip install clickhouse

Step 2: Configure Authentication

# Set environment variable
export CLICKHOUSE_API_KEY="your-api-key"

# Or create .env file
echo 'CLICKHOUSE_API_KEY=your-api-key' >> .env

Step 3: Verify Connection

// Test connection code here

Output

Installed SDK package in node_modules or site-packages
Environment variable or .env file with API key
Successful connection verification output

Error Handling

Error
Cause
Solution


Invalid API Key
Incorrect or expired key
Verify key in ClickHouse dashboard


Rate Limited
Exceeded quota
Check quota at https://docs.clickhouse.com


Network Error
Firewall blocking
Ensure outbound HTTPS allowed


Module Not Found
Installation failed
Run npm install or pip install again


Examples
TypeScript Setup

import { ClickHouseClient } from '@clickhouse/sdk';

const client = new ClickHouseClient({
  apiKey: process.env.CLICKHOUSE_API_KEY,
});

Python Setup

from clickhouse import ClickHouseClient

client = ClickHouseClient(
    api_key=os.environ.get('CLICKHOUSE_API_KEY')
)

Resources

ClickHouse Documentation
ClickHouse Dashboard
ClickHouse Status

Next Steps
After successful auth, proceed to clickhouse-hello-world for your first API call.
                
              

                
                  
                  
                  clickhouse-local-dev-loop
                  SKILL.md
                  View full skill →
                
                
                  Configure ClickHouse local development with hot reload and testing.
                  
                      ReadWriteEditBash(npm:*)Bash(pnpm:*)Grep
                    
                
                
                  ClickHouse Local Dev Loop
Overview
Set up a fast, reproducible local development workflow for ClickHouse.
Prerequisites

Completed clickhouse-install-auth setup
Node.js 18+ with npm/pnpm
Code editor with TypeScript support
Git for version control

Instructions
Step 1: Create Project Structure

my-clickhouse-project/
├── src/
│   ├── clickhouse/
│   │   ├── client.ts       # ClickHouse client wrapper
│   │   ├── config.ts       # Configuration management
│   │   └── utils.ts        # Helper functions
│   └── index.ts
├── tests/
│   └── clickhouse.test.ts
├── .env.local              # Local secrets (git-ignored)
├── .env.example            # Template for team
└── package.json

Step 2: Configure Environment

# Copy environment template
cp .env.example .env.local

# Install dependencies
npm install

# Start development server
npm run dev

Step 3: Setup Hot Reload

{
  "scripts": {
    "dev": "tsx watch src/index.ts",
    "test": "vitest",
    "test:watch": "vitest --watch"
  }
}

Step 4: Configure Testing

import { describe, it, expect, vi } from 'vitest';
import { ClickHouseClient } from '../src/clickhouse/client';

describe('ClickHouse Client', () => {
  it('should initialize with API key', () => {
    const client = new ClickHouseClient({ apiKey: 'test-key' });
    expect(client).toBeDefined();
  });
});

Output

Working development environment with hot reload
Configured test suite with mocking
Environment variable management
Fast iteration cycle for ClickHouse development

Error Handling

Error
Cause
Solution


Module not found
Missing dependency
Run npm install


Port in use
Another process
Kill process or change port


Env not loaded
Missing .env.local
Copy from .env.example


Test timeout
Slow network
Increase test timeout


Examples
Mock ClickHouse Responses

vi.mock('@clickhouse/sdk', () => ({
  ClickHouseClient: vi.fn().mockImplementation(() => ({
    // Mock methods here
  })),
}));

Debug Mode

# Enable verbose logging
DEBUG=CLICKHOUSE=* npm run dev

Resources

ClickHouse SDK Reference
Vitest Documentation

                
              

                
                  
                  
                  clickhouse-migration-deep-dive
                  SKILL.md
                  View full skill →
                
                
                  Execute ClickHouse major re-architecture and migration strategies with strangler fig pattern.
                  
                      ReadWriteEditBash(npm:*)Bash(node:*)Bash(kubectl:*)
                    
                
                
                  ClickHouse Migration Deep Dive
Overview
Comprehensive guide for migrating to or from ClickHouse, or major version upgrades.
Prerequisites

Current system documentation
ClickHouse SDK installed
Feature flag infrastructure
Rollback strategy tested

Migration Types

Type
Complexity
Duration
Risk


Fresh install
Low
Days
Low


From competitor
Medium
Weeks
Medium


Major version
Medium
Weeks
Medium


Full replatform
High
Months
High


Pre-Migration Assessment
Step 1: Current State Analysis

# Document current implementation
find . -name "*.ts" -o -name "*.py" | xargs grep -l "clickhouse" > clickhouse-files.txt

# Count integration points
wc -l clickhouse-files.txt

# Identify dependencies
npm list | grep clickhouse
pip freeze | grep clickhouse

Step 2: Data Inventory

interface MigrationInventory {
  dataTypes: string[];
  recordCounts: Record<string, number>;
  dependencies: string[];
  integrationPoints: string[];
  customizations: string[];
}

async function assessClickHouseMigration(): Promise<MigrationInventory> {
  return {
    dataTypes: await getDataTypes(),
    recordCounts: await getRecordCounts(),
    dependencies: await analyzeDependencies(),
    integrationPoints: await findIntegrationPoints(),
    customizations: await documentCustomizations(),
  };
}

Migration Strategy: Strangler Fig Pattern

Phase 1: Parallel Run
┌─────────────┐     ┌─────────────┐
│   Old       │     │   New       │
│   System    │ ──▶ │  ClickHouse   │
│   (100%)    │     │   (0%)      │
└─────────────┘     └─────────────┘

Phase 2: Gradual Shift
┌─────────────┐     ┌─────────────┐
│   Old       │     │   New       │
│   (50%)     │ ──▶ │   (50%)     │
└─────────────┘     └─────────────┘

Phase 3: Complete
┌─────────────┐     ┌─────────────┐
│   Old       │     │   New       │
│   (0%)      │ ──▶ │   (100%)    │
└─────────────┘     └─────────────┘

Implementation Plan
Phase 1: Setup (Week 1-2)

# Install ClickHouse SDK
npm install @clickhouse/sdk

# Configure credentials
cp .env.example .env.clickhouse
# Edit with new credentials

# Verify connectivity
node -e "require('@clickhouse/sdk').ping()"

Phase 2: Adapter Layer (Week 3-4)

// src/adapters/clickhouse.ts
interface ServiceAdapter {
  create(data: CreateInput): Promise<Resource>;
  read(id: string): Promise<Resource>;
  update(id: string, dat

                

              

                
                  
                  
                  clickhouse-multi-env-setup
                  SKILL.md
                  View full skill →
                
                
                  Configure ClickHouse across development, staging, and production environments.
                  
                      ReadWriteEditBash(aws:*)Bash(gcloud:*)Bash(vault:*)
                    
                
                
                  ClickHouse Multi-Environment Setup
Overview
Configure ClickHouse across development, staging, and production environments.
Prerequisites

Separate ClickHouse accounts or API keys per environment
Secret management solution (Vault, AWS Secrets Manager, etc.)
CI/CD pipeline with environment variables
Environment detection in application

Environment Strategy

Environment
Purpose
API Keys
Data


Development
Local dev
Test keys
Sandbox


Staging
Pre-prod validation
Staging keys
Test data


Production
Live traffic
Production keys
Real data


Configuration Structure

config/
├── clickhouse/
│   ├── base.json           # Shared config
│   ├── development.json    # Dev overrides
│   ├── staging.json        # Staging overrides
│   └── production.json     # Prod overrides

base.json

{
  "timeout": 30000,
  "retries": 3,
  "cache": {
    "enabled": true,
    "ttlSeconds": 60
  }
}

development.json

{
  "apiKey": "${CLICKHOUSE_API_KEY}",
  "baseUrl": "https://api-sandbox.clickhouse.com",
  "debug": true,
  "cache": {
    "enabled": false
  }
}

staging.json

{
  "apiKey": "${CLICKHOUSE_API_KEY_STAGING}",
  "baseUrl": "https://api-staging.clickhouse.com",
  "debug": false
}

production.json

{
  "apiKey": "${CLICKHOUSE_API_KEY_PROD}",
  "baseUrl": "https://api.clickhouse.com",
  "debug": false,
  "retries": 5
}

Environment Detection

// src/clickhouse/config.ts
import baseConfig from '../../config/clickhouse/base.json';

type Environment = 'development' | 'staging' | 'production';

function detectEnvironment(): Environment {
  const env = process.env.NODE_ENV || 'development';
  const validEnvs: Environment[] = ['development', 'staging', 'production'];
  return validEnvs.includes(env as Environment)
    ? (env as Environment)
    : 'development';
}

export function getClickHouseConfig() {
  const env = detectEnvironment();
  const envConfig = require(`../../config/clickhouse/${env}.json`);

  return {
    ...baseConfig,
    ...envConfig,
    environment: env,
  };
}

Secret Management by Environment
Local Development

# .env.

                

              

                
                  
                  
                  clickhouse-observability
                  SKILL.md
                  View full skill →
                
                
                  Set up comprehensive observability for ClickHouse integrations with metrics, traces, and alerts.
                  
                      ReadWriteEdit
                    
                
                
                  ClickHouse Observability
Overview
Set up comprehensive observability for ClickHouse integrations.
Prerequisites

Prometheus or compatible metrics backend
OpenTelemetry SDK installed
Grafana or similar dashboarding tool
AlertManager configured

Metrics Collection
Key Metrics

Metric
Type
Description


clickhouserequeststotal
Counter
Total API requests


clickhouserequestduration_seconds
Histogram
Request latency


clickhouseerrorstotal
Counter
Error count by type


clickhouseratelimit_remaining
Gauge
Rate limit headroom


Prometheus Metrics

import { Registry, Counter, Histogram, Gauge } from 'prom-client';

const registry = new Registry();

const requestCounter = new Counter({
  name: 'clickhouse_requests_total',
  help: 'Total ClickHouse API requests',
  labelNames: ['method', 'status'],
  registers: [registry],
});

const requestDuration = new Histogram({
  name: 'clickhouse_request_duration_seconds',
  help: 'ClickHouse request duration',
  labelNames: ['method'],
  buckets: [0.05, 0.1, 0.25, 0.5, 1, 2.5, 5],
  registers: [registry],
});

const errorCounter = new Counter({
  name: 'clickhouse_errors_total',
  help: 'ClickHouse errors by type',
  labelNames: ['error_type'],
  registers: [registry],
});

Instrumented Client

async function instrumentedRequest<T>(
  method: string,
  operation: () => Promise<T>
): Promise<T> {
  const timer = requestDuration.startTimer({ method });

  try {
    const result = await operation();
    requestCounter.inc({ method, status: 'success' });
    return result;
  } catch (error: any) {
    requestCounter.inc({ method, status: 'error' });
    errorCounter.inc({ error_type: error.code || 'unknown' });
    throw error;
  } finally {
    timer();
  }
}

Distributed Tracing
OpenTelemetry Setup

import { trace, SpanStatusCode } from '@opentelemetry/api';

const tracer = trace.getTracer('clickhouse-client');

async function tracedClickHouseCall<T>(
  operationName: string,
  operation: () => Promise<T>
): Promise<T> {
  return tracer.startActiveSpan(`clickhouse.${operationName}`, async (span) => {
    try {
      const result = await operation();
      span.setStatus({ code: SpanStatusCode.OK });
      return result;
    } catch (error: any) {
      span.setStatus({ code: SpanStatu

                

              

                
                  
                  
                  clickhouse-performance-tuning
                  SKILL.md
                  View full skill →
                
                
                  Optimize ClickHouse API performance with caching, batching, and connection pooling.
                  
                      ReadWriteEdit
                    
                
                
                  ClickHouse Performance Tuning
Overview
Optimize ClickHouse API performance with caching, batching, and connection pooling.
Prerequisites

ClickHouse SDK installed
Understanding of async patterns
Redis or in-memory cache available (optional)
Performance monitoring in place

Latency Benchmarks

Operation
P50
P95
P99


Read
50ms
150ms
300ms


Write
100ms
250ms
500ms


List
75ms
200ms
400ms


Caching Strategy
Response Caching

import { LRUCache } from 'lru-cache';

const cache = new LRUCache<string, any>({
  max: 1000,
  ttl: 60000, // 1 minute
  updateAgeOnGet: true,
});

async function cachedClickHouseRequest<T>(
  key: string,
  fetcher: () => Promise<T>,
  ttl?: number
): Promise<T> {
  const cached = cache.get(key);
  if (cached) return cached as T;

  const result = await fetcher();
  cache.set(key, result, { ttl });
  return result;
}

Redis Caching (Distributed)

import Redis from 'ioredis';

const redis = new Redis(process.env.REDIS_URL);

async function cachedWithRedis<T>(
  key: string,
  fetcher: () => Promise<T>,
  ttlSeconds = 60
): Promise<T> {
  const cached = await redis.get(key);
  if (cached) return JSON.parse(cached);

  const result = await fetcher();
  await redis.setex(key, ttlSeconds, JSON.stringify(result));
  return result;
}

Request Batching

import DataLoader from 'dataloader';

const clickhouseLoader = new DataLoader<string, any>(
  async (ids) => {
    // Batch fetch from ClickHouse
    const results = await clickhouseClient.batchGet(ids);
    return ids.map(id => results.find(r => r.id === id) || null);
  },
  {
    maxBatchSize: 100,
    batchScheduleFn: callback => setTimeout(callback, 10),
  }
);

// Usage - automatically batched
const [item1, item2, item3] = await Promise.all([
  clickhouseLoader.load('id-1'),
  clickhouseLoader.load('id-2'),
  clickhouseLoader.load('id-3'),
]);

Connection Optimization

import { Agent } from 'https';

// Keep-alive connection pooling
const agent = new Agent({
  keepAlive: true,
  maxSockets: 10,
  maxFreeSockets: 5,
  timeout: 30000,
});

const client = new ClickHouseClient({
  apiKey: process.env.CLICKHOUSE_API_KEY!,
  httpAgent: agent,
});

Pagination Optimization

async function* paginatedClickHouseList<T>(
  fetcher: (cursor?: string) => Promise<{ data: T[]; nextCurso

                

              

                
                  
                  
                  clickhouse-prod-checklist
                  SKILL.md
                  View full skill →
                
                
                  Execute ClickHouse production deployment checklist and rollback procedures.
                  
                      ReadBash(kubectl:*)Bash(curl:*)Grep
                    
                
                
                  ClickHouse Production Checklist
Overview
Complete checklist for deploying ClickHouse integrations to production.
Prerequisites

Staging environment tested and verified
Production API keys available
Deployment pipeline configured
Monitoring and alerting ready

Instructions
Step 1: Pre-Deployment Configuration

[ ] Production API keys in secure vault
[ ] Environment variables set in deployment platform
[ ] API key scopes are minimal (least privilege)
[ ] Webhook endpoints configured with HTTPS
[ ] Webhook secrets stored securely

Step 2: Code Quality Verification

[ ] All tests passing (npm test)
[ ] No hardcoded credentials
[ ] Error handling covers all ClickHouse error types
[ ] Rate limiting/backoff implemented
[ ] Logging is production-appropriate

Step 3: Infrastructure Setup

[ ] Health check endpoint includes ClickHouse connectivity
[ ] Monitoring/alerting configured
[ ] Circuit breaker pattern implemented
[ ] Graceful degradation configured

Step 4: Documentation Requirements

[ ] Incident runbook created
[ ] Key rotation procedure documented
[ ] Rollback procedure documented
[ ] On-call escalation path defined

Step 5: Deploy with Gradual Rollout

# Pre-flight checks
curl -f https://staging.example.com/health
curl -s https://status.clickhouse.com

# Gradual rollout - start with canary (10%)
kubectl apply -f k8s/production.yaml
kubectl set image deployment/clickhouse-integration app=image:new --record
kubectl rollout pause deployment/clickhouse-integration

# Monitor canary traffic for 10 minutes
sleep 600
# Check error rates and latency before continuing

# If healthy, continue rollout to 50%
kubectl rollout resume deployment/clickhouse-integration
kubectl rollout pause deployment/clickhouse-integration
sleep 300

# Complete rollout to 100%
kubectl rollout resume deployment/clickhouse-integration
kubectl rollout status deployment/clickhouse-integration

Output

Deployed ClickHouse integration
Health checks passing
Monitoring active
Rollback procedure documented

Error Handling

Alert
Condition
Severity


API Down
5xx errors > 10/min
P1


High Latency
p99 > 5000ms
P2


Rate Limited
429 errors > 5/min
P2


Auth Failures
401/403 errors > 0
P1


Examples
Health Check Implementation

async function healthCheck(): Promise<{ status:

                

              

                
                  
                  
                  clickhouse-rate-limits
                  SKILL.md
                  View full skill →
                
                
                  Implement ClickHouse rate limiting, backoff, and idempotency patterns.
                  
                      ReadWriteEdit
                    
                
                
                  ClickHouse Rate Limits
Overview
Handle ClickHouse rate limits gracefully with exponential backoff and idempotency.
Prerequisites

ClickHouse SDK installed
Understanding of async/await patterns
Access to rate limit headers

Instructions
Step 1: Understand Rate Limit Tiers

Tier
Requests/min
Requests/day
Burst


Free
60
1,000
10


Pro
300
10,000
50


Enterprise
1,000
100,000
200


Step 2: Implement Exponential Backoff with Jitter

async function withExponentialBackoff<T>(
  operation: () => Promise<T>,
  config = { maxRetries: 5, baseDelayMs: 1000, maxDelayMs: 32000, jitterMs: 500 }
): Promise<T> {
  for (let attempt = 0; attempt <= config.maxRetries; attempt++) {
    try {
      return await operation();
    } catch (error: any) {
      if (attempt === config.maxRetries) throw error;
      const status = error.status || error.response?.status;
      if (status !== 429 && (status < 500 || status >= 600)) throw error;

      // Exponential delay with jitter to prevent thundering herd
      const exponentialDelay = config.baseDelayMs * Math.pow(2, attempt);
      const jitter = Math.random() * config.jitterMs;
      const delay = Math.min(exponentialDelay + jitter, config.maxDelayMs);

      console.log(`Rate limited. Retrying in ${delay.toFixed(0)}ms...`);
      await new Promise(r => setTimeout(r, delay));
    }
  }
  throw new Error('Unreachable');
}

Step 3: Add Idempotency Keys

import { v4 as uuidv4 } from 'uuid';
import crypto from 'crypto';

// Generate deterministic key from operation params (for safe retries)
function generateIdempotencyKey(operation: string, params: Record<string, any>): string {
  const data = JSON.stringify({ operation, params });
  return crypto.createHash('sha256').update(data).digest('hex');
}

async function idempotentRequest<T>(
  client: ClickHouseClient,
  params: Record<string, any>,
  idempotencyKey?: string  // Pass existing key for retries
): Promise<T> {
  // Use provided key (for retries) or generate deterministic key from params
  const key = idempotencyKey || generateIdempotencyKey(params.method || 'POST', params);
  return client.request({
    ...params,
    headers: { 'Idempotency-Key': key, ...params.headers },
  });
}

Output

Reliable API calls with automatic retry
Idempotent requests preventing duplicates
Rate limit headers properly handled

Error Handling

                
                  
                  
                  clickhouse-reference-architecture
                  SKILL.md
                  View full skill →
                
                
                  Implement ClickHouse reference architecture with best-practice project layout.
                  
                      ReadGrep
                    
                
                
                  ClickHouse Reference Architecture
Overview
Production-ready architecture patterns for ClickHouse integrations.
Prerequisites

Understanding of layered architecture
ClickHouse SDK knowledge
TypeScript project setup
Testing framework configured

Project Structure

my-clickhouse-project/
├── src/
│   ├── clickhouse/
│   │   ├── client.ts           # Singleton client wrapper
│   │   ├── config.ts           # Environment configuration
│   │   ├── types.ts            # TypeScript types
│   │   ├── errors.ts           # Custom error classes
│   │   └── handlers/
│   │       ├── webhooks.ts     # Webhook handlers
│   │       └── events.ts       # Event processing
│   ├── services/
│   │   └── clickhouse/
│   │       ├── index.ts        # Service facade
│   │       ├── sync.ts         # Data synchronization
│   │       └── cache.ts        # Caching layer
│   ├── api/
│   │   └── clickhouse/
│   │       └── webhook.ts      # Webhook endpoint
│   └── jobs/
│       └── clickhouse/
│           └── sync.ts         # Background sync job
├── tests/
│   ├── unit/
│   │   └── clickhouse/
│   └── integration/
│       └── clickhouse/
├── config/
│   ├── clickhouse.development.json
│   ├── clickhouse.staging.json
│   └── clickhouse.production.json
└── docs/
    └── clickhouse/
        ├── SETUP.md
        └── RUNBOOK.md

Layer Architecture

┌─────────────────────────────────────────┐
│             API Layer                    │
│   (Controllers, Routes, Webhooks)        │
├─────────────────────────────────────────┤
│           Service Layer                  │
│  (Business Logic, Orchestration)         │
├─────────────────────────────────────────┤
│          ClickHouse Layer        │
│   (Client, Types, Error Handling)        │
├─────────────────────────────────────────┤
│         Infrastructure Layer             │
│    (Cache, Queue, Monitoring)            │
└─────────────────────────────────────────┘

Key Components
Step 1: Client Wrapper

// src/clickhouse/client.ts
export class ClickHouseService {
  private client: ClickHouseClient;
  private cache: Cache;
  private monitor: Monitor;

  constructor(config: ClickHouseConfig) {
    this.client = new ClickHouseClient(config);
    this.cache = new Cache(config.cacheOptions);
    this.monitor = new Monitor('clickhouse');
  }

  async get(id: string): Promise<Resource> {
    return this.cache.getOrFetch(id, () =>
      this.monitor.track('get', () => this.client.get(id))
    );
  }
}

Step 2: Error Boundary

// src/clickhouse/errors.ts
export class ClickHouseServiceError extends Error {
  constructor(
    message: string,
    public readonly code: string,
    public readonly retryable: boolean,
    public readonly originalError?: Error
  ) {
  

                

              

                
                  
                  
                  clickhouse-sdk-patterns
                  SKILL.md
                  View full skill →
                
                
                  Apply production-ready ClickHouse SDK patterns for TypeScript and Python.
                  
                      ReadWriteEdit
                    
                
                
                  ClickHouse SDK Patterns
Overview
Production-ready patterns for ClickHouse SDK usage in TypeScript and Python.
Prerequisites

Completed clickhouse-install-auth setup
Familiarity with async/await patterns
Understanding of error handling best practices

Instructions
Step 1: Implement Singleton Pattern (Recommended)

// src/clickhouse/client.ts
import { ClickHouseClient } from '@clickhouse/sdk';

let instance: ClickHouseClient | null = null;

export function getClickHouseClient(): ClickHouseClient {
  if (!instance) {
    instance = new ClickHouseClient({
      apiKey: process.env.CLICKHOUSE_API_KEY!,
      // Additional options
    });
  }
  return instance;
}

Step 2: Add Error Handling Wrapper

import { ClickHouseError } from '@clickhouse/sdk';

async function safeClickHouseCall<T>(
  operation: () => Promise<T>
): Promise<{ data: T | null; error: Error | null }> {
  try {
    const data = await operation();
    return { data, error: null };
  } catch (err) {
    if (err instanceof ClickHouseError) {
      console.error({
        code: err.code,
        message: err.message,
      });
    }
    return { data: null, error: err as Error };
  }
}

Step 3: Implement Retry Logic

async function withRetry<T>(
  operation: () => Promise<T>,
  maxRetries = 3,
  backoffMs = 1000
): Promise<T> {
  for (let attempt = 1; attempt <= maxRetries; attempt++) {
    try {
      return await operation();
    } catch (err) {
      if (attempt === maxRetries) throw err;
      const delay = backoffMs * Math.pow(2, attempt - 1);
      await new Promise(r => setTimeout(r, delay));
    }
  }
  throw new Error('Unreachable');
}

Output

Type-safe client singleton
Robust error handling with structured logging
Automatic retry with exponential backoff
Runtime validation for API responses

Error Handling

Header
Description

                
              

Pattern
Use Case
Benefit


Safe wrapper
All API calls
Prevents uncaught exceptions


Retry logic
Transient failures
Improves reliability


Type guards
Response validation
Catches API changes


Logging
All operations
Debugging and monitoring


Examples
Factory Pattern (Multi-tenant)

const clients = new Map<string, ClickHouseClient>();

export function getClientForTenant(tenantId: string): ClickHouseClient {
  if (!clients.has(tenantId)) {
    const apiKey = getTenantApiKey(tenantId);
    clients.set(tenantId, n

                

              

                
                  
                  
                  clickhouse-security-basics
                  SKILL.md
                  View full skill →
                
                
                  Apply ClickHouse security best practices for secrets and access control.
                  
                      ReadWriteGrep
                    
                
                
                  ClickHouse Security Basics
Overview
Security best practices for ClickHouse API keys, tokens, and access control.
Prerequisites

ClickHouse SDK installed
Understanding of environment variables
Access to ClickHouse dashboard

Instructions
Step 1: Configure Environment Variables

# .env (NEVER commit to git)
CLICKHOUSE_API_KEY=sk_live_***
CLICKHOUSE_SECRET=***

# .gitignore
.env
.env.local
.env.*.local

Step 2: Implement Secret Rotation

# 1. Generate new key in ClickHouse dashboard
# 2. Update environment variable
export CLICKHOUSE_API_KEY="new_key_here"

# 3. Verify new key works
curl -H "Authorization: Bearer ${CLICKHOUSE_API_KEY}" \
  https://api.clickhouse.com/health

# 4. Revoke old key in dashboard

Step 3: Apply Least Privilege

Environment
Recommended Scopes


Development
read:*


Staging
read:*, write:limited


Production
Only required scopes


Output

Secure API key storage
Environment-specific access controls
Audit logging enabled

Error Handling

Security Issue
Detection
Mitigation


Exposed API key
Git scanning
Rotate immediately


Excessive scopes
Audit logs
Reduce permissions


Missing rotation
Key age check
Schedule rotation


Examples
Service Account Pattern

const clients = {
  reader: new ClickHouseClient({
    apiKey: process.env.CLICKHOUSE_READ_KEY,
  }),
  writer: new ClickHouseClient({
    apiKey: process.env.CLICKHOUSE_WRITE_KEY,
  }),
};

Webhook Signature Verification

import crypto from 'crypto';

function verifyWebhookSignature(
  payload: string, signature: string, secret: string
): boolean {
  const expected = crypto.createHmac('sha256', secret).update(payload).digest('hex');
  return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
}

Security Checklist

[ ] API keys in environment variables
[ ] .env files in .gitignore
[ ] Different keys for dev/staging/prod
[ ] Minimal scopes per environment
[ ] Webhook signatures validated
[ ] Audit logging enabled

Audit Logging

interface AuditEntry {
  timestamp: Date;
  action: string;
  userId: string;
  resource: string;
  result: 'success

                

              

                
                  
                  
                  clickhouse-upgrade-migration
                  SKILL.md
                  View full skill →
                
                
                  Analyze, plan, and execute ClickHouse SDK upgrades with breaking change detection.
                  
                      ReadWriteEditBash(npm:*)Bash(git:*)
                    
                
                
                  ClickHouse Upgrade & Migration
Overview
Guide for upgrading ClickHouse SDK versions and handling breaking changes.
Prerequisites

Current ClickHouse SDK installed
Git for version control
Test suite available
Staging environment

Instructions
Step 1: Check Current Version

npm list @clickhouse/sdk
npm view @clickhouse/sdk version

Step 2: Review Changelog

open https://github.com/clickhouse/sdk/releases

Step 3: Create Upgrade Branch

git checkout -b upgrade/clickhouse-sdk-vX.Y.Z
npm install @clickhouse/sdk@latest
npm test

Step 4: Handle Breaking Changes
Update import statements, configuration, and method signatures as needed.
Output

Updated SDK version
Fixed breaking changes
Passing test suite
Documented rollback procedure

Error Handling

SDK Version
API Version
Node.js
Breaking Changes


3.x
2024-01
18+
Major refactor


2.x
2023-06
16+
Auth changes


1.x
2022-01
14+
Initial release


Examples
Import Changes

// Before (v1.x)
import { Client } from '@clickhouse/sdk';

// After (v2.x)
import { ClickHouseClient } from '@clickhouse/sdk';

Configuration Changes

// Before (v1.x)
const client = new Client({ key: 'xxx' });

// After (v2.x)
const client = new ClickHouseClient({
  apiKey: 'xxx',
});

Rollback Procedure

npm install @clickhouse/sdk@1.x.x --save-exact

Deprecation Handling

// Monitor for deprecation warnings in development
if (process.env.NODE_ENV === 'development') {
  process.on('warning', (warning) => {
    if (warning.name === 'DeprecationWarning') {
      console.warn('[ClickHouse]', warning.message);
      // Log to tracking system for proactive updates
    }
  });
}

// Common deprecation patterns to watch for:
// - Renamed methods: client.oldMethod() -> client.newMethod()
// - Changed parameters: { key: 'x' } -> { apiKey: 'x' }
// - Removed features: Check release notes before upgrading

Resources

ClickHouse Changelog
ClickHouse Migration Guide

Next Steps
For CI integration during upgrades, see clickhouse-ci-integration
                

              

                
                  
                  
                  clickhouse-webhooks-events
                  SKILL.md
                  View full skill →
                
                
                  Implement ClickHouse webhook signature validation and event handling.
                  
                      ReadWriteEditBash(curl:*)
                    
                
                
                  ClickHouse Webhooks & Events
Overview
Securely handle ClickHouse webhooks with signature validation and replay protection.
Prerequisites

ClickHouse webhook secret configured
HTTPS endpoint accessible from internet
Understanding of cryptographic signatures
Redis or database for idempotency (optional)

Webhook Endpoint Setup
Express.js

import express from 'express';
import crypto from 'crypto';

const app = express();

// IMPORTANT: Raw body needed for signature verification
app.post('/webhooks/clickhouse',
  express.raw({ type: 'application/json' }),
  async (req, res) => {
    const signature = req.headers['x-clickhouse-signature'] as string;
    const timestamp = req.headers['x-clickhouse-timestamp'] as string;

    if (!verifyClickHouseSignature(req.body, signature, timestamp)) {
      return res.status(401).json({ error: 'Invalid signature' });
    }

    const event = JSON.parse(req.body.toString());
    await handleClickHouseEvent(event);

    res.status(200).json({ received: true });
  }
);

Signature Verification

function verifyClickHouseSignature(
  payload: Buffer,
  signature: string,
  timestamp: string
): boolean {
  const secret = process.env.CLICKHOUSE_WEBHOOK_SECRET!;

  // Reject old timestamps (replay attack protection)
  const timestampAge = Date.now() - parseInt(timestamp) * 1000;
  if (timestampAge > 300000) { // 5 minutes
    console.error('Webhook timestamp too old');
    return false;
  }

  // Compute expected signature
  const signedPayload = `${timestamp}.${payload.toString()}`;
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(signedPayload)
    .digest('hex');

  // Timing-safe comparison
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expectedSignature)
  );
}

Event Handler Pattern

type ClickHouseEventType = 'resource.created' | 'resource.updated' | 'resource.deleted';

interface ClickHouseEvent {
  id: string;
  type: ClickHouseEventType;
  data: Record<string, any>;
  created: string;
}

const eventHandlers: Record<ClickHouseEventType, (data: any) => Promise<void>> = {
  'resource.created': async (data) => { /* handle */ },
  'resource.updated': async (data) => { /* handle */ },
  'resource.deleted': async (data) => { /* handle */ }
};

async function handleClickHouseEvent(event: ClickHouseEvent): Promise<void> {
  const handler = eventHandlers[event.type];

  if (!handler) {
    console.log(`Unhandled event type: ${event.type}`);
    return;
  }

  try {
    await handler(event.data);
    console.log(`Processed ${event.type}: ${event.id}`);
  } c

                

              

          

        


      
      

      
      

      
      

      
      
  Ready to use clickhouse-pack?
  
    
    
  




      
      
          Related Plugins
          
            
                data-seeder-generator
                Generate realistic test data and database seed scripts for development and testing environments
              
                data-validation-engine
                Database plugin for data-validation-engine
              
                database-archival-system
                Database plugin for database-archival-system
              
                database-audit-logger
                Database plugin for database-audit-logger
              
                database-backup-automator
                Automate database backups with scheduling, compression, encryption, and restore procedures
              
                database-cache-layer
                Database plugin for database-cache-layer
              
          
        

      
      
          Tags
          
            clickhousesaassdkintegration
          
        
    
  

  

    

    
    
        
            
                Stay in the Loop
                
                    
                    
                    
                
                No spam. Unsubscribe anytime.
            

            
                
                    Product
                    
                        Explore
                        Skills
                        Cowork
                        Compare
                        Tools
                    
                
                
                    Resources
                    
                        Changelog
                        Collections
                        Playbooks
                        Research
                        Learning
                    
                
                
                    Company
                    
                        Community
                        Spotlight
                        GitHub
                    
                
                
                    Legal
                    
                        Privacy
                        Terms
                        Acceptable Use
                    
                
            

            
                Tons of Skills by Intent Solutions. Marine. Citadel Grad. 20 years ops → self-taught dev → AI architect.
                © 2026 Tons of Skills | Intent Solutions

Aspect	Workflow A	Workflow B
Use Case	Primary	Secondary
Complexity	Medium	Lower
Performance	Standard	Optimized

clickhouse-pack

Installation

Skills (24)

ClickHouse CI Integration

Overview

Prerequisites

Instructions

Step 1: Create GitHub Actions Workflow

Step 2: Configure Secrets

Step 3: Add Integration Tests

Output

Error Handling

Examples

Release Workflow

Branch Protection

Resources

Next St

ClickHouse Common Errors

Overview

Prerequisites

Instructions

Step 1: Identify the Error

Step 2: Find Matching Error Below

Step 3: Apply Solution

Output

Error Handling

Authentication Failed

Rate Limit Exceeded

Network Timeout

Examples

Quick Diagnostic Commands

Escalation Path

Resources

Next Steps

ClickHouse Core Workflow A

Overview

Prerequisites

Instructions

Step 1: Initialize

Step 2: Execute

Step 3: Finalize

Output

Error Handling

Examples

Complete Workflow

Common Variations

Resources

Next Steps

ClickHouse Core Workflow B

Overview

Prerequisites

Instructions

Step 1: Setup

Step 2: Process

Step 3: Complete

Output

Error Handling

Examples

Complete Workflow

Error Recovery

Resources

Next Steps

ClickHouse Cost Tuning

Overview

Prerequisites

Pricing Tiers

Cost Estimation

Usage Monitoring

Cost Reduction Strategies

Step 1: Request Sampling

Step 2: Batching Requests

Step 3: Caching (from P16)

ClickHouse Data Handling

Overview

Prerequisites

Data Classification

PII Detection

Data Redaction

Data Retention Policy

Retention Periods