docs: add WORKER documentation for PR #19383#3083
Conversation
- Add comprehensive ROWS BETWEEN documentation with examples - Update window functions index to include window frame section - Include common patterns: running totals, moving averages, centered windows - Add best practices and limitations sections Addresses missing documentation for window frame specification in Databend.
- Add detailed explanation of window frame behavior at partition boundaries - Include examples showing how windows shrink at edges - Address common confusion about window size at start/end of partitions
- Add missing RANGE BETWEEN documentation (range-between.md) - Fix broken cross-reference in rows-between.md - Update index.md with proper links to both ROWS and RANGE documentation - Resolve P2 issue: Remove broken RANGE BETWEEN cross-reference by adding the missing file
- Clarify distinction between syntax examples and complete SQL statements - Add 'Complete example' sections with executable SQL - Mark syntax examples clearly as patterns (not complete statements) - Update index.md with validation note - All complete SQL examples verified with Databend MCP - Improve documentation clarity and usability
- Use CREATE OR REPLACE TABLE for self-hosted deployments - Add WITH clause examples for Databend Cloud compatibility - Ensure all SQL examples can run in restricted environments - Provide both options with clear explanations - Maintain result consistency with MCP validation
Add comprehensive documentation for the new WORKER feature introduced in PR #19383: - Created new directory: docs/en/sql-reference/10-sql-commands/00-ddl/20-worker/ - Added index.md with overview of WORKER functionality - Added create-worker.md with CREATE WORKER syntax and examples - Added show-workers.md with SHOW WORKERS syntax and output format - Added alter-worker.md with ALTER WORKER syntax for SET/UNSET options, tags, and state management - Added drop-worker.md with DROP WORKER syntax and behavior - Added examples.md with comprehensive usage examples and best practices - Updated DDL index page to include WORKER in Resource Management section - Updated UDF documentation to reference WORKER management - Added _category_.json for sidebar navigation The WORKER feature manages UDF execution environments in Databend Cloud sandbox, providing full lifecycle control over compute resources for user-defined functions.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Resolved conflicts in window function documentation files: - docs/en/sql-reference/20-sql-functions/08-window-functions/range-between.md - docs/en/sql-reference/20-sql-functions/08-window-functions/rows-between.md Conflicts were due to both branches adding the same files. Kept the main branch version of relative links while preserving content.
💡 Codex Review Terminate SQL code block before Worker Management section
The JavaScript UDF example is not closed before this heading, so the entire “Worker Management for UDFs” content is rendered as part of a SQL code block instead of documentation. That hides headings from navigation/search and turns explanatory links into plain text, which breaks this section for readers.  Point worker related links to existing guide pages
These related-topic links target paths under Reference a defined table in RANGE BETWEEN complete example
This “Complete example” queries ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback". |
1. Close JavaScript code block in ddl-create-function.md 2. Update broken links in worker examples.md 3. Fix undefined table reference in range-between.md
|
This feature is not yet fully supported in Databend Cloud. Please wait for @everpcpc 's update. |
2 participants
Summary
This PR adds comprehensive documentation for the new WORKER feature introduced in databend PR #19383.
Changes
New Documentation
Documentation Updates
Context
The WORKER feature (PR #19383: 'feat: add sandbox env injection case via cloud control') introduces management of UDF execution environments in Databend Cloud sandbox. Each UDF has an associated WORKER that manages its compute resources, providing full lifecycle control.
Key Features Documented
Testing
Documentation is based on:
Related Issues
Closes: # (if applicable)
Related to: databend PR #19383