org.apache.flink.table.sinks

Class CsvTableSink

java.lang.Object

org.apache.flink.table.sinks.CsvTableSink

All Implemented Interfaces:

AppendStreamTableSink<org.apache.flink.types.Row>, BatchTableSink<org.apache.flink.types.Row>, StreamTableSink<org.apache.flink.types.Row>, org.apache.flink.table.sinks.TableSink<org.apache.flink.types.Row>

public class CsvTableSink
extends Object
implements BatchTableSink<org.apache.flink.types.Row>, AppendStreamTableSink<org.apache.flink.types.Row>

A simple TableSink to emit data as CSV files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CsvTableSink.CsvFormatter Formats a Row into a String with fields separated by the field delimiter.

Constructor Summary

Constructors

Constructor and Description
CsvTableSink(String path) A simple TableSink to emit data as CSV files using comma as field delimiter, with default parallelism and write mode.
CsvTableSink(String path, String fieldDelim) A simple TableSink to emit data as CSV files, with default parallelism and write mode.
CsvTableSink(String path, String fieldDelim, int numFiles, org.apache.flink.core.fs.FileSystem.WriteMode writeMode) A simple TableSink to emit data as CSV files.
CsvTableSink(String path, String fieldDelim, int numFiles, org.apache.flink.core.fs.FileSystem.WriteMode writeMode, String[] fieldNames, org.apache.flink.table.types.DataType[] fieldTypes) A simple TableSink to emit data as CSV files.

Method Summary

Modifier and Type	Method and Description
org.apache.flink.table.sinks.TableSink<org.apache.flink.types.Row>	configure(String[] fieldNames, org.apache.flink.api.common.typeinfo.TypeInformation<?>[] fieldTypes)
org.apache.flink.api.java.operators.DataSink<?>	consumeDataSet(org.apache.flink.api.java.DataSet<org.apache.flink.types.Row> dataSet) Consumes the DataSet and return the DataSink.
org.apache.flink.streaming.api.datastream.DataStreamSink<?>	consumeDataStream(org.apache.flink.streaming.api.datastream.DataStream<org.apache.flink.types.Row> dataStream) Consumes the DataStream and return the sink transformation DataStreamSink.
org.apache.flink.table.types.DataType	getConsumedDataType()
org.apache.flink.table.api.TableSchema	getTableSchema()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.sinks.TableSink

getFieldNames, getFieldTypes, getOutputType

Constructor Detail

CsvTableSink

public CsvTableSink(String path,
                    String fieldDelim,
                    int numFiles,
                    org.apache.flink.core.fs.FileSystem.WriteMode writeMode,
                    String[] fieldNames,
                    org.apache.flink.table.types.DataType[] fieldTypes)

A simple TableSink to emit data as CSV files.

Parameters:

path - The output path to write the Table to.

fieldDelim - The field delimiter

numFiles - The number of files to write to

writeMode - The write mode to specify whether existing files are overwritten or not.

fieldNames - The field names of the table to emit.

fieldTypes - The field types of the table to emit.

CsvTableSink

public CsvTableSink(String path,
                    String fieldDelim,
                    int numFiles,
                    org.apache.flink.core.fs.FileSystem.WriteMode writeMode)

A simple TableSink to emit data as CSV files.

Parameters:

path - The output path to write the Table to.

fieldDelim - The field delimiter

numFiles - The number of files to write to

writeMode - The write mode to specify whether existing files are overwritten or not.

CsvTableSink

public CsvTableSink(String path)

A simple TableSink to emit data as CSV files using comma as field delimiter, with default parallelism and write mode.

Parameters:

path - The output path to write the Table to.

CsvTableSink

public CsvTableSink(String path,
                    String fieldDelim)

A simple TableSink to emit data as CSV files, with default parallelism and write mode.

Parameters:

path - The output path to write the Table to.

fieldDelim - The field delimiter

Method Detail

consumeDataSet

public org.apache.flink.api.java.operators.DataSink<?> consumeDataSet(org.apache.flink.api.java.DataSet<org.apache.flink.types.Row> dataSet)

Description copied from interface: BatchTableSink

Consumes the DataSet and return the DataSink. The returned DataSink will be used to generate Plan.

Specified by:

consumeDataSet in interface BatchTableSink<org.apache.flink.types.Row>

consumeDataStream

public org.apache.flink.streaming.api.datastream.DataStreamSink<?> consumeDataStream(org.apache.flink.streaming.api.datastream.DataStream<org.apache.flink.types.Row> dataStream)

Description copied from interface: StreamTableSink

Consumes the DataStream and return the sink transformation DataStreamSink. The returned DataStreamSink will be used to set resources for the sink operator.

Specified by:

consumeDataStream in interface StreamTableSink<org.apache.flink.types.Row>

configure

public org.apache.flink.table.sinks.TableSink<org.apache.flink.types.Row> configure(String[] fieldNames,
                                                                                    org.apache.flink.api.common.typeinfo.TypeInformation<?>[] fieldTypes)

Specified by:

configure in interface org.apache.flink.table.sinks.TableSink<org.apache.flink.types.Row>

getConsumedDataType

public org.apache.flink.table.types.DataType getConsumedDataType()

Specified by:

getConsumedDataType in interface org.apache.flink.table.sinks.TableSink<org.apache.flink.types.Row>

getTableSchema

public org.apache.flink.table.api.TableSchema getTableSchema()

Specified by:

getTableSchema in interface org.apache.flink.table.sinks.TableSink<org.apache.flink.types.Row>