case class UpdateCatalog(table: CatalogTable) extends UpdateCatalogBase with Product with Serializable

A post-commit hook that allows us to cache the most recent schema and table properties of a Delta table in an External Catalog. In addition to the schema and table properties, we also store the last commit timestamp and version for which we updated the catalog. This prevents us from updating the MetaStore with potentially stale information.

Linear Supertypes
Serializable, Product, Equals, UpdateCatalogBase, DeltaLogging, DatabricksLogging, DeltaProgressReporter, LoggingShims, Logging, PostCommitHook, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UpdateCatalog
  2. Serializable
  3. Product
  4. Equals
  5. UpdateCatalogBase
  6. DeltaLogging
  7. DatabricksLogging
  8. DeltaProgressReporter
  9. LoggingShims
  10. Logging
  11. PostCommitHook
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new UpdateCatalog(table: CatalogTable)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def clusteringColumnsChanged(snapshot: Snapshot): Boolean

    Check if the clustering columns from snapshot doesn't match what's in the table properties.

    Check if the clustering columns from snapshot doesn't match what's in the table properties.

    Attributes
    protected
    Definition Classes
    UpdateCatalogBase
  7. 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
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def execute(spark: SparkSession, snapshot: Snapshot): Unit

    Update the entry in the Catalog to reflect the latest schema and table properties.

    Update the entry in the Catalog to reflect the latest schema and table properties.

    Attributes
    protected
    Definition Classes
    UpdateCatalogBase
  10. def executeOnWrite(spark: SparkSession, snapshot: Snapshot): Unit

    Used to manually execute an UpdateCatalog hook during a write.

    Used to manually execute an UpdateCatalog hook during a write.

    Definition Classes
    UpdateCatalog → UpdateCatalogBase
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getCommonTags(deltaLog: DeltaLog, tahoeId: String): Map[TagDefinition, String]
    Definition Classes
    DeltaLogging
  14. def getErrorData(e: Throwable): Map[String, Any]
    Definition Classes
    DeltaLogging
  15. def handleError(spark: SparkSession, error: Throwable, version: Long): Unit

    Handle any error caused while running the hook.

    Handle any error caused while running the hook. By default, all errors are ignored as default policy should be to not let post-commit hooks to cause failures in the operation.

    Definition Classes
    PostCommitHook
  16. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  17. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  20. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  21. def logConsole(line: String): Unit
    Definition Classes
    DatabricksLogging
  22. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  23. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  24. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  27. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  28. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  31. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  32. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  35. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  36. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  37. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  40. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  41. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. val name: String

    A user friendly name for the hook for error reporting purposes.

    A user friendly name for the hook for error reporting purposes.

    Definition Classes
    UpdateCatalog → PostCommitHook
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. def productElementNames: Iterator[String]
    Definition Classes
    Product
  48. def propertiesHaveChanged(properties: Map[String, String], metadata: Metadata, spark: SparkSession): Boolean

    Checks if the table properties have changed in the Snapshot with respect to what's stored in the catalog.

    Checks if the table properties have changed in the Snapshot with respect to what's stored in the catalog. We check to see if our table properties are a subset of what is in the MetaStore to avoid flip-flopping the information between older and newer versions of Delta. The assumption here is that newer Delta releases will only add newer table properties and not remove them.

    Attributes
    protected[sql]
    Definition Classes
    UpdateCatalog → UpdateCatalogBase
  49. 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
  50. 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
  51. 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
  52. def recordEvent(metric: MetricDefinition, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  53. def recordFrameProfile[T](group: String, name: String)(thunk: => T): T
    Attributes
    protected
    Definition Classes
    DeltaLogging
  54. 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
  55. def recordProductEvent(metric: MetricDefinition with CentralizableMetric, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  56. 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
  57. 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
  58. def run(spark: SparkSession, txn: OptimisticTransactionImpl, committedVersion: Long, postCommitSnapshot: Snapshot, actions: Seq[Action]): Unit

    Executes the hook.

    Executes the hook.

    txn

    The txn that made the commit, after which this PostCommitHook was run

    committedVersion

    The version that was committed by the txn

    postCommitSnapshot

    the snapshot of the table after the txn successfully committed. NOTE: This may not match the committedVersion, if racing commits were written while the snapshot was computed.

    Definition Classes
    UpdateCatalogBase → PostCommitHook
  59. def schemaHasChanged(snapshot: Snapshot, spark: SparkSession): Boolean

    Checks if the table schema has changed in the Snapshot with respect to what's stored in the catalog.

    Checks if the table schema has changed in the Snapshot with respect to what's stored in the catalog.

    Attributes
    protected
    Definition Classes
    UpdateCatalog → UpdateCatalogBase
  60. def shouldRun(spark: SparkSession, snapshot: Snapshot): Boolean
    Attributes
    protected
    Definition Classes
    UpdateCatalogBase
  61. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  62. val table: CatalogTable
    Definition Classes
    UpdateCatalog → UpdateCatalogBase
  63. def updateProperties(spark: SparkSession, snapshot: Snapshot): Unit

    Update the properties in the catalog based on the provided snapshot.

    Update the properties in the catalog based on the provided snapshot.

    Attributes
    protected
    Definition Classes
    UpdateCatalog → UpdateCatalogBase
  64. def updateSchema(spark: SparkSession, snapshot: Snapshot): Unit

    Update the schema in the catalog based on the provided snapshot.

    Update the schema in the catalog based on the provided snapshot.

    Definition Classes
    UpdateCatalog → UpdateCatalogBase
  65. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from UpdateCatalogBase

Inherited from DeltaLogging

Inherited from DatabricksLogging

Inherited from DeltaProgressReporter

Inherited from LoggingShims

Inherited from Logging

Inherited from PostCommitHook

Inherited from AnyRef

Inherited from Any

Ungrouped