KeyFormat¶

Creating Instance¶

KeyFormat takes the following to be created:

• Format Specification (FormatInfo)
• SerdeFeatures
• Window Specification (WindowInfo)

KeyFormat is created using the following:

• nonWindowed
• windowed
• of
• withSerdeFeatures
• withoutSerdeFeatures

Creating KeyFormat Instance¶

KeyFormat of(
  FormatInfo format,
  SerdeFeatures features,
  Optional<WindowInfo> windowInfo)

of creates a KeyFormat.

of is used when:

• DdlCommandExec is requested for a KsqlTopic (for a CreateSourceCommand)
• EngineExecutor is requested for a source table plan
• LogicalPlanner is requested to getSinkTopic
• KsqlAuthorizationValidatorImpl is requested to getCreateAsSelectSinkTopic

Creating Non-Windowed KeyFormat Instance¶

KeyFormat nonWindowed(
  FormatInfo format,
  SerdeFeatures features)

nonWindowed creates a KeyFormat with no window spec.

nonWindowed is used when:

• EngineExecutor is requested to getSinkTopic
• JoinNode is requested to getDefaultSourceKeyFormat
• SerdeFeaturesFactory is requested to convertToJsonFormat
• SchemaKStream is requested to groupBy
• SchemaKTable is requested to groupBy
• RuntimeBuildContext is requested to buildKeySerde

withSerdeFeatures¶

KeyFormat withSerdeFeatures(
  SerdeFeatures additionalFeatures)

withSerdeFeatures copies this KeyFormat with the SerdeFeatures with the given additional SerdeFeatures (possibly overriding the current features).

withSerdeFeatures is used when:

• SerdeFeaturesFactory is requested to sanitizeKeyFormatWrapping