Class/Object

ksb.csle.component.writer

FileWriter

Related Docs: object FileWriter | package writer

Permalink

class FileWriter extends BaseWriter[DataFrame, BatchWriterInfo, SparkSession]

:: ApplicationDeveloperApi ::

Writer that saves DataFrame to a file.

Linear Supertypes
BaseWriter[DataFrame, BatchWriterInfo, SparkSession], BaseDoer, Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileWriter
  2. BaseWriter
  3. BaseDoer
  4. Logging
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileWriter(o: BatchWriterInfo)

    Permalink

    o

    Object that contains message ksb.csle.common.proto.DatasourceProto.FileInfo FileInfo contains attributes as follows:

    • filePath: File path where writes records (required)
    • fileType: File type (optional)
    • delimiter: Delimiter of each field (optional)
    • field: Schema of input record (optional)
    • header: True if has a header line (optional)
    • saveMode: specify the expected behavior of saving a DataFrame to a data source. (optional)

    FileInfo

    message FileInfo {
      repeated string filePath = 1;
      optional FileType fileType = 2 [default = JSON];
      optional string delimiter = 3 [default = ","];
      repeated FieldInfo field = 4;
      optional bool header = 5 [default = false];
      optional SaveMode saveMode = 6 [default = OVERWRITE];
      enum FileType {
        CSV = 0;
        JSON = 1;
        PARQUET = 2;
        TEXT = 3;
      }
      enum SaveMode {
        APPEND = 0;
        OVERWRITE = 1;
        ERROR_IF_EXISTS = 2;
       IGNORE = 3;
      }
    }

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def close: Unit

    Permalink

    Close the FileWriter.

    Close the FileWriter.

    Definition Classes
    FileWriter → BaseWriter
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. val o: BatchWriterInfo

    Permalink

    Object that contains message ksb.csle.common.proto.DatasourceProto.FileInfo FileInfo contains attributes as follows:

    Object that contains message ksb.csle.common.proto.DatasourceProto.FileInfo FileInfo contains attributes as follows:

    • filePath: File path where writes records (required)
    • fileType: File type (optional)
    • delimiter: Delimiter of each field (optional)
    • field: Schema of input record (optional)
    • header: True if has a header line (optional)
    • saveMode: specify the expected behavior of saving a DataFrame to a data source. (optional)

    FileInfo

    message FileInfo {
      repeated string filePath = 1;
      optional FileType fileType = 2 [default = JSON];
      optional string delimiter = 3 [default = ","];
      repeated FieldInfo field = 4;
      optional bool header = 5 [default = false];
      optional SaveMode saveMode = 6 [default = OVERWRITE];
      enum FileType {
        CSV = 0;
        JSON = 1;
        PARQUET = 2;
        TEXT = 3;
      }
      enum SaveMode {
        APPEND = 0;
        OVERWRITE = 1;
        ERROR_IF_EXISTS = 2;
       IGNORE = 3;
      }
    }
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def write(d: DataFrame): Unit

    Permalink

    Save DataFrame to the file.

    Save DataFrame to the file.

    d

    DataFrame to save

    Definition Classes
    FileWriter → BaseWriter
  24. def write(s: SparkSession, d: DataFrame): Any

    Permalink
    Definition Classes
    BaseWriter
    Annotations
    @DeveloperApi()

Inherited from BaseWriter[DataFrame, BatchWriterInfo, SparkSession]

Inherited from BaseDoer

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped