-
Notifications
You must be signed in to change notification settings - Fork 15
Closed as not planned
Closed as not planned
Copy link
Labels
bugSomething isn't workingSomething isn't workingdocs-agentdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Context
- Slack transcript (2026-02-17):
[2026-02-17T00:00:00.000Z] <@U123TEST>: /docs smoke test please file an issue for improving CREATE SUBSCRIPTION docs and include marker [jarvis-v2-smoke-2026-02-17] - Smoke marker:
[jarvis-v2-smoke-2026-02-17] - Related docs references from context search:
serve/subscription.mdxsql/commands/sql-alter-subscription.mdxsql/commands/sql-show-subscription-cursors.mdxsql/commands/sql-show-subscriptions.mdx
- Related code/test references from context search:
e2e_test/ddl/subscription.sltsrc/sqlparser/src/ast/statement.rs
Problem
The docs currently lack a clear, command-level reference for CREATE SUBSCRIPTION in the SQL command docs. Subscription information exists, but users looking for a canonical SQL syntax page can miss key details (full syntax, options, behavior notes, and runnable examples).
Suggested Fix
- Add a dedicated SQL command reference page for
CREATE SUBSCRIPTION(for example,sql/commands/sql-create-subscription.mdx). - Include complete syntax, parameter definitions, and behavior notes (startup position/initial snapshot semantics, supported sources, constraints).
- Add at least one minimal runnable example and one realistic production-style example; align with existing subscription e2e coverage.
- Cross-link the new page with
serve/subscription.mdx,ALTER SUBSCRIPTION,SHOW SUBSCRIPTIONS, andSHOW SUBSCRIPTION CURSORSpages to improve discoverability. - Verify navigation/search index visibility so
CREATE SUBSCRIPTIONis directly discoverable from SQL commands docs.
Reactions are currently unavailable
Metadata
Metadata
Labels
bugSomething isn't workingSomething isn't workingdocs-agentdocumentationImprovements or additions to documentationImprovements or additions to documentation