Refine Python External Stream docs#632
Draft
yokofly wants to merge 3 commits into
Draft
Conversation
✅ Deploy Preview for elastic-elion-a958b6 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Split the detailed Python External Stream content out of the SQL reference into docs/python-external-stream.md, matching the Kafka / Pulsar / NATS JetStream pattern. The SQL reference keeps a compact syntax block, version note, and link out. Sidebar entries added under CONNECT DATA IN and SEND DATA OUT. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Refactor the single python-external-stream page into source/sink MDX wrappers backed by three shared partials (basics, read, write), matching the Kafka/Pulsar/NATS pattern. Add read- and write-side worked examples: streaming generator, batch list, init/deinit lifecycle, local API credential callback, materialized-view sink, and webhook POST. Drop internal engine-version gates in favor of a single Timeplus Enterprise 3.2+ product note. - New: docs/python-external-stream-source.mdx and -sink.mdx, plus shared partials under docs/shared/. - Sidebar entries repointed; /python-external-stream redirects to /python-external-stream-source. - Incoming links in docs/external-stream.md and docs/sql-create-external-stream.md updated to reference both pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
438da3d to
d475bb0
Compare
Contributor
Author
|
Internal confirmation received: |
Verified the new examples against timeplus/timeplusd:3.2.2 and :3.2.7. Sink-side string columns arrive as Python `bytes`, not `str`, in Timeplus Enterprise 3.2.2+. The original `py_metric_sink` and `post_event` examples needed `.decode()` to run; add the calls and a one-paragraph note linking to the Python UDF data type mapping. Also bump the product-version note to 3.2.2+ so it matches the floor where every documented setting and global is present. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
5eceb22 to
3d3c123
Compare
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
Refines the
CREATE EXTERNAL STREAMreference for Python External Stream to expose onlyTimeplus Enterpriseversion requirements and make the feature gates explicit.What Changed
Timeplus Enterprise 3.1.1+init_function_name,deinit_function_name, andinit_function_parametersasTimeplus Enterprise 3.2.1+__timeplus_local_api_userand__timeplus_local_api_passwordinjected globals asTimeplus Enterprise 3.2.2+AS $$ ... $$example so copied code remains valid PythonCloses #627