skilld
All skills
clickhouse avatar

/clickhouse-js-node-troubleshooting

@faa5b11 official
by clickhouseclickhouse/agent-skills543 stars
39

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 like "my inserts keep failing" or "connection drops randomly" in a Node.js context are strong signals to use this skill. Do NOT use for browser/Web client issues.

Ask your Agent

Use this Skill: https://skilld.dev/gh/clickhouse/agent-skills/clickhouse-js-node-troubleshooting

This session only. Nothing lands on disk.

SKILL.md

≈175 tokens always: the name and description. ≈1.1k when used: this file. ≈7.2k more on demand in 9 files.

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.

Issue Symptoms Reference file
Socket Hang-Up / ECONNRESET socket hang up, ECONNRESET, intermittent connection drops, long-running queries timing out reference/socket-hangup.md
Data Type Mismatches Large integers returned as strings, decimal precision loss, Date/DateTime insertion failures, CANNOT_PARSE_INPUT_ASSERTION_FAILED inserting a UUID into a UInt128 column reference/data-types.md
Read-Only User Errors Errors when using response compression with readonly=1 users reference/readonly-users.md
Proxy / Pathname URL Confusion Wrong database selected, requests failing behind a proxy with a path prefix reference/proxy-pathname.md
TLS / Certificate Errors TLS handshake failures, certificate verification issues, mutual TLS setup reference/tls.md
Compression Not Working GZIP compression not activating for requests or responses reference/compression.md
Logging Not Showing Anything No log output, need custom logger integration reference/logging.md
Query Parameters Not Interpolated Parameterized queries not working, SQL injection concerns reference/query-params.md
FORMAT Clause / SHOW POLICIES Errors Syntax error from a duplicate FORMAT, or SHOW [ROW] POLICIES failing even with a format provided reference/query-format-clause.md

Still Stuck?

Source: SKILL.md on GitHub

Third-party checks

No alerts17d3 checks · Risk SAFE
  • Gen Agent Trust Hub17d

    This skill provides comprehensive troubleshooting documentation for the ClickHouse Node.js client. It includes security best practices, such as using parameterized queries to prevent SQL injection and clear warnings against insecure TLS configurations in production environments. No malicious patterns or security risks were detected.

  • Socket17d

    No alerts

  • Snyk17d

    Risk: LOW · No issues

Provenance

Signed by skilld at faa5b11. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 days ago.

Activeupdated 3 months ago

Topics

  • clickhouse
  • nodejs
  • troubleshooting
  • client
  • socket
  • tls
  • compression
  • data-types
  • connection

README badge

README badge for clickhouse/agent-skills/clickhouse-js-node-troubleshooting

What it does

Diagnose and resolve common issues with the ClickHouse Node.js client (@clickhouse/client), including socket hang-ups, data type mismatches, TLS configuration problems, compression failures, and read-only user restrictions. Applies only to Node.js runtime environments, not browser or edge runtimes.

Generated from the current SKILL.md.

Frequently asked

Does this skill work with the browser/Web client or just Node.js?
This skill covers only the Node.js runtime (@clickhouse/client), including Next.js Node API routes and Server Actions. For browser, Edge runtime, Cloudflare Workers, or Web Worker environments, use @clickhouse/client-web instead.
What kinds of errors does this skill help troubleshoot?
Socket hang-ups, ECONNRESET, data type mismatches, read-only user restrictions, proxy/TLS setup, compression issues, query timeouts, and query parameter interpolation problems with the ClickHouse Node.js client.
Do I need to know the exact error message to use this skill?
No. Vague symptoms like 'my inserts keep failing' or 'connection drops randomly' in a Node.js context are strong enough signals to trigger this skill.
Will this skill help with version compatibility issues?
Yes. The skill flags if a fix requires a minimum client version and will ask for your version if it's needed to recommend the right solution.

Generated from the current SKILL.md. These answers refresh after source changes.