mcpField
C
clickhouse-js-node-troubleshooting

clickhouse-js-node-troubleshooting

github.com/clickhouseData & databases33082 installsUpdated today
Repository

About clickhouse-js-node-troubleshooting

A troubleshooting reference for developers using the @clickhouse/client package in Node.js runtimes. It maps common symptoms to focused guides and flags runtime and version constraints.

Key features

  1. 01Issue index with symptom mapping
  2. 02Guides for connection and TLS errors
  3. 03Data type and query parameter guidance
  4. 04Proxy, compression, and logging topics
  5. 05Node.js runtime scope guidance

Use cases

  1. 01Diagnose intermittent connection failures
  2. 02Resolve type conversion or insertion errors
  3. 03Investigate query parameter behavior
  4. 04Check TLS, proxy, or compression setup

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/clickhouse/clickhouse-js --skill clickhouse-js-node-troubleshooting

After installing, type/clickhouse-js-node-troubleshootingin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

reference/
compression.md
data-types.md
logging.md
proxy-pathname.md
query-format-clause.md
query-params.md
readonly-users.md
socket-hangup.md
tls.md

Details

From the project README

ClickHouse Node.js Client Troubleshooting

Reference: https://clickhouse.com/docs/integrations/javascript

⚠️ Node.js runtime only. This skill covers the @clickhouse/client package running in a Node.js runtime exclusively — including Next.js Node runtime API routes, React Server Components, Server Actions, and standard Node.js processes. Do not apply this skill to browser client components, Web Workers, Next.js Edge runtime, Cloudflare Workers, or any usage of @clickhouse/client-web. For browser/edge environments, the correct package is @clickhouse/client-web.

How to Use This Skill

  1. Identify the issue — match symptoms to the Issue Index below and read the corresponding reference file.
  2. Lead with the diagnosis — explain what's likely causing the issue before giving the fix.
  3. Note version constraints — flag if a fix requires a minimum client version and check it against what the user provided.
  4. Ask only what's missing — if the fix is version-dependent and you don't know their version, ask; otherwise help immediately.

Issue Index

Identify the user's issue from the list below and read the corresponding reference file for detailed troubleshooting steps.

IssueSymptomsReference file
Socket Hang-Up / ECONNRESETsocket hang up, ECONNRESET, intermittent connection drops, long-running queries timing outreference/socket-hangup.md
Data Type MismatchesLarge integers returned as strings, decimal precision loss, Date/DateTime insertion failures, CANNOT_PARSE_INPUT_ASSERTION_FAILED inserting a UUID into a UInt128 columnreference/data-types.md
Read-Only User ErrorsErrors when using response compression with readonly=1 usersreference/readonly-users.md
Proxy / Pathname URL ConfusionWrong database selected, requests failing behind a proxy with a path prefixreference/proxy-pathname.md
TLS / Certificate ErrorsTLS handshake failures, certificate verification issues, mutual TLS setupreference/tls.md
Compression Not WorkingGZIP compression not activating for requests or responsesreference/compression.md
Logging Not Showing AnythingNo log output, need custom logger integrationreference/logging.md
Query Parameters Not InterpolatedParameterized queries not working, SQL injection concernsreference/query-params.md
FORMAT Clause / SHOW POLICIES ErrorsSyntax error from a duplicate FORMAT, or SHOW [ROW] POLICIES failing even with a format providedreference/query-format-clause.md

Still Stuck?

Comments

Markdown supported