Packages

o

org.apache.spark.sql.delta

DeltaTableUtils

object DeltaTableUtils extends PredicateHelper with DeltaLogging

Linear Supertypes
DeltaLogging, DatabricksLogging, DeltaProgressReporter, LoggingShims, PredicateHelper, Logging, AliasHelper, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeltaTableUtils
  2. DeltaLogging
  3. DatabricksLogging
  4. DeltaProgressReporter
  5. LoggingShims
  6. PredicateHelper
  7. Logging
  8. AliasHelper
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class LogStringContext extends AnyRef
    Definition Classes
    LoggingShims

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. val SPARK_INTERNAL_METADATA_KEYS: Seq[String]

    A list of Spark internal metadata keys that we may save in a Delta table schema unintentionally due to SPARK-43123.

    A list of Spark internal metadata keys that we may save in a Delta table schema unintentionally due to SPARK-43123. We need to remove them before handing over the schema to Spark to avoid Spark interpreting table columns incorrectly.

    Hard-coded strings are used intentionally as we want to capture possible keys used before SPARK-43123 regardless Spark versions. For example, if Spark changes any key string in future after SPARK-43123, the new string won't be leaked, but we still want to clean up the old key.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def buildBalancedPredicate(expressions: Seq[Expression], op: (Expression, Expression) => Expression): Expression
    Attributes
    protected
    Definition Classes
    PredicateHelper
  7. def canEvaluate(expr: Expression, plan: LogicalPlan): Boolean
    Attributes
    protected
    Definition Classes
    PredicateHelper
  8. def canEvaluateWithinJoin(expr: Expression): Boolean
    Attributes
    protected
    Definition Classes
    PredicateHelper
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def containsSubquery(condition: Expression): Boolean

    Check if condition involves a subquery expression.

  11. 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
  12. def dropColumns(spark: SparkSession, target: LogicalPlan, columnsToDrop: Seq[String]): LogicalPlan

    Many Delta meta-queries involve nondeterminstic functions, which interfere with automatic column pruning, so columns can be manually pruned from the scan.

    Many Delta meta-queries involve nondeterminstic functions, which interfere with automatic column pruning, so columns can be manually pruned from the scan. Note that partition columns can never be dropped even if they're not referenced in the rest of the query.

    spark

    the spark session to use

    target

    the logical plan in which drop columns

    columnsToDrop

    columns to drop from the scan

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def extractIfPathContainsTimeTravel(session: SparkSession, path: String, options: Map[String, String]): (String, Option[DeltaTimeTravelSpec])

    Check if the given path contains time travel syntax with the @.

    Check if the given path contains time travel syntax with the @. If the path genuinely exists, return None. If the path doesn't exist, but is specifying time travel, return the DeltaTimeTravelSpec as well as the real path.

  16. def extractPredicatesWithinOutputSet(condition: Expression, outputSet: AttributeSet): Option[Expression]
    Attributes
    protected
    Definition Classes
    PredicateHelper
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. def findDeltaTableRoot(fs: FileSystem, path: Path): Option[Path]

    Finds the root of a Delta table given a path if it exists.

  19. def findDeltaTableRoot(spark: SparkSession, path: Path, options: Map[String, String] = Map.empty): Option[Path]

    Find the root of a Delta table from the provided path.

  20. def findExpressionAndTrackLineageDown(exp: Expression, plan: LogicalPlan): Option[(Expression, LogicalPlan)]
    Definition Classes
    PredicateHelper
  21. def getAliasMap(exprs: Seq[NamedExpression]): AttributeMap[Alias]
    Attributes
    protected
    Definition Classes
    AliasHelper
  22. def getAliasMap(plan: Aggregate): AttributeMap[Alias]
    Attributes
    protected
    Definition Classes
    AliasHelper
  23. def getAliasMap(plan: Project): AttributeMap[Alias]
    Attributes
    protected
    Definition Classes
    AliasHelper
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def getCommonTags(deltaLog: DeltaLog, tahoeId: String): Map[TagDefinition, String]
    Definition Classes
    DeltaLogging
  26. def getErrorData(e: Throwable): Map[String, Any]
    Definition Classes
    DeltaLogging
  27. def getFileMetadataColumn(df: DataFrame): Column

    Finds and returns the file source metadata column from a dataframe

  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  30. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def isCatalogTable(catalog: SessionCatalog, tableIdent: TableIdentifier): Boolean

    Checks whether TableIdentifier is a path or a table name We assume it is a path unless the table and database both exist in the catalog

    Checks whether TableIdentifier is a path or a table name We assume it is a path unless the table and database both exist in the catalog

    catalog

    session catalog used to check whether db/table exist

    tableIdent

    the provided table or path

    returns

    true if using table name, false if using path, error otherwise

  32. def isDeltaTable(spark: SparkSession, path: Path, options: Map[String, String] = Map.empty): Boolean

    Check if the provided path is the root or the children of a Delta table.

  33. def isDeltaTable(spark: SparkSession, tableName: TableIdentifier): Boolean

    Check whether the provided table name is a Delta table based on information from the Catalog.

  34. def isDeltaTable(table: CatalogTable): Boolean

    Check whether this table is a Delta table based on information from the Catalog.

  35. def isHiddenDirectory(partitionColumnNames: Seq[String], pathName: String, shouldIcebergMetadataDirBeHidden: Boolean = true): Boolean

    Whether a path should be hidden for delta-related file operations, such as Vacuum and Fsck.

  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def isLikelySelective(e: Expression): Boolean
    Definition Classes
    PredicateHelper
  38. def isNullIntolerant(expr: Expression): Boolean
    Attributes
    protected
    Definition Classes
    PredicateHelper
  39. def isPredicateMetadataOnly(condition: Expression, partitionColumns: Seq[String], spark: SparkSession): Boolean

    Check if condition can be evaluated using only metadata.

    Check if condition can be evaluated using only metadata. In Delta, this means the condition only references partition columns and involves no subquery.

  40. def isPredicatePartitionColumnsOnly(condition: Expression, partitionColumns: Seq[String], spark: SparkSession): Boolean

    Does the predicate only contains partition columns?

  41. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  42. def isValidPath(tableIdent: TableIdentifier): Boolean

    tableIdent

    the provided table or path

    returns

    whether or not the provided TableIdentifier can specify a path for parquet or delta

  43. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  44. def logConsole(line: String): Unit
    Definition Classes
    DatabricksLogging
  45. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  46. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  47. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  50. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  51. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  54. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  55. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  58. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  59. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  60. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  63. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  64. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  67. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  68. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. def outputWithNullability(output: Seq[Attribute], nonNullAttrExprIds: Seq[ExprId]): Seq[Attribute]
    Attributes
    protected
    Definition Classes
    PredicateHelper
  70. def parseColToTransform(col: String): IdentityTransform
  71. def parseColsToClusterByTransform(cols: Seq[String]): ClusterByTransform
  72. 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
  73. 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
  74. 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
  75. def recordEvent(metric: MetricDefinition, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  76. def recordFrameProfile[T](group: String, name: String)(thunk: => T): T
    Attributes
    protected
    Definition Classes
    DeltaLogging
  77. 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
  78. def recordProductEvent(metric: MetricDefinition with CentralizableMetric, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  79. 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
  80. 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
  81. def removeInternalWriterMetadata(spark: SparkSession, schema: StructType): StructType

    Removes from the given schema all the metadata keys that are not used when reading a Delta table.

    Removes from the given schema all the metadata keys that are not used when reading a Delta table. This includes typically all metadata used by writer-only table features. Note that this also removes all leaked Spark internal metadata.

  82. def removeSparkInternalMetadata(spark: SparkSession, schema: StructType): StructType

    Remove leaked metadata keys from the persisted table schema.

    Remove leaked metadata keys from the persisted table schema. Old versions might leak metadata intentionally. This method removes all possible metadata keys to avoid Spark interpreting table columns incorrectly.

  83. def replaceAlias(expr: Expression, aliasMap: AttributeMap[Alias]): Expression
    Attributes
    protected
    Definition Classes
    AliasHelper
  84. def replaceAliasButKeepName(expr: NamedExpression, aliasMap: AttributeMap[Alias]): NamedExpression
    Attributes
    protected
    Definition Classes
    AliasHelper
  85. def replaceFileFormat(target: LogicalPlan, updatedFileFormat: FileFormat): LogicalPlan

    Update FileFormat for a plan and return the updated plan

    Update FileFormat for a plan and return the updated plan

    target

    Target plan to update

    updatedFileFormat

    Updated file format

    returns

    Updated logical plan

  86. def replaceFileIndex(target: LogicalPlan, fileIndex: FileIndex): LogicalPlan

    Replace the file index in a logical plan and return the updated plan.

    Replace the file index in a logical plan and return the updated plan. It's a common pattern that, in Delta commands, we use data skipping to determine a subset of files that can be affected by the command, so we replace the whole-table file index in the original logical plan with a new index of potentially affected files, while everything else in the original plan, e.g., resolved references, remain unchanged.

    target

    the logical plan in which we replace the file index

    fileIndex

    the new file index

  87. def resolveTimeTravelVersion(conf: SQLConf, deltaLog: DeltaLog, tt: DeltaTimeTravelSpec, canReturnLastCommit: Boolean = false): (Long, String)

    Given a time travel node, resolve which version it is corresponding to for the given table and return the resolved version as well as the access type, i.e.

    Given a time travel node, resolve which version it is corresponding to for the given table and return the resolved version as well as the access type, i.e. by version or timestamp.

  88. def safeConcatPaths(basePath: Path, relativeChildPath: String): Path

    Uses org.apache.hadoop.fs.Path.mergePaths to concatenate a base path and a relative child path.

    Uses org.apache.hadoop.fs.Path.mergePaths to concatenate a base path and a relative child path.

    This method is designed to address two specific issues in Hadoop Path:

    Issue 1: When the base path represents a Uri with an empty path component, such as concatenating "s3://my-bucket" and "childPath". In this case, the child path is converted to an absolute path at the root, i.e. /childPath. This prevents a "URISyntaxException: Relative path in absolute URI", which would be thrown by org.apache.hadoop.fs.Path(Path, String) because it tries to convert the base path to a Uri and then resolve the child on top of it. This is invalid for an empty base path and a relative child path according to the Uri specification, which states that if an authority is defined, the path component needs to be either empty or start with a '/'.

    Issue 2 (only when DeltaSQLConf.DELTA_WORK_AROUND_COLONS_IN_HADOOP_PATHS is true): When the child path contains a special character ':', such as "aaaa:bbbb.csv". This is valid in many file systems such as S3, but is actually ambiguous because it can be parsed either as an absolute path with a scheme ("aaaa") and authority ("bbbb.csv"), or as a relative path with a colon in the name ("aaaa:bbbb.csv"). Hadoop Path will always interpret it as the former, which is not what we want in this case. Therefore, we prepend a '/' to the child path to ensure that it is always interpreted as a relative path. See https://issues.apache.org/jira/browse/HDFS-14762 for more details.

  89. def splitConjunctivePredicates(condition: Expression): Seq[Expression]
    Attributes
    protected
    Definition Classes
    PredicateHelper
  90. def splitDisjunctivePredicates(condition: Expression): Seq[Expression]
    Attributes
    protected
    Definition Classes
    PredicateHelper
  91. def splitMetadataAndDataPredicates(condition: Expression, partitionColumns: Seq[String], spark: SparkSession): (Seq[Expression], Seq[Expression])

    Partition the given condition into two sequence of conjunctive predicates: - predicates that can be evaluated using metadata only.

    Partition the given condition into two sequence of conjunctive predicates: - predicates that can be evaluated using metadata only. - other predicates.

  92. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  93. def toString(): String
    Definition Classes
    AnyRef → Any
  94. def trimAliases(e: Expression): Expression
    Attributes
    protected
    Definition Classes
    AliasHelper
  95. def trimNonTopLevelAliases[T <: Expression](e: T): T
    Attributes
    protected
    Definition Classes
    AliasHelper
  96. val validDeltaTableHadoopPrefixes: List[String]
  97. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  98. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  99. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  100. def withActiveSession[T](spark: SparkSession)(body: => T): T
  101. 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

Inherited from DeltaLogging

Inherited from DatabricksLogging

Inherited from DeltaProgressReporter

Inherited from LoggingShims

Inherited from PredicateHelper

Inherited from Logging

Inherited from AliasHelper

Inherited from AnyRef

Inherited from Any

Ungrouped