Skip to content

Clarify Cloud UDF dependency handling and version updates#6410

Merged
Blargian merged 2 commits into
mainfrom
doc-udf-cloud-crosslink
Jun 22, 2026
Merged

Clarify Cloud UDF dependency handling and version updates#6410
Blargian merged 2 commits into
mainfrom
doc-udf-cloud-crosslink

Conversation

@dhtclk

@dhtclk dhtclk commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Closes DOC-833.

Adds two clarifications to the Cloud UDF guide based on user feedback in Slack (testing in staging):

  • Dependency handlingrequirements.txt is the recommended way to install Python dependencies, which ClickHouse Cloud prepares for you. Bundling dependencies directly in the ZIP is possible but requires cached packages for both CPU architectures.
  • Edit vs. new version — the Edit panel only manages which services a UDF is assigned to; changing a UDF's code requires creating a new version. (A user got stuck here because the "Save changes" button stays inactive when re-uploading code in Edit.)

The reference ↔ Cloud cross-link and the stale preview-badge fix are handled separately in ClickHouse/ClickHouse#107748, since the reference page is synced from that repo.

The deterministic behavior and network-access flag are intentionally not documented yet — both have open questions with eng (tracked in DOC-833).

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes to the Cloud UDF guide with no product or runtime behavior changes.

Overview
Updates the ClickHouse Cloud user-defined functions guide with two clarifications from staging feedback.

The Python dependencies section now states that requirements.txt is the recommended path because Cloud installs packages for you, and that bundling wheels in the ZIP requires cached packages for both CPU architectures, making requirements.txt simpler.

The Create a new version section adds a note that Edit only changes service assignment—re-uploading code there does not update deployed UDF code; code changes require Create new version.

Reviewed by Cursor Bugbot for commit 2b89904. Bugbot is set up for automated code reviews on this repo. Configure here.

Add two notes to the Cloud UDF guide based on user feedback in Slack:
- requirements.txt is the recommended way to install Python dependencies;
  bundling directly in the ZIP requires cached packages for both CPU
  architectures
- the Edit panel only manages service assignment; changing a UDF's code
  requires creating a new version

Refs DOC-833

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dhtclk dhtclk requested a review from a team as a code owner June 17, 2026 15:28
@vercel

vercel Bot commented Jun 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment Jun 17, 2026 3:56pm
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored Jun 17, 2026 3:56pm
clickhouse-docs-ko Ignored Ignored Preview Jun 17, 2026 3:56pm
clickhouse-docs-ru Ignored Ignored Preview Jun 17, 2026 3:56pm
clickhouse-docs-zh Ignored Ignored Preview Jun 17, 2026 3:56pm

Request Review

Reduce admonition pile-up on the page: the dependency-handling and
"Edit vs. create new version" guidance read better as body text and were
crowding the genuine caveats. Convert both from :::note callouts to
prose, leaving only the warranted admonitions.

Refs DOC-833

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Blargian Blargian merged commit 86aee3a into main Jun 22, 2026
18 checks passed
@mintlify

mintlify Bot commented Jun 22, 2026

Copy link
Copy Markdown

Docs PR opened: ClickHouse/mintlify-docs-dev#239

Clarified that ClickHouse Cloud auto-installs Python UDF dependencies from requirements.txt and that the Edit panel doesn't replace deployed code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants