Docs: guide for building alternative-runtime/protocol clients#788
Open
Copilot wants to merge 1 commit into
Open
Docs: guide for building alternative-runtime/protocol clients#788Copilot wants to merge 1 commit into
Copilot wants to merge 1 commit into
Conversation
Copilot created this pull request from a session on behalf of
peter-leonov-ch
June 1, 2026 07:30
View session
|
|
| runtimes (Cloudflare Workers, Vercel Edge, Deno Deploy, browser | ||
| extensions, etc.). | ||
| 2. Edit that package in place until you have something working end-to-end for | ||
| your target runtime/protocol. Run the existing tests against it, adjust |
Collaborator
There was a problem hiding this comment.
Suggested change
| your target runtime/protocol. Run the existing tests against it, adjust | |
| your target runtime/protocol. Run the existing tests (where applicable) against it, adjust |
peter-leonov-ch
approved these changes
Jun 1, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation to guide contributors who want to create specialized ClickHouse JS clients for alternative runtimes (e.g., Bun, Cloudflare Workers) and/or alternative protocols, and links that guide from the main README.
Changes:
- Added a new root doc (
ALTERNATIVE_CLIENTS.md) describing a recommended workflow for building and contributing alternative-runtime/protocol clients. - Updated
README.mdto link to the new guide from the Contributing section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds a link to the new alternative clients guide from the Contributing section. |
| ALTERNATIVE_CLIENTS.md | Introduces a contributor-facing guide for building/porting specialized clients and submitting them upstream. |
Comment on lines
+29
to
+42
| That package is being **deprecated**. The motivation is to simplify versioning | ||
| across our packages and to avoid bundling/duplication issues that several | ||
| downstream users have hit. | ||
|
|
||
| What this means in practice: | ||
|
|
||
| - The shared code is **not** being moved into a new shared package; there is | ||
| no replacement package to depend on. | ||
| - Instead, the shared code is being inlined / co-located inside each runtime | ||
| package (`packages/client-node`, `packages/client-web`, …). Going forward | ||
| each runtime package is self-contained. | ||
| - If you are building a new client, you should not try to depend on a shared | ||
| package either — copy the pieces you need into your own package, the same | ||
| way `client-node` and `client-web` do. |
| - [ ] There is an issue / discussion describing the motivation and design. | ||
| - [ ] The new package lives under `packages/<your-client>` and has its own | ||
| `package.json` with a unique `name`. | ||
| - [ ] No dependency on `@clickhouse/client-common` (it is deprecated). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
ALTERNATIVE_CLIENTS.mdto encourage and streamline third-party clients for other runtimes (Bun, Cloudflare Workers, …) and protocols (native TCP, gRPC-over-proxy, …) now that@clickhouse/client-commonis being deprecated and there is no replacement shared package.ALTERNATIVE_CLIENTS.md(root) covering:@clickhouse/client-commonis going away (versioning + bundling pain) and that shared code is being inlined into each runtime package rather than relocated to a new shared folder/package — new clients should copy what they need, not depend on a shared package.packages/client-nodeorpackages/client-webin place (whichever is closest to the target runtime), iterate until it works, then rename the directory to e.g.packages/my-native-client, updatepackage.json#name, and open a PR.client-commondep, history preserved, tests, build/lint pass).README.md: link the new doc from the Contributing section.Checklist