case class WriteIntoDelta(deltaLog: DeltaLog, mode: SaveMode, options: DeltaOptions, partitionColumns: Seq[String], configuration: Map[String, String], data: DataFrame) extends LogicalPlan with RunnableCommand with ImplicitMetadataOperation with DeltaCommand with Product with Serializable

Used to write a DataFrame into a delta table.

New Table Semantics

  • The schema of the DataFrame is used to initialize the table.
  • The partition columns will be used to partition the table.

Existing Table Semantics

  • The save mode will control how existing data is handled (i.e. overwrite, append, etc)
  • The schema of the DataFrame will be checked and if there are new columns present they will be added to the tables schema. Conflicting columns (i.e. a INT, and a STRING) will result in an exception
  • The partition columns, if present are validated against the existing metadata. If not present, then the partitioning of the table is respected.

In combination with Overwrite, a replaceWhere option can be used to transactionally replace data that matches a predicate.

Linear Supertypes
Serializable, Serializable, DeltaCommand, ImplicitMetadataOperation, DeltaLogging, DatabricksLogging, DeltaProgressReporter, RunnableCommand, Command, LogicalPlan, Logging, QueryPlanConstraints, ConstraintHelper, LogicalPlanStats, AnalysisHelper, QueryPlan[LogicalPlan], TreeNode[LogicalPlan], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteIntoDelta
  2. Serializable
  3. Serializable
  4. DeltaCommand
  5. ImplicitMetadataOperation
  6. DeltaLogging
  7. DatabricksLogging
  8. DeltaProgressReporter
  9. RunnableCommand
  10. Command
  11. LogicalPlan
  12. Logging
  13. QueryPlanConstraints
  14. ConstraintHelper
  15. LogicalPlanStats
  16. AnalysisHelper
  17. QueryPlan
  18. TreeNode
  19. Product
  20. Equals
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WriteIntoDelta(deltaLog: DeltaLog, mode: SaveMode, options: DeltaOptions, partitionColumns: Seq[String], configuration: Map[String, String], data: DataFrame)

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. lazy val allAttributes: AttributeSeq
    Definition Classes
    QueryPlan
  5. def analyzed: Boolean
    Definition Classes
    AnalysisHelper
  6. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  7. def argString: String
    Definition Classes
    TreeNode
  8. def asCode: String
    Definition Classes
    TreeNode
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def assertNotAnalysisRule(): Unit
    Attributes
    protected
    Definition Classes
    AnalysisHelper
  11. def buildBaseRelation(spark: SparkSession, txn: OptimisticTransaction, actionType: String, rootPath: Path, inputLeafFiles: Seq[String], nameToAddFileMap: Map[String, AddFile]): HadoopFsRelation

    Build a base relation of files that need to be rewritten as part of an update/delete/merge operation.

    Build a base relation of files that need to be rewritten as part of an update/delete/merge operation.

    Attributes
    protected
    Definition Classes
    DeltaCommand
  12. val canMergeSchema: Boolean
    Attributes
    protected
    Definition Classes
    WriteIntoDelta → ImplicitMetadataOperation
  13. val canOverwriteSchema: Boolean
    Attributes
    protected
    Definition Classes
    WriteIntoDelta → ImplicitMetadataOperation
  14. final lazy val canonicalized: LogicalPlan
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  15. def children: Seq[LogicalPlan]
    Definition Classes
    Command → TreeNode
  16. def childrenResolved: Boolean
    Definition Classes
    LogicalPlan
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. def collect[B](pf: PartialFunction[LogicalPlan, B]): Seq[B]
    Definition Classes
    TreeNode
  19. def collectFirst[B](pf: PartialFunction[LogicalPlan, B]): Option[B]
    Definition Classes
    TreeNode
  20. def collectLeaves(): Seq[LogicalPlan]
    Definition Classes
    TreeNode
  21. def conf: SQLConf
    Definition Classes
    QueryPlan
  22. val configuration: Map[String, String]
  23. lazy val constraints: ExpressionSet
    Definition Classes
    QueryPlanConstraints
  24. def constructIsNotNullConstraints(constraints: Set[Expression], output: Seq[Attribute]): Set[Expression]
    Definition Classes
    ConstraintHelper
  25. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  26. val data: DataFrame
  27. val deltaLog: DeltaLog
  28. def doCanonicalize(): LogicalPlan
    Attributes
    protected
    Definition Classes
    QueryPlan
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def expressions: Seq[Expression]
    Definition Classes
    QueryPlan
  31. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def find(f: (LogicalPlan) ⇒ Boolean): Option[LogicalPlan]
    Definition Classes
    TreeNode
  34. def flatMap[A](f: (LogicalPlan) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  35. def foreach(f: (LogicalPlan) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  36. def foreachUp(f: (LogicalPlan) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  37. def generateCandidateFileMap(basePath: Path, candidateFiles: Seq[AddFile]): Map[String, AddFile]

    Generates a map of file names to add file entries for operations where we will need to rewrite files such as delete, merge, update.

    Generates a map of file names to add file entries for operations where we will need to rewrite files such as delete, merge, update. We expect file names to be unique, because each file contains a UUID.

    Attributes
    protected
    Definition Classes
    DeltaCommand
  38. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String, addSuffix: Boolean): StringBuilder
    Definition Classes
    TreeNode
  39. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def getTouchedFile(basePath: Path, filePath: String, nameToAddFileMap: Map[String, AddFile]): AddFile

    Find the AddFile record corresponding to the file that was read as part of a delete/update/merge operation.

    Find the AddFile record corresponding to the file that was read as part of a delete/update/merge operation.

    filePath

    The path to a file. Can be either absolute or relative

    nameToAddFileMap

    Map generated through generateCandidateFileMap()

    Attributes
    protected
    Definition Classes
    DeltaCommand
  41. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  42. def inferAdditionalConstraints(constraints: Set[Expression]): Set[Expression]
    Definition Classes
    ConstraintHelper
  43. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  44. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def innerChildren: Seq[QueryPlan[_]]
    Attributes
    protected
    Definition Classes
    QueryPlan → TreeNode
  46. def inputSet: AttributeSet
    Definition Classes
    QueryPlan
  47. final def invalidateStatsCache(): Unit
    Definition Classes
    LogicalPlanStats
  48. def isCanonicalizedPlan: Boolean
    Attributes
    protected
    Definition Classes
    QueryPlan
  49. def isCatalogTable(analyzer: Analyzer, tableIdent: TableIdentifier): Boolean

    Use the analyzer to see whether the provided TableIdentifier is for a path based table or not

    Use the analyzer to see whether the provided TableIdentifier is for a path based table or not

    analyzer

    The session state analyzer to call

    tableIdent

    Table Identifier to determine whether is path based or not

    returns

    Boolean where true means that the table is a table in a metastore and false means the table is a path based table

    Definition Classes
    DeltaCommand
  50. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  51. def isPathIdentifier(tableIdent: TableIdentifier): Boolean

    Checks if the given identifier can be for a delta table's path

    Checks if the given identifier can be for a delta table's path

    tableIdent

    Table Identifier for which to check

    Attributes
    protected
    Definition Classes
    DeltaCommand
  52. def isStreaming: Boolean
    Definition Classes
    LogicalPlan
  53. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  54. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  55. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  56. def logConsole(line: String): Unit
    Definition Classes
    DatabricksLogging
  57. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  64. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def makeCopy(newArgs: Array[AnyRef]): LogicalPlan
    Definition Classes
    TreeNode
  69. def map[A](f: (LogicalPlan) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  70. def mapChildren(f: (LogicalPlan) ⇒ LogicalPlan): LogicalPlan
    Definition Classes
    TreeNode
  71. def mapExpressions(f: (Expression) ⇒ Expression): WriteIntoDelta.this.type
    Definition Classes
    QueryPlan
  72. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  73. def maxRows: Option[Long]
    Definition Classes
    LogicalPlan
  74. def maxRowsPerPartition: Option[Long]
    Definition Classes
    LogicalPlan
  75. lazy val metrics: Map[String, SQLMetric]
    Definition Classes
    RunnableCommand
  76. def missingInput: AttributeSet
    Definition Classes
    QueryPlan
  77. val mode: SaveMode
  78. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  79. def nodeName: String
    Definition Classes
    TreeNode
  80. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  81. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. def numberedTreeString: String
    Definition Classes
    TreeNode
  83. val options: DeltaOptions
  84. val origin: Origin
    Definition Classes
    TreeNode
  85. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  86. def output: Seq[Attribute]
    Definition Classes
    Command → QueryPlan
  87. def outputOrdering: Seq[SortOrder]
    Definition Classes
    LogicalPlan
  88. def outputSet: AttributeSet
    Definition Classes
    QueryPlan
  89. def p(number: Int): LogicalPlan
    Definition Classes
    TreeNode
  90. def parsePartitionPredicates(spark: SparkSession, predicate: String): Seq[Expression]

    Converts string predicates into Expressions relative to a transaction.

    Converts string predicates into Expressions relative to a transaction.

    Attributes
    protected
    Definition Classes
    DeltaCommand
    Exceptions thrown

    AnalysisException if a non-partition column is referenced.

  91. val partitionColumns: Seq[String]
  92. def prettyJson: String
    Definition Classes
    TreeNode
  93. def printSchema(): Unit
    Definition Classes
    QueryPlan
  94. def producedAttributes: AttributeSet
    Definition Classes
    QueryPlan
  95. def recordDeltaEvent(deltaLog: DeltaLog, opType: String, tags: Map[TagDefinition, String] = Map.empty, data: AnyRef = null): Unit

    Used to record the occurrence of a single event or report detailed, operation specific statistics.

    Used to record the occurrence of a single event or report detailed, operation specific statistics.

    Attributes
    protected
    Definition Classes
    DeltaLogging
  96. def recordDeltaOperation[A](deltaLog: DeltaLog, opType: String, tags: Map[TagDefinition, String] = Map.empty)(thunk: ⇒ A): A

    Used to report the duration as well as the success or failure of an operation.

    Used to report the duration as well as the success or failure of an operation.

    Attributes
    protected
    Definition Classes
    DeltaLogging
  97. def recordEvent(metric: MetricDefinition, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  98. def recordOperation[S](opType: OpType, opTarget: String = null, extraTags: Map[TagDefinition, String], isSynchronous: Boolean = true, alwaysRecordStats: Boolean = false, allowAuthTags: Boolean = false, killJvmIfStuck: Boolean = false, outputMetric: MetricDefinition = null, silent: Boolean = true)(thunk: ⇒ S): S
    Definition Classes
    DatabricksLogging
  99. def recordUsage(metric: MetricDefinition, quantity: Double, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, forceSample: Boolean = false, trimBlob: Boolean = true, silent: Boolean = false): Unit
    Definition Classes
    DatabricksLogging
  100. def references: AttributeSet
    Definition Classes
    QueryPlan
  101. def refresh(): Unit
    Definition Classes
    LogicalPlan
  102. def removeFilesFromPaths(deltaLog: DeltaLog, nameToAddFileMap: Map[String, AddFile], filesToRewrite: Seq[String], operationTimestamp: Long): Seq[RemoveFile]

    This method provides the RemoveFile actions that are necessary for files that are touched and need to be rewritten in methods like Delete, Update, and Merge.

    This method provides the RemoveFile actions that are necessary for files that are touched and need to be rewritten in methods like Delete, Update, and Merge.

    deltaLog

    The DeltaLog of the table that is being operated on

    nameToAddFileMap

    A map generated using generateCandidateFileMap.

    filesToRewrite

    Absolute paths of the files that were touched. We will search for these in candidateFiles. Obtained as the output of the input_file_name function.

    operationTimestamp

    The timestamp of the operation

    Attributes
    protected
    Definition Classes
    DeltaCommand
  103. def resolve(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]
    Definition Classes
    LogicalPlan
  104. def resolve(schema: StructType, resolver: Resolver): Seq[Attribute]
    Definition Classes
    LogicalPlan
  105. def resolveChildren(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]
    Definition Classes
    LogicalPlan
  106. def resolveExpressions(r: PartialFunction[Expression, Expression]): LogicalPlan
    Definition Classes
    AnalysisHelper
  107. def resolveIdentifier(analyzer: Analyzer, identifier: TableIdentifier): LogicalPlan

    Use the analyzer to resolve the identifier provided

    Use the analyzer to resolve the identifier provided

    analyzer

    The session state analyzer to call

    identifier

    Table Identifier to determine whether is path based or not

    Attributes
    protected
    Definition Classes
    DeltaCommand
  108. def resolveOperators(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  109. def resolveOperatorsDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  110. def resolveOperatorsUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  111. def resolveQuoted(name: String, resolver: Resolver): Option[NamedExpression]
    Definition Classes
    LogicalPlan
  112. lazy val resolved: Boolean
    Definition Classes
    LogicalPlan
  113. def run(sparkSession: SparkSession): Seq[Row]
    Definition Classes
    WriteIntoDelta → RunnableCommand
  114. final def sameResult(other: LogicalPlan): Boolean
    Definition Classes
    QueryPlan
  115. lazy val schema: StructType
    Definition Classes
    QueryPlan
  116. def schemaString: String
    Definition Classes
    QueryPlan
  117. final def semanticHash(): Int
    Definition Classes
    QueryPlan
  118. def simpleString: String
    Definition Classes
    QueryPlan → TreeNode
  119. def statePrefix: String
    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan
  120. def stats: Statistics
    Definition Classes
    LogicalPlanStats
  121. val statsCache: Option[Statistics]
    Attributes
    protected
    Definition Classes
    LogicalPlanStats
  122. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  123. def subqueries: Seq[LogicalPlan]
    Definition Classes
    QueryPlan
  124. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  125. def toJSON: String
    Definition Classes
    TreeNode
  126. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  127. def transform(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    TreeNode
  128. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): WriteIntoDelta.this.type
    Definition Classes
    AnalysisHelper → QueryPlan
  129. def transformDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper → TreeNode
  130. def transformExpressions(rule: PartialFunction[Expression, Expression]): WriteIntoDelta.this.type
    Definition Classes
    QueryPlan
  131. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): WriteIntoDelta.this.type
    Definition Classes
    QueryPlan
  132. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): WriteIntoDelta.this.type
    Definition Classes
    QueryPlan
  133. def transformUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper → TreeNode
  134. def treeString(verbose: Boolean, addSuffix: Boolean): String
    Definition Classes
    TreeNode
  135. def treeString: String
    Definition Classes
    TreeNode
  136. final def updateMetadata(spark: SparkSession, txn: OptimisticTransaction, schema: StructType, partitionColumns: Seq[String], configuration: Map[String, String], isOverwriteMode: Boolean, rearrangeOnly: Boolean): Unit
    Attributes
    protected
    Definition Classes
    ImplicitMetadataOperation
  137. final def updateMetadata(txn: OptimisticTransaction, data: Dataset[_], partitionColumns: Seq[String], configuration: Map[String, String], isOverwriteMode: Boolean, rearrangeOnly: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    ImplicitMetadataOperation
  138. def validConstraints: Set[Expression]
    Attributes
    protected
    Definition Classes
    QueryPlanConstraints
  139. def verboseString: String
    Definition Classes
    QueryPlan → TreeNode
  140. def verboseStringWithSuffix: String
    Definition Classes
    LogicalPlan → TreeNode
  141. def verifyPartitionPredicates(spark: SparkSession, partitionColumns: Seq[String], predicates: Seq[Expression]): Unit
    Attributes
    protected
    Definition Classes
    DeltaCommand
  142. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  143. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  145. def withNewChildren(newChildren: Seq[LogicalPlan]): LogicalPlan
    Definition Classes
    TreeNode
  146. def withStatusCode[T](statusCode: String, defaultMessage: String, data: Map[String, Any] = Map.empty)(body: ⇒ T): T

    Report a log to indicate some command is running.

    Report a log to indicate some command is running.

    Definition Classes
    DeltaProgressReporter
  147. def write(txn: OptimisticTransaction, sparkSession: SparkSession): Seq[Action]

Inherited from Serializable

Inherited from Serializable

Inherited from DeltaCommand

Inherited from ImplicitMetadataOperation

Inherited from DeltaLogging

Inherited from DatabricksLogging

Inherited from DeltaProgressReporter

Inherited from RunnableCommand

Inherited from Command

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlanConstraints

Inherited from ConstraintHelper

Inherited from LogicalPlanStats

Inherited from AnalysisHelper

Inherited from QueryPlan[LogicalPlan]

Inherited from TreeNode[LogicalPlan]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped