class ScalaCsvOutputFormat[T <: Product] extends FileOutputFormat[T] with InputTypeConfigurable
This is an OutputFormat to serialize Scala 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.
- Deprecated
All Flink Scala APIs are deprecated and will be removed in a future Flink major version. You can still build your application in Scala, but you should move to the Java version of either the DataStream and/or Table API.
- See also
- Alphabetic
- By Inheritance
- ScalaCsvOutputFormat
- InputTypeConfigurable
- FileOutputFormat
- CleanupWhenUnsuccessful
- InitializeOnMaster
- RichOutputFormat
- OutputFormat
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
ScalaCsvOutputFormat(outputPath: Path, recordDelimiter: String, fieldDelimiter: String)
Creates an instance of CsvOutputFormat.
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.
-
new
ScalaCsvOutputFormat(outputPath: Path, fieldDelimiter: String)
Creates an instance of CsvOutputFormat.
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.
-
new
ScalaCsvOutputFormat(outputPath: Path)
- Deprecated
All Flink Scala APIs are deprecated and will be removed in a future Flink major version. You can still build your application in Scala, but you should move to the Java version of either the DataStream and/or Table API.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
close(): Unit
- Definition Classes
- ScalaCsvOutputFormat → FileOutputFormat → OutputFormat
-
def
configure(arg0: Configuration): Unit
- Definition Classes
- FileOutputFormat → OutputFormat
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getDirectoryFileName(arg0: Int): String
- Attributes
- protected[org.apache.flink.api.common.io]
- Definition Classes
- FileOutputFormat
-
def
getOutputDirectoryMode(): OutputDirectoryMode
- Definition Classes
- FileOutputFormat
-
def
getOutputFilePath(): Path
- Definition Classes
- FileOutputFormat
-
def
getRuntimeContext(): RuntimeContext
- Definition Classes
- RichOutputFormat
-
def
getWriteMode(): WriteMode
- Definition Classes
- FileOutputFormat
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
initializeGlobal(arg0: Int): Unit
- Definition Classes
- FileOutputFormat → InitializeOnMaster
- Annotations
- @throws( classOf[java.io.IOException] )
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
open(taskNumber: Int, numTasks: Int): Unit
- Definition Classes
- ScalaCsvOutputFormat → FileOutputFormat → OutputFormat
-
def
open(arg0: InitializationContext): Unit
- Definition Classes
- OutputFormat
- Annotations
- @throws( classOf[java.io.IOException] )
-
def
setAllowNullValues(allowNulls: Boolean): Unit
Configures the format to either allow null values (writing an empty field), or to throw an exception when encountering a null field.
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 allowed.
- allowNulls
Flag to indicate whether the output format should accept null values.
-
def
setCharsetName(charsetName: String): Unit
Sets the charset with which the CSV strings are written to the file.
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.
-
def
setInputType(type: TypeInformation[_], executionConfig: ExecutionConfig): Unit
The purpose of this method is solely to check whether the data type to be processed is in fact a tuple type.
The purpose of this method is solely to check whether the data type to be processed is in fact a tuple type.
- Definition Classes
- ScalaCsvOutputFormat → InputTypeConfigurable
-
def
setOutputDirectoryMode(arg0: OutputDirectoryMode): Unit
- Definition Classes
- FileOutputFormat
-
def
setOutputFilePath(arg0: Path): Unit
- Definition Classes
- FileOutputFormat
-
def
setQuoteStrings(quoteStrings: Boolean): Unit
Configures whether the output format should quote string values.
Configures whether the output format should quote string values. String values are fields of type
String
andorg.apache.flink.types.StringValue
, as well as all subclasses of the latter.By default, strings are not quoted.
- quoteStrings
Flag indicating whether string fields should be quoted.
-
def
setRuntimeContext(arg0: RuntimeContext): Unit
- Definition Classes
- RichOutputFormat
-
def
setWriteMode(arg0: WriteMode): Unit
- Definition Classes
- FileOutputFormat
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- ScalaCsvOutputFormat → AnyRef → Any
-
def
tryCleanupOnError(): Unit
- Definition Classes
- FileOutputFormat → CleanupWhenUnsuccessful
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
writeRecord(element: T): Unit
- Definition Classes
- ScalaCsvOutputFormat → OutputFormat