org.apache.flink.api.java.io

类 CsvOutputFormat<T extends org.apache.flink.api.java.tuple.Tuple>

java.lang.Object

org.apache.flink.api.common.io.RichOutputFormat<IT>

org.apache.flink.api.common.io.FileOutputFormat<T>

org.apache.flink.api.java.io.CsvOutputFormat<T>

所有已实现的接口:

Serializable, org.apache.flink.api.common.io.CleanupWhenUnsuccessful, org.apache.flink.api.common.io.InitializeOnMaster, org.apache.flink.api.common.io.OutputFormat<T>, org.apache.flink.api.java.typeutils.InputTypeConfigurable

@PublicEvolving
public class CsvOutputFormat<T extends org.apache.flink.api.java.tuple.Tuple>
extends org.apache.flink.api.common.io.FileOutputFormat<T>
implements org.apache.flink.api.java.typeutils.InputTypeConfigurable

This is an OutputFormat to serialize Tuples to text. The output is structured by record delimiters and field delimiters as common in CSV files. Record delimiter separate records from each other ('\n' is common). Field delimiters separate fields within a record.

另请参阅:

序列化表格

嵌套类概要

从类继承的嵌套类/接口 org.apache.flink.api.common.io.FileOutputFormat

org.apache.flink.api.common.io.FileOutputFormat.OutputDirectoryMode

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_FIELD_DELIMITER
static String	DEFAULT_LINE_DELIMITER

从类继承的字段 org.apache.flink.api.common.io.FileOutputFormat

FILE_PARAMETER_KEY, outputFilePath, stream

构造器概要

构造器

构造器和说明
CsvOutputFormat(org.apache.flink.core.fs.Path outputPath) Creates an instance of CsvOutputFormat.
CsvOutputFormat(org.apache.flink.core.fs.Path outputPath, String fieldDelimiter) Creates an instance of CsvOutputFormat.
CsvOutputFormat(org.apache.flink.core.fs.Path outputPath, String recordDelimiter, String fieldDelimiter) Creates an instance of CsvOutputFormat.

方法概要

限定符和类型	方法和说明
void	close()
void	open(int taskNumber, int numTasks)
void	setAllowNullValues(boolean allowNulls) Configures the format to either allow null values (writing an empty field), or to throw an exception when encountering a null field.
void	setCharsetName(String charsetName) Sets the charset with which the CSV strings are written to the file.
void	setInputType(org.apache.flink.api.common.typeinfo.TypeInformation<?> type, org.apache.flink.api.common.ExecutionConfig executionConfig) The purpose of this method is solely to check whether the data type to be processed is in fact a tuple type.
void	setQuoteStrings(boolean quoteStrings) Configures whether the output format should quote string values.
String	toString()
void	writeRecord(T element)

从类继承的方法 org.apache.flink.api.common.io.FileOutputFormat

configure, getDirectoryFileName, getOutputDirectoryMode, getOutputFilePath, getWriteMode, initDefaultsFromConfiguration, initializeGlobal, setOutputDirectoryMode, setOutputFilePath, setWriteMode, tryCleanupOnError

从类继承的方法 org.apache.flink.api.common.io.RichOutputFormat

getRuntimeContext, setRuntimeContext

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_LINE_DELIMITER

public static final String DEFAULT_LINE_DELIMITER

另请参阅:

常量字段值

DEFAULT_FIELD_DELIMITER

public static final String DEFAULT_FIELD_DELIMITER

构造器详细资料

CsvOutputFormat

public CsvOutputFormat(org.apache.flink.core.fs.Path outputPath)

Creates an instance of CsvOutputFormat. Lines are separated by the newline character '\n', fields are separated by ','.

参数:

outputPath - The path where the CSV file is written.

CsvOutputFormat

public CsvOutputFormat(org.apache.flink.core.fs.Path outputPath,
                       String fieldDelimiter)

Creates an instance of CsvOutputFormat. Lines are separated by the newline character '\n', fields by the given field delimiter.

参数:

outputPath - The path where the CSV file is written.

fieldDelimiter - The delimiter that is used to separate fields in a tuple.

CsvOutputFormat

public CsvOutputFormat(org.apache.flink.core.fs.Path outputPath,
                       String recordDelimiter,
                       String fieldDelimiter)

Creates an instance of CsvOutputFormat.

参数:

outputPath - The path where the CSV file is written.

recordDelimiter - The delimiter that is used to separate the tuples.

fieldDelimiter - The delimiter that is used to separate fields in a tuple.

方法详细资料

setAllowNullValues

public void setAllowNullValues(boolean allowNulls)

Configures the format to either allow null values (writing an empty field), or to throw an exception when encountering a null field.

by default, null values are disallowed.

参数:

allowNulls - Flag to indicate whether the output format should accept null values.

setCharsetName

public void setCharsetName(String charsetName)

Sets the charset with which the CSV strings are written to the file. If not specified, the output format uses the systems default character encoding.

参数:

charsetName - The name of charset to use for encoding the output.

setQuoteStrings

public void setQuoteStrings(boolean quoteStrings)

Configures whether the output format should quote string values. String values are fields of type String and StringValue, as well as all subclasses of the latter.

By default, strings are not quoted.

参数:

quoteStrings - Flag indicating whether string fields should be quoted.

open

public void open(int taskNumber,
                 int numTasks)
          throws IOException

指定者:

open 在接口中 org.apache.flink.api.common.io.OutputFormat<T extends org.apache.flink.api.java.tuple.Tuple>

覆盖:

open 在类中 org.apache.flink.api.common.io.FileOutputFormat<T extends org.apache.flink.api.java.tuple.Tuple>

抛出:

IOException

close

public void close()
           throws IOException

指定者:

close 在接口中 org.apache.flink.api.common.io.OutputFormat<T extends org.apache.flink.api.java.tuple.Tuple>

覆盖:

close 在类中 org.apache.flink.api.common.io.FileOutputFormat<T extends org.apache.flink.api.java.tuple.Tuple>

抛出:

IOException

writeRecord

public void writeRecord(T element)
                 throws IOException

指定者:

writeRecord 在接口中 org.apache.flink.api.common.io.OutputFormat<T extends org.apache.flink.api.java.tuple.Tuple>

抛出:

IOException

toString

public String toString()

覆盖:

toString 在类中 Object

setInputType

public void setInputType(org.apache.flink.api.common.typeinfo.TypeInformation<?> type,
                         org.apache.flink.api.common.ExecutionConfig executionConfig)

The purpose of this method is solely to check whether the data type to be processed is in fact a tuple type.

指定者:

setInputType 在接口中 org.apache.flink.api.java.typeutils.InputTypeConfigurable