Skip to content

MINOR: Document top-level-only field casting limitation in Cast SMT #22697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
itsmehotpants wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

MINOR: Document top-level-only field casting limitation in Cast SMT #22697

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions connect/transforms/src/main/java/org/apache/kafka/connect/transforms/Cast.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ public abstract class Cast<R extends ConnectRecord<R>> implements Transformation
public static final String OVERVIEW_DOC =
"Cast fields or the entire key or value to a specific type, e.g. to force an integer field to a smaller "
+ "width. Cast from integers, floats, boolean and string to any other type, "
+ "and cast binary to string (base64 encoded)."
+ "and cast binary to string (base64 encoded). "
+ "Only top-level fields are supported; nested field casting via dotted notation is not currently available."
+ "<p/>Use the concrete transformation type designed for the record key (<code>" + Key.class.getName() + "</code>) "
+ "or value (<code>" + Value.class.getName() + "</code>).";

Expand All @@ -83,7 +84,8 @@ public abstract class Cast<R extends ConnectRecord<R>> implements Transformation
ConfigDef.Importance.HIGH,
"List of fields and the type to cast them to of the form field1:type,field2:type to cast fields of "
+ "Maps or Structs. A single type to cast the entire value. Valid types are int8, int16, int32, "
+ "int64, float32, float64, boolean, and string. Note that binary fields can only be cast to string.")
+ "int64, float32, float64, boolean, and string. Note that binary fields can only be cast to string. "
+ "Only top-level fields are supported; nested fields cannot be addressed using dotted notation.")
.define(REPLACE_NULL_WITH_DEFAULT_CONFIG,
ConfigDef.Type.BOOLEAN,
true,
Expand Down