Class

ksb.csle.component.pipe.stream.writer

FilePipeWriter

Related Doc: package writer

Permalink

class FilePipeWriter extends BasePipeWriter[DataFrame, StreamingQuery, StreamPipeWriterInfo, SparkSession]

:: ApplicationDeveloperApi ::

Writer that saves DataFrame to a file.

Linear Supertypes
BasePipeWriter[DataFrame, StreamingQuery, StreamPipeWriterInfo, SparkSession], BaseGenericPipeOperator[DataFrame, DataFrame, StreamingQuery, StreamPipeWriterInfo, SparkSession], BaseGenericMutantOperator[StreamPipeWriterInfo, DataFrame, (DataFrame) ⇒ StreamingQuery], BaseDoer, Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FilePipeWriter
  2. BasePipeWriter
  3. BaseGenericPipeOperator
  4. BaseGenericMutantOperator
  5. BaseDoer
  6. Logging
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FilePipeWriter(o: StreamPipeWriterInfo, session: SparkSession)

    Permalink

    o

    Object that contains message ksb.csle.common.proto.DatasourceProto.FilePipeWriterInfo FilePipeWriterInfo contains followed attributes:

    • 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)
    • mode: Write mode such as append, update, and complete
    • trigger: triggering interval
    • chechpointLocation: checkpoint file path

    FilePipeWriterInfo

    message FilePipeWriterInfo {
     required FileInfo fileInfo = 1;
     optional string mode = 2 [default="append"];
     optional string trigger = 3;
     required string checkpointLocation = 4 [default="/checkpoint/file"];
    }

    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];
      enum FileType {
        CSV = 0;
        JSON = 1;
        PARQUET = 2;
        TEXT = 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
    Definition Classes
    FilePipeWriter → BasePipeWriter
  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: StreamPipeWriterInfo

    Permalink

    Object that contains message ksb.csle.common.proto.DatasourceProto.FilePipeWriterInfo FilePipeWriterInfo contains followed attributes:

    Object that contains message ksb.csle.common.proto.DatasourceProto.FilePipeWriterInfo FilePipeWriterInfo contains followed attributes:

    • 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)
    • mode: Write mode such as append, update, and complete
    • trigger: triggering interval
    • chechpointLocation: checkpoint file path

    FilePipeWriterInfo

    message FilePipeWriterInfo {
     required FileInfo fileInfo = 1;
     optional string mode = 2 [default="append"];
     optional string trigger = 3;
     required string checkpointLocation = 4 [default="/checkpoint/file"];
    }

    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];
      enum FileType {
        CSV = 0;
        JSON = 1;
        PARQUET = 2;
        TEXT = 3;
      }
    }
  18. final def operate(df: DataFrame): (DataFrame) ⇒ StreamingQuery

    Permalink
    Definition Classes
    BasePipeWriter → BaseGenericPipeOperator → BaseGenericMutantOperator
  19. val session: SparkSession

    Permalink
  20. def stop: Unit

    Permalink
    Definition Classes
    BasePipeWriter → BaseGenericPipeOperator → BaseGenericMutantOperator
  21. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def write(df: DataFrame): StreamingQuery

    Permalink

    Writes dataframe to file

    Writes dataframe to file

    df

    Dataframe to write

    returns

    handle StreamingQuery

    Definition Classes
    FilePipeWriter → BasePipeWriter

Inherited from BasePipeWriter[DataFrame, StreamingQuery, StreamPipeWriterInfo, SparkSession]

Inherited from BaseGenericPipeOperator[DataFrame, DataFrame, StreamingQuery, StreamPipeWriterInfo, SparkSession]

Inherited from BaseGenericMutantOperator[StreamPipeWriterInfo, DataFrame, (DataFrame) ⇒ StreamingQuery]

Inherited from BaseDoer

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped