Package org.apache.spark.sql

Enum Class SaveMode

Object
Enum<SaveMode>
org.apache.spark.sql.SaveMode
All Implemented Interfaces:
Serializable, Comparable<SaveMode>, Constable
@Stable public enum SaveMode extends Enum<SaveMode>
SaveMode is used to specify the expected behavior of saving a DataFrame to a data source.
Since:
1.3.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Append
    Append mode means that when saving a DataFrame to a data source, if data/table already exists, contents of the DataFrame are expected to be appended to existing data.
    ErrorIfExists
    ErrorIfExists mode means that when saving a DataFrame to a data source, if data already exists, an exception is expected to be thrown.
    Ignore
    Ignore mode means that when saving a DataFrame to a data source, if data already exists, the save operation is expected to not save the contents of the DataFrame and to not change the existing data.
    Overwrite
    Overwrite mode means that when saving a DataFrame to a data source, if data/table already exists, existing data is expected to be overwritten by the contents of the DataFrame.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SaveMode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SaveMode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • Append

      public static final SaveMode Append
      Append mode means that when saving a DataFrame to a data source, if data/table already exists, contents of the DataFrame are expected to be appended to existing data.
      Since:
      1.3.0

    • Overwrite

      public static final SaveMode Overwrite
      Overwrite mode means that when saving a DataFrame to a data source, if data/table already exists, existing data is expected to be overwritten by the contents of the DataFrame.
      Since:
      1.3.0

    • ErrorIfExists

      public static final SaveMode ErrorIfExists
      ErrorIfExists mode means that when saving a DataFrame to a data source, if data already exists, an exception is expected to be thrown.
      Since:
      1.3.0

    • Ignore

      public static final SaveMode Ignore
      Ignore mode means that when saving a DataFrame to a data source, if data already exists, the save operation is expected to not save the contents of the DataFrame and to not change the existing data.
      Since:
      1.3.0

  • Method Details

    • values

      public static SaveMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SaveMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null