Skip to content

docs: correct three stale entries in the SQL option reference - #639

Open
jackylee-ch wants to merge 1 commit into
apache:mainfrom
jackylee-ch:docs/fix-sql-option-reference
Open

docs: correct three stale entries in the SQL option reference#639
jackylee-ch wants to merge 1 commit into
apache:mainfrom
jackylee-ch:docs/fix-sql-option-reference

Conversation

@jackylee-ch

Copy link
Copy Markdown
Contributor

Three entries in docs/src/sql.md no longer match the code:

  • 'cross-partition-update.enabled' does not exist. grep finds it only in
    this doc. Cross-partition update mode is inferred in TableWrite from
    bucket = -1 plus a primary key that does not contain every partition field —
    it is never configured, so setting the documented option does nothing. Java has
    no such key either.
  • changelog-producer = 'input' no longer rejects PK writes.
    test_pk_input_changelog_write_read creates a primary-key table with that
    option and inserts into it successfully.
  • CHAR and BINARY map to their own types. The table listed them under
    VarCharType / VarBinaryType, but sql_data_type_to_paimon_type maps CHAR(n)
    to CharType and BINARY(n) to BinaryType, each defaulting to length 1.

`docs/src/sql.md` documented `'cross-partition-update.enabled'`, which does not
exist anywhere in the codebase — cross-partition update mode is inferred in
`TableWrite` from `bucket = -1` plus a primary key that does not contain every
partition field, never configured. Setting the documented option does nothing.

The `changelog-producer = 'input'` row still said primary-key tables reject
writes. That has been supported since the PK input-changelog write path landed;
`test_pk_input_changelog_write_read` creates a PK table with that option and
inserts into it successfully.

The type mapping table listed `CHAR` under VarCharType and `BINARY` under
VarBinaryType, but `sql_data_type_to_paimon_type` maps `CHAR(n)` to `CharType`
and `BINARY(n)` to `BinaryType`, each defaulting to length 1.
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.

1 participant