org.apache.flink.table.descriptors

Class OldCsv

java.lang.Object

org.apache.flink.table.descriptors.DescriptorBase

org.apache.flink.table.descriptors.FormatDescriptor

org.apache.flink.table.descriptors.OldCsv

All Implemented Interfaces:

org.apache.flink.table.descriptors.Descriptor

Deprecated.

Use the RFC-compliant Csv format in the dedicated flink-formats/flink-csv module instead when writing to Kafka.

@Deprecated
 @PublicEvolving
public class OldCsv
extends org.apache.flink.table.descriptors.FormatDescriptor

Format descriptor for comma-separated values (CSV).

Note: This descriptor describes Flink's non-standard CSV table source/sink. In the future, the descriptor will be replaced by a proper RFC-compliant version. Use the RFC-compliant Csv format in the dedicated flink-formats/flink-csv module instead when writing to Kafka. Use the old one for stream/batch filesystem operations for now.

Constructor Summary

Constructors

Constructor and Description
OldCsv() Deprecated.

Method Summary

Modifier and Type	Method and Description
OldCsv	commentPrefix(String prefix) Deprecated. Sets a prefix to indicate comments, null by default.
OldCsv	deriveSchema() Deprecated. Derivation format schema from table's schema is the default behavior now. So there is no need to explicitly declare to derive schema.
OldCsv	field(String fieldName, org.apache.flink.table.types.DataType fieldType) Deprecated. Adds a format field with the field name and the type information.
OldCsv	field(String fieldName, String fieldType) Deprecated. Adds a format field with the field name and the type string.
OldCsv	field(String fieldName, org.apache.flink.api.common.typeinfo.TypeInformation<?> fieldType) Deprecated. Adds a format field with the field name and the type information.
OldCsv	fieldDelimiter(String delim) Deprecated. Sets the field delimiter, "," by default.
OldCsv	ignoreFirstLine() Deprecated. Ignore the first line.
OldCsv	ignoreParseErrors() Deprecated. Skip records with parse error instead to fail.
OldCsv	lineDelimiter(String delim) Deprecated. Sets the line delimiter, "\n" by default.
OldCsv	quoteCharacter(Character quote) Deprecated. Sets a quote character for String values, null by default.
OldCsv	schema(org.apache.flink.table.api.TableSchema schema) Deprecated. Sets the format schema with field names and the types.
protected Map<String,String>	toFormatProperties() Deprecated.

Methods inherited from class org.apache.flink.table.descriptors.FormatDescriptor

toProperties

Methods inherited from class org.apache.flink.table.descriptors.DescriptorBase

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OldCsv

public OldCsv()

Deprecated.

Method Detail

fieldDelimiter

public OldCsv fieldDelimiter(String delim)

Deprecated.

Sets the field delimiter, "," by default.

Parameters:

delim - the field delimiter

lineDelimiter

public OldCsv lineDelimiter(String delim)

Deprecated.

Sets the line delimiter, "\n" by default.

Parameters:

delim - the line delimiter

schema

public OldCsv schema(org.apache.flink.table.api.TableSchema schema)

Deprecated.

Sets the format schema with field names and the types. Required. The table schema must not contain nested fields.

This method overwrites existing fields added with [[field()]].

Parameters:

schema - the table schema

field

public OldCsv field(String fieldName,
                    org.apache.flink.api.common.typeinfo.TypeInformation<?> fieldType)

Deprecated.

Adds a format field with the field name and the type information. Required. This method can be called multiple times. The call order of this method defines also the order of the fields in the format.

Parameters:

fieldName - the field name

fieldType - the type information of the field

field

public OldCsv field(String fieldName,
                    org.apache.flink.table.types.DataType fieldType)

Deprecated.

Adds a format field with the field name and the type information. Required. This method can be called multiple times. The call order of this method defines also the order of the fields in the format.

Parameters:

fieldName - the field name

fieldType - the type information of the field

field

public OldCsv field(String fieldName,
                    String fieldType)

Deprecated.

Adds a format field with the field name and the type string. Required. This method can be called multiple times. The call order of this method defines also the order of the fields in the format.

NOTE: the fieldType string should follow the type string defined in LogicalTypeParser. This method also keeps compatible with old type string defined in TypeStringUtils but will be dropped in future versions as it uses the old type system.

Parameters:

fieldName - the field name

fieldType - the type string of the field

quoteCharacter

public OldCsv quoteCharacter(Character quote)

Deprecated.

Sets a quote character for String values, null by default.

Parameters:

quote - the quote character

commentPrefix

public OldCsv commentPrefix(String prefix)

Deprecated.

Sets a prefix to indicate comments, null by default.

Parameters:

prefix - the prefix to indicate comments

ignoreFirstLine

public OldCsv ignoreFirstLine()

Deprecated.

Ignore the first line. Not skip the first line by default.

ignoreParseErrors

public OldCsv ignoreParseErrors()

Deprecated.

Skip records with parse error instead to fail. Throw an exception by default.

deriveSchema

@Deprecated
public OldCsv deriveSchema()

Deprecated. Derivation format schema from table's schema is the default behavior now. So there is no need to explicitly declare to derive schema.

Derives the format schema from the table's schema. Required if no format schema is defined.

This allows for defining schema information only once.

The names, types, and fields' order of the format are determined by the table's schema.

toFormatProperties

protected Map<String,String> toFormatProperties()

Deprecated.

Specified by:

toFormatProperties in class org.apache.flink.table.descriptors.FormatDescriptor