Packages

trait Writer extends Serializable

A trait representing a data writer for writing data from a DataFrame to various data sources. Concrete classes implementing this trait are responsible for writing the data to specific data sources.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
DatasetWriter, DatasourceWriter, BigqueryOutputWriter, CassandraOutputWriter, ConsoleOutputWriter, ElasticsearchOutputWriter, EventHubOutputWriter, FileOutputWriter, IcebergOutputWriter, InstrumentationOutputWriter, JDBCOutputWriter, JDBCQueryWriter, KafkaOutputWriter, MongoDbOutputWriter, OpensearchOutputWriter, PulsarOutputWriter, RedisOutputWriter, RedshiftOutputWriter, SnowflakeOutputWriter
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Writer
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class MissingWriterArgumentException(message: String = "", cause: Throwable = None.orNull) extends Exception with Product with Serializable

Abstract Value Members

  1. abstract def write(dataFrame: DataFrame): Unit

    Abstract method for writing data from the DataFrame to the specified data source.

    Abstract method for writing data from the DataFrame to the specified data source.

    dataFrame

    The DataFrame containing the data to be written.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def getMetastoreUrl(addressInfo: Option[AddressInfo]): String

    Get the metastore URL from the provided AddressInfo.

    Get the metastore URL from the provided AddressInfo.

    addressInfo

    An optional AddressInfo that contains the connection information.

    returns

    The metastore URL as a String.

  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def mergeStreamingConfig(streamingConfig: Option[Streaming], outputOpts: Map[String, AnyRef]): Streaming

    Merge the streaming configuration with the output options for streaming queries.

    Merge the streaming configuration with the output options for streaming queries. This method is used to combine options from both streamingConfig and outputOptions. If the streamingConfig is None, it uses options from the outputOptions and applies default values as needed.

    streamingConfig

    Optional streaming configuration for the streaming query.

    outputOpts

    Output options for the writer.

    returns

    A Streaming object containing the merged streaming configuration.

  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def setMandatoryArguments(mandatoryArgs: String*): Unit

    Set the mandatory arguments required by the writer implementation.

    Set the mandatory arguments required by the writer implementation.

    mandatoryArgs

    The names of mandatory arguments as varargs.

    Attributes
    protected
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. def validateMandatoryArguments(outputOptions: Map[String, Any]): Unit

    Validate if all mandatory arguments are present in the outputOptions map.

    Validate if all mandatory arguments are present in the outputOptions map. If any argument is missing, it throws a MissingWriterArgumentException.

    outputOptions

    The output options map containing the configuration for the writer.

    Exceptions thrown

    MissingWriterArgumentException if any mandatory argument is missing.

  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. def writeStream(dataFrame: DataFrame, streamingConfig: Option[Streaming]): StreamingQuery

    Optional method for writing streaming data from the DataFrame to the specified data source.

    Optional method for writing streaming data from the DataFrame to the specified data source.

    dataFrame

    The DataFrame containing the streaming data to be written.

    streamingConfig

    Optional configuration for the streaming query.

    returns

    A StreamingQuery representing the active streaming query. If streaming is not supported, this method throws an exception.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped