clickhouse-js-node-troubleshooting
clickhouse/agent-skills
Troubleshoot and resolve common issues with the ClickHouse Node.js client (@clickhouse/client).
What is clickhouse-js-node-troubleshooting?
This skill diagnoses and fixes problems specific to the ClickHouse Node.js client (@clickhouse/client) running in Node.js environments. Use it when encountering socket errors, connection drops, data type mismatches, TLS issues, compression problems, or other client-specific failures—including in Next.js Node runtime, React Server Components, and standard Node processes.
- Diagnose socket hang-up, ECONNRESET, and connection timeout issues
- Resolve data type mismatches (large integers as strings, decimal precision, UUID insertion)
- Fix read-only user errors with response compression
- Troubleshoot proxy and pathname URL configuration problems
- Debug TLS/certificate handshake and mutual TLS setup
- Enable and verify GZIP compression for requests and responses
How to install clickhouse-js-node-troubleshooting
npx skills add https://github.com/clickhouse/agent-skills --skill clickhouse-js-node-troubleshooting- @clickhouse/client package installed in a Node.js runtime (not browser or Edge runtime)
- Access to ClickHouse server logs and client error messages
- Knowledge of your ClickHouse server configuration (TLS, compression, user permissions)
How to use clickhouse-js-node-troubleshooting
- 1.Identify your symptom in the Issue Index (socket errors, data type problems, TLS issues, etc.)
- 2.Read the corresponding reference file for detailed diagnosis and steps
- 3.Check if the fix requires a minimum client version; ask the user for their version if needed
- 4.Apply the recommended configuration or code changes
- 5.Test the fix with a simple query or operation to verify resolution
Use cases
- Fixing intermittent connection drops or socket hang-up errors in production Node.js services
- Resolving data insertion failures when types don't match expected formats
- Debugging TLS certificate verification failures in secure ClickHouse connections
- Enabling compression for large query responses to reduce bandwidth
- Configuring ClickHouse client behind a proxy with path prefixes
- Node.js backend developers
- Next.js API route and Server Component developers
- DevOps engineers troubleshooting ClickHouse client connectivity
- Full-stack developers integrating ClickHouse into Node.js applications
clickhouse-js-node-troubleshooting FAQ
No. This skill covers @clickhouse/client in Node.js runtime only. For browser, Web Workers, Next.js Edge runtime, or Cloudflare Workers, use @clickhouse/client-web instead.
Check the ClickHouse JS client source code and examples at https://github.com/ClickHouse/clickhouse-js/tree/main/examples, or consult the official ClickHouse JavaScript integration docs.
Run `npm list @clickhouse/client` in your project directory to see the installed version. Some fixes are version-dependent, so this may be needed for troubleshooting.
No. This skill is for Node.js runtime only. For browser, Next.js Edge runtime, or Cloudflare Workers, use @clickhouse/client-web and consult its documentation.
Check your ClickHouse server configuration (TLS certificates, compression settings, user permissions), verify network connectivity, and review server logs for corresponding errors.
Full instructions (SKILL.md)
Source of truth, from clickhouse/agent-skills.
name: clickhouse-js-node-troubleshooting description: > 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.
ClickHouse Node.js Client Troubleshooting
Reference: https://clickhouse.com/docs/integrations/javascript
⚠️ Node.js runtime only. This skill covers the
@clickhouse/clientpackage 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
- Identify the issue — match symptoms to the Issue Index below and read the corresponding reference file.
- Lead with the diagnosis — explain what's likely causing the issue before giving the fix.
- Note version constraints — flag if a fix requires a minimum client version and check it against what the user provided.
- 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?
Related skills
More from clickhouse/agent-skills and the wider catalog.
clickhouse-managed-postgres-rca
Root-cause analysis for ClickHouse-managed Postgres performance issues using Prometheus metrics and slow query patterns.
clickhousectl-cloud-deploy
Deploy ClickHouse to the cloud and manage production instances with clickhousectl.
clickhousectl-local-dev
Set up a local ClickHouse development environment with tables and sample data in minutes.
clickstack-otel-collector
Wire an OpenTelemetry collector into Managed ClickStack on ClickHouse Cloud and verify telemetry ingestion.
infra-clickhouse
Set up and manage ClickHouse locally for development or deploy to ClickHouse Cloud for production.
infra-postgres
Set up and manage Postgres locally or in ClickHouse Cloud using clickhousectl.