[Improve][Doc] Update sql function result type (apache#9703) by jihun4452 · Pull Request #9711 · apache/seatunnel (original) (raw)

Purpose of this pull request

Add explicit return type information for each SQL function in the docs and unify the return type notation.

• Add a one-line “This method returns …” for every function with the type in UPPERCASE (e.g., STRING, DOUBLE, BOOLEAN, TIMESTAMP WITH TIME ZONE, etc.).
• Keep the wording consistent across sections (String / Numeric / Time & Date / System).
• Minor formatting fixes for examples (fenced code blocks) and small clarifications where a function’s return depends on input type (e.g., FLOOR, ROUND, DATEADD).

Reference: PostgreSQL function docs style for consistency: https://www.postgresql.org/docs/current/functions-math.html

Closes #9703.

Does this PR introduce any user-facing change?

Yes. Documentation only.
Previously, many SQL functions didn’t explicitly state their return types. Now each function clearly documents the return type, improving readability and reducing ambiguity. No runtime behavior change.

How was this patch tested?

• Manually previewed the updated Markdown to ensure headings, code fences, and bolded return types render correctly.
• Checked for consistent casing of types across the file.

(Documentation change only; no code/tests affected.)

Check list

• Documentation updated: docs/transform-v2/sql-functions.md
• No new binaries added
• Not a connector change (no plugin mapping / dist / e2e updates required)