org.apache.flink.streaming.connectors.kafka

Class Kafka011JsonTableSource

java.lang.Object

org.apache.flink.streaming.connectors.kafka.KafkaTableSource

org.apache.flink.streaming.connectors.kafka.KafkaJsonTableSource

org.apache.flink.streaming.connectors.kafka.Kafka011JsonTableSource

All Implemented Interfaces:

org.apache.flink.table.sources.DefinedFieldMapping, org.apache.flink.table.sources.DefinedProctimeAttribute, org.apache.flink.table.sources.DefinedRowtimeAttributes, org.apache.flink.table.sources.StreamTableSource<Row>, org.apache.flink.table.sources.TableSource<Row>

public class Kafka011JsonTableSource
extends KafkaJsonTableSource

Kafka StreamTableSource for Kafka 0.11.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Kafka011JsonTableSource.Builder A builder to configure and create a Kafka011JsonTableSource.

Constructor Summary

Constructors

Constructor and Description
Kafka011JsonTableSource(String topic, Properties properties, org.apache.flink.table.api.TableSchema tableSchema, org.apache.flink.table.api.TableSchema jsonSchema) Creates a Kafka 0.11 JSON StreamTableSource.

Method Summary

Modifier and Type	Method and Description
static Kafka011JsonTableSource.Builder	builder() Returns a builder to configure and create a Kafka011JsonTableSource.
protected FlinkKafkaConsumerBase<Row>	createKafkaConsumer(String topic, Properties properties, DeserializationSchema<Row> deserializationSchema) Creates a version-specific Kafka consumer.
void	setFailOnMissingField(boolean failOnMissingField) Sets the flag that specifies the behavior in case of missing fields.
void	setFieldMapping(Map<String,String> fieldMapping) Sets the mapping from table schema fields to JSON schema fields.
void	setProctimeAttribute(String proctimeAttribute) Declares a field of the schema to be a processing time attribute.
void	setRowtimeAttributeDescriptor(org.apache.flink.table.sources.RowtimeAttributeDescriptor rowtimeAttributeDescriptor) Declares a field of the schema to be a rowtime attribute.

Methods inherited from class org.apache.flink.streaming.connectors.kafka.KafkaJsonTableSource

explainSource, getDeserializationSchema, getFieldMapping

Methods inherited from class org.apache.flink.streaming.connectors.kafka.KafkaTableSource

getDataStream, getKafkaConsumer, getProctimeAttribute, getReturnType, getRowtimeAttributeDescriptors, getTableSchema, setRowtimeAttributeDescriptors, setSpecificStartupOffsets, setStartupMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Kafka011JsonTableSource

public Kafka011JsonTableSource(String topic,
                               Properties properties,
                               org.apache.flink.table.api.TableSchema tableSchema,
                               org.apache.flink.table.api.TableSchema jsonSchema)

Creates a Kafka 0.11 JSON StreamTableSource.

Parameters:

topic - Kafka topic to consume.

properties - Properties for the Kafka consumer.

tableSchema - The schema of the table.

jsonSchema - The schema of the JSON messages to decode from Kafka.

Method Detail

setFailOnMissingField

public void setFailOnMissingField(boolean failOnMissingField)

Sets the flag that specifies the behavior in case of missing fields. TableSource will fail for missing fields if set to true. If set to false, the missing field is set to null.

Overrides:

setFailOnMissingField in class KafkaJsonTableSource

Parameters:

failOnMissingField - Flag that specifies the TableSource behavior in case of missing fields.

setFieldMapping

public void setFieldMapping(Map<String,String> fieldMapping)

Sets the mapping from table schema fields to JSON schema fields.

Overrides:

setFieldMapping in class KafkaJsonTableSource

Parameters:

fieldMapping - The mapping from table schema fields to JSON schema fields.

setProctimeAttribute

public void setProctimeAttribute(String proctimeAttribute)

Declares a field of the schema to be a processing time attribute.

Overrides:

setProctimeAttribute in class KafkaTableSource

Parameters:

proctimeAttribute - The name of the field that becomes the processing time field.

setRowtimeAttributeDescriptor

public void setRowtimeAttributeDescriptor(org.apache.flink.table.sources.RowtimeAttributeDescriptor rowtimeAttributeDescriptor)

Declares a field of the schema to be a rowtime attribute.

Parameters:

rowtimeAttributeDescriptor - The descriptor of the rowtime attribute.

createKafkaConsumer

protected FlinkKafkaConsumerBase<Row> createKafkaConsumer(String topic,
                                                          Properties properties,
                                                          DeserializationSchema<Row> deserializationSchema)

Description copied from class: KafkaTableSource

Creates a version-specific Kafka consumer.

Specified by:

createKafkaConsumer in class KafkaTableSource

Parameters:

topic - Kafka topic to consume.

properties - Properties for the Kafka consumer.

deserializationSchema - Deserialization schema to use for Kafka records.

Returns:

The version-specific Kafka consumer

builder

public static Kafka011JsonTableSource.Builder builder()

Returns a builder to configure and create a Kafka011JsonTableSource.

Returns:

A builder to configure and create a Kafka011JsonTableSource.