Skip to content

Refine Python External Stream docs#632

Draft
yokofly wants to merge 3 commits into
mainfrom
codex/python-external-stream-version-gates-627
Draft

Refine Python External Stream docs#632
yokofly wants to merge 3 commits into
mainfrom
codex/python-external-stream-version-gates-627

Conversation

@yokofly
Copy link
Copy Markdown
Contributor

@yokofly yokofly commented Apr 24, 2026

Summary

Refines the CREATE EXTERNAL STREAM reference for Python External Stream to expose only Timeplus Enterprise version requirements and make the feature gates explicit.

What Changed

  • documents base Python External Stream availability as Timeplus Enterprise 3.1.1+
  • documents init_function_name, deinit_function_name, and init_function_parameters as Timeplus Enterprise 3.2.1+
  • documents __timeplus_local_api_user and __timeplus_local_api_password injected globals as Timeplus Enterprise 3.2.2+
  • fixes Python comments inside the embedded AS $$ ... $$ example so copied code remains valid Python

Closes #627

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 24, 2026

Deploy Preview for elastic-elion-a958b6 ready!

Name Link
🔨 Latest commit 3d3c123
🔍 Latest deploy log https://app.netlify.com/projects/elastic-elion-a958b6/deploys/69fae857c42fe300084669fa
😎 Deploy Preview https://deploy-preview-632--elastic-elion-a958b6.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@yokofly yokofly marked this pull request as ready for review April 24, 2026 00:30
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>
@yokofly yokofly marked this pull request as draft April 24, 2026 01:04
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>
@yokofly yokofly force-pushed the codex/python-external-stream-version-gates-627 branch from 438da3d to d475bb0 Compare May 6, 2026 04:30
@yokofly yokofly changed the title [codex] Refine Python External Stream version gates Refine Python External Stream docs May 6, 2026
@yokofly
Copy link
Copy Markdown
Contributor Author

yokofly commented May 6, 2026

Internal confirmation received: bytes is the stable contract for Python string columns in Timeplus Enterprise 3.2.2+. The .decode("utf-8") examples in this PR reflect current and intended behavior — ready for merge review.

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>
@yokofly yokofly force-pushed the codex/python-external-stream-version-gates-627 branch from 5eceb22 to 3d3c123 Compare May 6, 2026 07:05
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.

python stream doc update

1 participant