clickhouse/agent-skills

clickhouse-architecture-advisor

MUST USE when designing ClickHouse architectures, selecting between ingestion or modeling patterns, or translating best practices into workload-specific system designs.

Vedi sorgente

Come usare

  1. Copia il comando e controlla il pacchetto prima di installarlo nel tuo ambiente agente.
  2. Controlla strumenti, credenziali e ambienti richiesti nel documento originale.
  3. Descrivi input e risultato desiderato; confronta l’output con le fonti.
npx skills add https://github.com/clickhouse/agent-skills --skill clickhouse-architecture-advisor

Prima di iniziare

  • L’installazione non include abbonamenti, quote API o accesso ai file.
  • Stelle e installazioni indicano attività, non un test indipendente di qualità o sicurezza.
Documento Skill originale

Contenuto dal repository con titoli, esempi, codice, tabelle, link e immagini preservati.

ClickHouse Architecture Advisor

This skill adds workload-aware architecture decisioning on top of clickhouse-best-practices.

Official docs remain the source of truth. This skill must always prefer official ClickHouse documentation when available.

Required behavior

Before producing recommendations:

  1. Identify the workload shape
  • observability
  • security / SIEM
  • product analytics
  • IoT / telemetry
  • market data / financial services
  • mixed OLAP with point-lookups
  1. Read the relevant decision rule files in rules/
  2. Use mappings/doc_links.yaml to attach official documentation
  3. Classify every recommendation as:
  • official
  • derived
  • field
  1. Never present field guidance as official guidance
  2. If a recommendation is uncertain, say so explicitly

Provenance rules

official

Use this when the recommendation is directly backed by official docs.

derived

Use this when the recommendation is not stated verbatim in docs but follows logically from documented ClickHouse behavior.

field

Use this only for experience-based guidance that may be situational. When using field, include:

  • a disclaimer that the advice is heuristic
  • a relevant official doc if one partially applies
  • the reason the advice depends on workload context

Read these rule files by scenario

Real-time ingestion design

  1. rules/decision-ingestion-strategy.md
  2. rules/decision-real-time-preaggregation.md
  3. Relevant best-practices insert rules

Time-series and retention design

  1. rules/decision-partitioning-timeseries.md
  2. Relevant best-practices schema partition rules

Enrichment and dimension lookups

  1. rules/decision-join-enrichment.md
  2. Relevant best-practices query join rules

Mutable state / late-arriving events

  1. rules/decision-late-arriving-upserts.md
  2. Relevant best-practices mutation avoidance rules

Output format

Structure responses like this:

markdown
## Workload Summary
- workload:
- latency target:
- data shape:
- primary query patterns:
- operational constraints:

## Key Decisions
- ...
- ...

## Recommendations

### <Recommendation title>

**What**
...

**Why**
...

**How**
...

**Category**
official | derived | field

**Confidence**
high | medium | heuristic

**Source**
- doc link(s)

**Validation**
- concrete SQL, metric, or smoke test

Architecture-specific guidance

Prefer decision frameworks over generic advice. Good responses should:

  • explain tradeoffs
  • identify the likely operating bottleneck
  • separate immediate actions from structural redesign
  • provide target architecture patterns, not just isolated settings

Full reference

See AGENTS.md for the compiled version and examples/ for sample outputs.

Correlati per attività

dallo stesso repository

Altri Skills

Tutti gli Skills
clickhouse
Ufficiale

chdb-datastore

Use when the user has tabular data (pandas DataFrame, parquet, csv, Arrow, json) and wants to filter, group, aggregate, join, or speed up slow pandas. Provides chDB DataStore — same pandas API, ClickHouse engine underneath. Also handles reading from S3, MySQL, PostgreSQL, MongoDB, ClickHouse Cloud, Iceberg, Delta Lake as DataFrames and joining across sources. TRIGGER when: user mentions DataFrame, parquet, csv, "fast pandas", "speed up pandas", or cross-source DataFrame joins; user imports chdb.

Installazioni / 1h
4
GitHub Stars
564
Aggiornato
2 nov
clickhouse
Ufficiale

clickhouse-js-node-coding

Write idiomatic application code with the ClickHouse Node.js client (@clickhouse/client). Use this skill whenever a user is building against the Node.js client — configuring the client, pinging, inserting rows in JSON or raw formats, selecting and parsing results, binding query parameters, managing sessions and temporary tables, working with data types or customizing JSON parsing. Do NOT use for browser/Web client code.

Installazioni / 1h
4
GitHub Stars
564
Aggiornato
2 nov
clickhouse
Ufficiale

clickhouse-js-node-rowbinary

Generate TypeScript/JavaScript code that reads/decodes AND writes/encodes ClickHouse RowBinary streams for the ClickHouse HTTP server. Use this skill whenever a user wants to parse or produce RowBinary, RowBinaryWithNames, or RowBinaryWithNamesAndTypes. Node.js only, doesn't cover browsers.

Installazioni / 1h
4
GitHub Stars
564
Aggiornato
2 nov
clickhouse
Ufficiale

clickhouse-js-node-troubleshooting

Troubleshoot and resolve common issues with the ClickHouse Node.js client (@clickhouse/client). Use this skill whenever a user reports errors, unexpected behavior, or configuration questions involving the Node.js client specifically — including socket hang-up errors, Keep-Alive problems, stream handling issues, data type mismatches, read-only user restrictions, proxy/TLS setup problems, or long-running query timeouts. Trigger even when the user hasn't precisely named the issue; vague symptoms li

Installazioni / 1h
4
GitHub Stars
564
Aggiornato
2 nov