Packages

c

org.apache.spark.sql.delta.commands

ConvertToDeltaCommandBase

abstract class ConvertToDeltaCommandBase extends LogicalPlan with LeafRunnableCommand with DeltaCommand

Convert an existing parquet table to a delta table by creating delta logs based on existing files. Here are the main components:

  • File Listing: Launch a spark job to list files from a given directory in parallel.
  • Schema Inference: Given an iterator on the file list result, we group the iterator into sequential batches and launch a spark job to infer schema for each batch, and finally merge schemas from all batches.
  • Stats collection: Again, we group the iterator on file list results into sequential batches and launch a spark job to collect stats for each batch.
  • Commit the files: We take the iterator of files with stats and write out a delta log file as the first commit. This bypasses the transaction protocol, but it's ok as this would be the very first commit.
Linear Supertypes
DeltaCommand, DeltaCommandInvariants, DeltaLogging, DatabricksLogging, DeltaProgressReporter, LoggingShims, LeafRunnableCommand, LeafLike[LogicalPlan], RunnableCommand, Command, LogicalPlan, Logging, QueryPlanConstraints, ConstraintHelper, LogicalPlanDistinctKeys, LogicalPlanStats, AnalysisHelper, QueryPlan[LogicalPlan], SQLConfHelper, TreeNode[LogicalPlan], WithOrigin, TreePatternBits, Product, Equals, AnyRef, Any
Known Subclasses
ConvertToDeltaCommand
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConvertToDeltaCommandBase
  2. DeltaCommand
  3. DeltaCommandInvariants
  4. DeltaLogging
  5. DatabricksLogging
  6. DeltaProgressReporter
  7. LoggingShims
  8. LeafRunnableCommand
  9. LeafLike
  10. RunnableCommand
  11. Command
  12. LogicalPlan
  13. Logging
  14. QueryPlanConstraints
  15. ConstraintHelper
  16. LogicalPlanDistinctKeys
  17. LogicalPlanStats
  18. AnalysisHelper
  19. QueryPlan
  20. SQLConfHelper
  21. TreeNode
  22. WithOrigin
  23. TreePatternBits
  24. Product
  25. Equals
  26. AnyRef
  27. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConvertToDeltaCommandBase(tableIdentifier: TableIdentifier, partitionSchema: Option[StructType], collectStats: Boolean, deltaPath: Option[String])

    tableIdentifier

    the target parquet table.

    partitionSchema

    the partition schema of the table, required when table is partitioned.

    collectStats

    Should collect column stats per file on convert.

    deltaPath

    if provided, the delta log will be written to this location.

