agentleFS
TeddyAlbinaTeddyAlbina/skills/clickhouse-architecture-advisor/AGENTS.md

skills / clickhouse-architecture-advisor

AGENTS.md2 starsChanged 28 days agoMITView on GitHub

Version 0.1.0 ClickHouse Inc April 2026 ClickHouse 24.1+ This skill complements clickhouse-best-practices by adding a workload-aware architecture layer for ClickHouse. It is optimized for advisory, workshop, and system design workflows where a user needs more than a rule check. It provides decision frameworks for ingestion strategy, time-series partitioning, enrichment paths, late-arriving data, and real-time pre-aggregation. Official documentation is the source of truth. Every recommendation must be labeled as: A valid architecture response should include: - workload summary - key decisions…

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use when deciding between:

    line 23
  2. Distinctive:

    Use when reasoning about:

    line 44

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

ClickHouse Architecture Advisor

Version 0.1.0
ClickHouse Inc
April 2026
ClickHouse 24.1+

Abstract

This skill complements clickhouse-best-practices by adding a workload-aware architecture layer for ClickHouse. It is optimized for advisory, workshop, and system design workflows where a user needs more than a rule check. It provides decision frameworks for ingestion strategy, time-series partitioning, enrichment paths, late-arriving data, and real-time pre-aggregation.

Core principle

Official documentation is the source of truth. Every recommendation must be labeled as:

  • official
  • derived
  • field

Decision areas

1. Ingestion strategy

Use when deciding between:

  • direct inserts
  • async inserts
  • Kafka engine + MV
  • upstream buffering

2. Time-series partitioning

Use when deciding:

  • whether to partition
  • partition granularity
  • how retention and TTL affect design
  • how to avoid excessive partition counts

3. Enrichment path selection

Use when deciding between:

  • runtime JOINs
  • dictionaries
  • denormalization
  • materialized enrichment

4. Late-arriving data and mutable state

Use when reasoning about:

  • immutable append-only events
  • latest-state queries
  • replacing or collapsing semantics
  • whether frequent mutations should be avoided

5. Real-time pre-aggregation

Use when deciding:

  • raw-only design
  • incremental materialized views
  • refreshable MVs
  • rollup tables

Output standard

A valid architecture response should include:

  • workload summary
  • key decisions
  • recommendations with provenance labels
  • suggested target architecture
  • example DDL or SQL
  • validation approach

Required recommendation schema

See schemas/recommendation_schema.yaml.

Rule index

  1. decision-ingestion-strategy
  2. decision-partitioning-timeseries
  3. decision-join-enrichment
  4. decision-late-arriving-upserts
  5. decision-real-time-preaggregation

Implementation notes

This skill is intentionally narrow:

  • it does not replace low-level rule enforcement
  • it does not make commercial recommendations
  • it does not claim field heuristics are official policy

Its purpose is to translate documented ClickHouse capabilities into workload-specific architecture decisions.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.