Type Members

  1. case class ConvertTarget(catalogTable: Option[CatalogTable], provider: Option[String], targetDir: String, properties: Map[String, String]) extends Product with Serializable
    Attributes
    protected
  2. implicit class LogStringContext extends AnyRef
    Definition Classes
    Logging

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def productArity: Int
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any
    Definition Classes
    Product

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. def allAttributes: AttributeSeq
    Definition Classes
    QueryPlan
  5. def analyzed: Boolean
    Definition Classes
    AnalysisHelper
  6. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  7. def argString(maxFields: Int): 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. def canonicalized: LogicalPlan
    Definition Classes
    QueryPlan
  13. def checkCommandInvariant(invariant: () => Boolean, label: String, op: Operation, deltaLog: DeltaLog, parameters: => Map[String, Long], additionalInfo: => Map[String, String] = Map.empty): Unit

    Evaluate that invariant "holds" (evaluates to true) or log the violation.

    Evaluate that invariant "holds" (evaluates to true) or log the violation.

    invariant

    The invariant to evaluate.

    label

    It's suggested to make label the same text as invariant so it's easy to see in the logs what was evaluated.

    op

    Operation name.

    deltaLog

    Delta log of the table this invariant is evaluated on.

    parameters

    Parameters that were used to evaluate the invariant.

    additionalInfo

    Additional info to be included in usage logs.

    Attributes
    protected
    Definition Classes
    DeltaCommandInvariants
  14. final def children: Seq[LogicalPlan]
    Definition Classes
    LeafLike
  15. def childrenResolved: Boolean
    Definition Classes
    LogicalPlan
  16. def clone(): LogicalPlan
    Definition Classes
    AnalysisHelper → TreeNode → AnyRef
  17. def collect[B](pf: PartialFunction[LogicalPlan, B]): Seq[B]
    Definition Classes
    TreeNode
  18. def collectFirst[B](pf: PartialFunction[LogicalPlan, B]): Option[B]
    Definition Classes
    TreeNode
  19. def collectLeaves(): Seq[LogicalPlan]
    Definition Classes
    TreeNode
  20. def collectWithSubqueries[B](f: PartialFunction[LogicalPlan, B]): Seq[B]
    Definition Classes
    QueryPlan
  21. def conf: SQLConf
    Definition Classes
    SQLConfHelper
  22. lazy val constraints: ExpressionSet
    Definition Classes
    QueryPlanConstraints
  23. def constructIsNotNullConstraints(constraints: ExpressionSet, output: Seq[Attribute]): ExpressionSet
    Definition Classes
    ConstraintHelper
  24. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  25. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  26. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  27. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  28. def copyTagsFrom(other: LogicalPlan): Unit
    Definition Classes
    TreeNode
  29. def createDeltaActions(spark: SparkSession, manifest: ConvertTargetFileManifest, partitionSchema: StructType, txn: OptimisticTransaction, fs: FileSystem): Iterator[AddFile]

    Given the file manifest, create corresponding AddFile actions for the entire list of files.

    Given the file manifest, create corresponding AddFile actions for the entire list of files.

    Attributes
    protected
  30. def createSetTransaction(sparkSession: SparkSession, deltaLog: DeltaLog, options: Option[DeltaOptions] = None): Option[SetTransaction]

    Returns SetTransaction if a valid app ID and version are present.

    Returns SetTransaction if a valid app ID and version are present. Otherwise returns an empty list.

    Attributes
    protected
    Definition Classes
    DeltaCommand
  31. def deltaAssert(check: => Boolean, name: String, msg: String, deltaLog: DeltaLog = null, data: AnyRef = null, path: Option[Path] = None): Unit

    Helper method to check invariants in Delta code.

    Helper method to check invariants in Delta code. Fails when running in tests, records a delta assertion event and logs a warning otherwise.

    Attributes
    protected
    Definition Classes
    DeltaLogging
  32. def deterministic: Boolean
    Definition Classes
    QueryPlan
  33. lazy val distinctKeys: Set[ExpressionSet]
    Definition Classes
    LogicalPlanDistinctKeys
  34. def doCanonicalize(): LogicalPlan
    Attributes
    protected
    Definition Classes
    QueryPlan
  35. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  37. def exists(f: (LogicalPlan) => Boolean): Boolean
    Definition Classes
    TreeNode
  38. final def expressions: Seq[Expression]
    Definition Classes
    QueryPlan
  39. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  40. def find(f: (LogicalPlan) => Boolean): Option[LogicalPlan]
    Definition Classes
    TreeNode
  41. def flatMap[A](f: (LogicalPlan) => IterableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  42. def foreach(f: (LogicalPlan) => Unit): Unit
    Definition Classes
    TreeNode
  43. def foreachUp(f: (LogicalPlan) => Unit): Unit
    Definition Classes
    TreeNode
  44. def foreachWithSubqueries(f: (LogicalPlan) => Unit): Unit
    Definition Classes
    QueryPlan
  45. def formattedNodeName: String
    Attributes
    protected
    Definition Classes
    QueryPlan
  46. 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.

    Definition Classes
    DeltaCommand
  47. def generateTreeString(depth: Int, lastChildren: ArrayList[Boolean], append: (String) => Unit, verbose: Boolean, prefix: String, addSuffix: Boolean, maxFields: Int, printNodeId: Boolean, indent: Int): Unit
    Definition Classes
    TreeNode
  48. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  49. def getCommonTags(deltaLog: DeltaLog, tahoeId: String): Map[TagDefinition, String]
    Definition Classes
    DeltaLogging
  50. def getContext: Map[String, String]
    Attributes
    protected
  51. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  52. def getDeltaLog(spark: SparkSession, path: Option[String], tableIdentifier: Option[TableIdentifier], operationName: String, hadoopConf: Map[String, String] = Map.empty): DeltaLog

    Utility method to return the DeltaLog of an existing Delta table referred by either the given path or tableIdentifier.

    Utility method to return the DeltaLog of an existing Delta table referred by either the given path or tableIdentifier.

    spark

    SparkSession reference to use.

    path

    Table location. Expects a non-empty tableIdentifier or path.

    tableIdentifier

    Table identifier. Expects a non-empty tableIdentifier or path.

    operationName

    Operation that is getting the DeltaLog, used in error messages.

    hadoopConf

    Hadoop file system options used to build DeltaLog.

    returns

    DeltaLog of the table

    Attributes
    protected
    Definition Classes
    DeltaCommand
    Exceptions thrown

    AnalysisException If either no Delta table exists at the given path/identifier or there is neither path nor tableIdentifier is provided.

  53. def getDeltaTable(target: LogicalPlan, cmd: String): DeltaTableV2

    Extracts the DeltaTableV2 from a LogicalPlan iff the LogicalPlan is a ResolvedTable with either a DeltaTableV2 or a V1Table that is referencing a Delta table.

    Extracts the DeltaTableV2 from a LogicalPlan iff the LogicalPlan is a ResolvedTable with either a DeltaTableV2 or a V1Table that is referencing a Delta table. In all other cases this method will throw a "Table not found" exception.

    Definition Classes
    DeltaCommand
  54. def getDeltaTablePathOrIdentifier(target: LogicalPlan, cmd: String): (Option[TableIdentifier], Option[String])

    Helper method to extract the table id or path from a LogicalPlan representing a Delta table.

    Helper method to extract the table id or path from a LogicalPlan representing a Delta table. This uses DeltaCommand.getDeltaTable to convert the LogicalPlan to a DeltaTableV2 and then extracts either the path or identifier from it. If the DeltaTableV2 has a CatalogTable, the table identifier will be returned. Otherwise, the table's path will be returned. Throws an exception if the LogicalPlan does not represent a Delta table.

    Definition Classes
    DeltaCommand
  55. def getErrorData(e: Throwable): Map[String, Any]
    Definition Classes
    DeltaLogging
  56. def getMetadataAttributeByName(name: String): AttributeReference
    Definition Classes
    LogicalPlan
  57. def getMetadataAttributeByNameOpt(name: String): Option[AttributeReference]
    Definition Classes
    LogicalPlan
  58. def getOperation(numFilesConverted: Long, convertProperties: ConvertTarget, sourceFormat: String): Operation

    Get the operation to store in the commit message.

    Get the operation to store in the commit message.

    Attributes
    protected
  59. def getTableCatalogTable(target: LogicalPlan, cmd: String): Option[CatalogTable]

    Extracts CatalogTable metadata from a LogicalPlan if the plan is a ResolvedTable.

    Extracts CatalogTable metadata from a LogicalPlan if the plan is a ResolvedTable. The table can be a non delta table.

    Definition Classes
    DeltaCommand
  60. def getTablePathOrIdentifier(target: LogicalPlan, cmd: String): (Option[TableIdentifier], Option[String])

    Helper method to extract the table id or path from a LogicalPlan representing a resolved table or path.

    Helper method to extract the table id or path from a LogicalPlan representing a resolved table or path. This calls getDeltaTablePathOrIdentifier if the resolved table is a delta table. For non delta table with identifier, we extract its identifier. For non delta table with path, it expects the path to be wrapped in an ResolvedPathBasedNonDeltaTable and extracts it from there.

    Definition Classes
    DeltaCommand
  61. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  62. def getTargetTable(spark: SparkSession, target: ConvertTarget): ConvertTargetTable

    Get the instance of the convert target table, which provides file manifest and schema

    Get the instance of the convert target table, which provides file manifest and schema

    Attributes
    protected
  63. def getTouchedFile(basePath: Path, escapedFilePath: 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.

    basePath

    The path of the table. Must not be escaped.

    escapedFilePath

    The path to a file that can be either absolute or relative. All special chars in this path must be already escaped by URI standards.

    nameToAddFileMap

    Map generated through generateCandidateFileMap().

    Definition Classes
    DeltaCommand
  64. def hasBeenExecuted(txn: OptimisticTransaction, sparkSession: SparkSession, options: Option[DeltaOptions] = None): Boolean

    Returns true if there is information in the spark session that indicates that this write has already been successfully written.

    Returns true if there is information in the spark session that indicates that this write has already been successfully written.

    Attributes
    protected
    Definition Classes
    DeltaCommand
  65. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  66. lazy val height: Int
    Definition Classes
    TreeNode
  67. lazy val icebergEnabled: Boolean
    Attributes
    protected
  68. def inferAdditionalConstraints(constraints: ExpressionSet): ExpressionSet
    Definition Classes
    ConstraintHelper
  69. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  70. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def innerChildren: Seq[QueryPlan[_]]
    Definition Classes
    QueryPlan → TreeNode
  72. def inputSet: AttributeSet
    Definition Classes
    QueryPlan
  73. final def invalidateStatsCache(): Unit
    Definition Classes
    LogicalPlanStats
  74. def isCanonicalizedPlan: Boolean
    Attributes
    protected
    Definition Classes
    QueryPlan
  75. def isCatalogTable(analyzer: Analyzer, tableIdent: TableIdentifier): Boolean

    Calls DeltaCommand.isCatalogTable.

    Calls DeltaCommand.isCatalogTable. With Convert, we may get a format check error in cases where the metastore and the underlying table don't align, e.g. external table where the underlying files are converted to delta but the metadata has not been converted yet. In these cases, catch the error and return based on whether the provided Table Identifier could reasonably be a path

    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
    ConvertToDeltaCommandBase → DeltaCommand
  76. def isIcebergPathProvider(provider: String): Boolean
    Attributes
    protected
  77. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  78. def isParquetPathProvider(provider: String): Boolean
    Attributes
    protected
  79. def isPathIdentifier(tableIdent: TableIdentifier): Boolean

    Override this method since parquet paths are valid for Convert

    Override this method since parquet paths are valid for Convert

    tableIdent

    the provided table or path

    returns

    Whether or not the ident provided can refer to a table by path

    Definition Classes
    ConvertToDeltaCommandBase → DeltaCommand
  80. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  81. def isStreaming: Boolean
    Definition Classes
    LogicalPlan
  82. def isSupportedPathTableProvider(provider: String): Boolean
    Attributes
    protected
  83. def isTagsEmpty: Boolean
    Definition Classes
    TreeNode
  84. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  85. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  86. final def legacyWithNewChildren(newChildren: Seq[LogicalPlan]): LogicalPlan
    Attributes
    protected
    Definition Classes
    TreeNode
  87. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  88. def logConsole(line: String): Unit
    Definition Classes
    DatabricksLogging
  89. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  94. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  95. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  96. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  97. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  98. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  99. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  100. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  101. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  102. def logNumRecordsMismatch(deltaLog: DeltaLog, actions: Seq[Action], stats: NumRecordsStats, op: Operation): Unit
    Attributes
    protected
    Definition Classes
    DeltaCommand
  103. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  104. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  105. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  106. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  107. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  108. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  109. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  110. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  111. def makeCopy(newArgs: Array[AnyRef]): LogicalPlan
    Definition Classes
    TreeNode
  112. def map[A](f: (LogicalPlan) => A): Seq[A]
    Definition Classes
    TreeNode
  113. final def mapChildren(f: (LogicalPlan) => LogicalPlan): LogicalPlan
    Definition Classes
    LeafLike
  114. def mapExpressions(f: (Expression) => Expression): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  115. def mapProductIterator[B](f: (Any) => B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  116. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  117. def maxRows: Option[Long]
    Definition Classes
    LogicalPlan
  118. def maxRowsPerPartition: Option[Long]
    Definition Classes
    LogicalPlan
  119. def metadataOutput: Seq[Attribute]
    Definition Classes
    LogicalPlan
  120. lazy val metrics: Map[String, SQLMetric]
    Definition Classes
    ConvertToDeltaCommandBase → RunnableCommand
  121. final def missingInput: AttributeSet
    Definition Classes
    QueryPlan
  122. def multiTransformDown(rule: PartialFunction[LogicalPlan, Seq[LogicalPlan]]): LazyList[LogicalPlan]
    Definition Classes
    TreeNode
  123. def multiTransformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[LogicalPlan, Seq[LogicalPlan]]): LazyList[LogicalPlan]
    Definition Classes
    TreeNode
  124. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  125. def nodeName: String
    Definition Classes
    TreeNode
  126. final val nodePatterns: Seq[TreePattern]
    Definition Classes
    Command → TreeNode
  127. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  128. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  129. def numberedTreeString: String
    Definition Classes
    TreeNode
  130. val origin: Origin
    Definition Classes
    TreeNode → WithOrigin
  131. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  132. def output: Seq[Attribute]
    Definition Classes
    Command → QueryPlan
  133. def outputOrdering: Seq[SortOrder]
    Definition Classes
    QueryPlan
  134. def outputSet: AttributeSet
    Definition Classes
    QueryPlan
  135. def p(number: Int): LogicalPlan
    Definition Classes
    TreeNode
  136. def parsePredicates(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.

  137. def performStatsCollection(spark: SparkSession, txn: OptimisticTransaction, addFiles: Seq[AddFile]): Iterator[AddFile]
    Attributes
    protected
  138. def prettyJson: String
    Definition Classes
    TreeNode
  139. def printSchema(): Unit
    Definition Classes
    QueryPlan
  140. def producedAttributes: AttributeSet
    Definition Classes
    Command → QueryPlan
  141. def productElementName(n: Int): String
    Definition Classes
    Product
  142. def productElementNames: Iterator[String]
    Definition Classes
    Product
  143. def productIterator: Iterator[Any]
    Definition Classes
    Product
  144. def productPrefix: String
    Definition Classes
    Product
  145. def recordDeltaEvent(deltaLog: DeltaLog, opType: String, tags: Map[TagDefinition, String] = Map.empty, data: AnyRef = null, path: Option[Path] = None): 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.

    path

    Used to log the path of the delta table when deltaLog is null.

    Attributes
    protected
    Definition Classes
    DeltaLogging
  146. 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 on a deltaLog.

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

    Attributes
    protected
    Definition Classes
    DeltaLogging
  147. def recordDeltaOperationForTablePath[A](tablePath: String, 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 on a tahoePath.

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

    Attributes
    protected
    Definition Classes
    DeltaLogging
  148. def recordEvent(metric: MetricDefinition, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  149. def recordFrameProfile[T](group: String, name: String)(thunk: => T): T
    Attributes
    protected
    Definition Classes
    DeltaLogging
  150. 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 = METRIC_OPERATION_DURATION, silent: Boolean = true)(thunk: => S): S
    Definition Classes
    DatabricksLogging
  151. def recordProductEvent(metric: MetricDefinition with CentralizableMetric, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  152. def recordProductUsage(metric: MetricDefinition with CentralizableMetric, quantity: Double, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, forceSample: Boolean = false, trimBlob: Boolean = true, silent: Boolean = false): Unit
    Definition Classes
    DatabricksLogging
  153. 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
  154. def references: AttributeSet
    Definition Classes
    QueryPlan
  155. def refresh(): Unit
    Definition Classes
    LogicalPlan
  156. 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
  157. def resolve(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]
    Definition Classes
    LogicalPlan
  158. def resolve(schema: StructType, resolver: Resolver): Seq[Attribute]
    Definition Classes
    LogicalPlan
  159. def resolveChildren(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]
    Definition Classes
    LogicalPlan
  160. def resolveExpressions(r: PartialFunction[Expression, Expression]): LogicalPlan
    Definition Classes
    AnalysisHelper
  161. def resolveExpressionsDown(r: PartialFunction[Expression, Expression]): LogicalPlan
    Definition Classes
    AnalysisHelper
  162. def resolveExpressionsDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): LogicalPlan
    Definition Classes
    AnalysisHelper
  163. def resolveExpressionsUp(r: PartialFunction[Expression, Expression]): LogicalPlan
    Definition Classes
    AnalysisHelper
  164. def resolveExpressionsUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): LogicalPlan
    Definition Classes
    AnalysisHelper
  165. def resolveExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): LogicalPlan
    Definition Classes
    AnalysisHelper
  166. 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
  167. def resolveOperators(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  168. def resolveOperatorsDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  169. def resolveOperatorsDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  170. def resolveOperatorsUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  171. def resolveOperatorsUpWithNewOutput(rule: PartialFunction[LogicalPlan, (LogicalPlan, Seq[(Attribute, Attribute)])]): LogicalPlan
    Definition Classes
    AnalysisHelper
  172. def resolveOperatorsUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  173. def resolveOperatorsUpWithSubqueriesAndPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  174. def resolveOperatorsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper
  175. def resolveQuoted(name: String, resolver: Resolver): Option[NamedExpression]
    Definition Classes
    LogicalPlan
  176. lazy val resolved: Boolean
    Definition Classes
    LogicalPlan
  177. def rewriteAttrs(attrMap: AttributeMap[Attribute]): LogicalPlan
    Definition Classes
    QueryPlan
  178. def run(spark: SparkSession): Seq[Row]
    Definition Classes
    ConvertToDeltaCommandBase → RunnableCommand
  179. def sameOutput(other: LogicalPlan): Boolean
    Definition Classes
    LogicalPlan
  180. final def sameResult(other: LogicalPlan): Boolean
    Definition Classes
    QueryPlan
  181. def schema: StructType
    Definition Classes
    QueryPlan
  182. def schemaString: String
    Definition Classes
    QueryPlan
  183. final def semanticHash(): Int
    Definition Classes
    QueryPlan
  184. def sendDriverMetrics(spark: SparkSession, metrics: Map[String, SQLMetric]): Unit

    Send the driver-side metrics.

    Send the driver-side metrics.

    This is needed to make the SQL metrics visible in the Spark UI. All metrics are default initialized with 0 so that's what we're reporting in case we skip an already executed action.

    Attributes
    protected
    Definition Classes
    DeltaCommand
  185. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  186. def simpleString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  187. def simpleStringWithNodeId(): String
    Definition Classes
    QueryPlan → TreeNode
  188. def statePrefix: String
    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan
  189. def stats: Statistics
    Definition Classes
    Command → LogicalPlanStats
  190. val statsCache: Option[Statistics]
    Attributes
    protected
    Definition Classes
    LogicalPlanStats
  191. lazy val statsEnabled: Boolean
    Attributes
    protected
  192. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  193. def subqueries: Seq[LogicalPlan]
    Definition Classes
    QueryPlan
  194. def subqueriesAll: Seq[LogicalPlan]
    Definition Classes
    QueryPlan
  195. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  196. def toJSON: String
    Definition Classes
    TreeNode
  197. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  198. def transform(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    TreeNode
  199. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  200. def transformAllExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    AnalysisHelper → QueryPlan
  201. def transformAllExpressionsWithSubqueries(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  202. def transformDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    TreeNode
  203. def transformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper → TreeNode
  204. def transformDownWithSubqueries(f: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    QueryPlan
  205. def transformDownWithSubqueriesAndPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(f: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    QueryPlan
  206. def transformExpressions(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  207. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  208. def transformExpressionsDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  209. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  210. def transformExpressionsUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  211. def transformExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): ConvertToDeltaCommandBase.this.type
    Definition Classes
    QueryPlan
  212. def transformUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    TreeNode
  213. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (LogicalPlan) => Boolean, ruleId: RuleId)(rule: PartialFunction[(LogicalPlan, LogicalPlan), LogicalPlan]): LogicalPlan
    Definition Classes
    TreeNode
  214. def transformUpWithNewOutput(rule: PartialFunction[LogicalPlan, (LogicalPlan, Seq[(Attribute, Attribute)])], skipCond: (LogicalPlan) => Boolean, canGetOutput: (LogicalPlan) => Boolean): LogicalPlan
    Definition Classes
    AnalysisHelper → QueryPlan
  215. def transformUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    AnalysisHelper → TreeNode
  216. def transformUpWithSubqueries(f: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    QueryPlan
  217. def transformUpWithSubqueriesAndPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(f: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    QueryPlan
  218. def transformWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    TreeNode
  219. def transformWithSubqueries(f: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan
    Definition Classes
    QueryPlan
  220. lazy val treePatternBits: BitSet
    Definition Classes
    QueryPlan → TreeNode → TreePatternBits
  221. def treeString(append: (String) => Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  222. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  223. final def treeString: String
    Definition Classes
    TreeNode
  224. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  225. def updateOuterReferencesInSubquery(plan: LogicalPlan, attrMap: AttributeMap[Attribute]): LogicalPlan
    Definition Classes
    AnalysisHelper → QueryPlan
  226. lazy val validConstraints: ExpressionSet
    Attributes
    protected
    Definition Classes
    QueryPlanConstraints
  227. def verboseString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  228. def verboseStringWithOperatorId(): String
    Definition Classes
    QueryPlan
  229. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    LogicalPlan → TreeNode
  230. def verifyPartitionPredicates(spark: SparkSession, partitionColumns: Seq[String], predicates: Seq[Expression]): Unit
    Definition Classes
    DeltaCommand
  231. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  232. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  233. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  234. def withLogContext(context: Map[String, String])(body: => Unit): Unit
    Attributes
    protected
    Definition Classes
    Logging
  235. final def withNewChildren(newChildren: Seq[LogicalPlan]): LogicalPlan
    Definition Classes
    TreeNode
  236. def withNewChildrenInternal(newChildren: IndexedSeq[LogicalPlan]): LogicalPlan
    Definition Classes
    LeafLike
  237. def withSQLConf[T](pairs: (String, String)*)(f: => T): T
    Attributes
    protected
    Definition Classes
    SQLConfHelper
  238. 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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from DeltaCommand

Inherited from DeltaCommandInvariants

Inherited from DeltaLogging

Inherited from DatabricksLogging

Inherited from DeltaProgressReporter

Inherited from LoggingShims

Inherited from LeafRunnableCommand

Inherited from LeafLike[LogicalPlan]

Inherited from RunnableCommand

Inherited from Command

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlanConstraints

Inherited from ConstraintHelper

Inherited from LogicalPlanDistinctKeys

Inherited from LogicalPlanStats

Inherited from AnalysisHelper

Inherited from QueryPlan[LogicalPlan]

Inherited from SQLConfHelper

Inherited from TreeNode[LogicalPlan]

Inherited from WithOrigin

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped