Packages

o

org.apache.spark.sql.delta

IdentityColumn

object IdentityColumn extends DeltaLogging

Provide utility methods related to IDENTITY column support for Delta.

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

Type Members

  1. implicit class LogStringContext extends AnyRef
    Definition Classes
    LoggingShims
  2. case class IdentityInfo(start: Long, step: Long, highWaterMark: Option[Long]) extends Product with Serializable

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 allowExplicitInsert(field: StructField): Boolean
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def blockExplicitIdentityColumnInsert(identityColumns: Seq[StructField], insertedColNameParts: Seq[Seq[String]]): Unit
  7. def blockExplicitIdentityColumnInsert(schema: StructType, query: LogicalPlan): Unit
  8. def blockIdentityColumnUpdate(identityColumns: Seq[StructField], updatedColNameParts: Seq[Seq[String]]): Unit
  9. def blockIdentityColumnUpdate(schema: StructType, updatedColNameParts: Seq[Seq[String]]): Unit
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def copySchemaWithMergedHighWaterMarks(deltaLog: DeltaLog, schemaToCopy: StructType, schemaWithHighWaterMarksToMerge: StructType): StructType

    Returns a copy of schemaToCopy in which the high water marks of the identity columns have been merged with the corresponding high water marks of schemaWithHighWaterMarksToMerge.

  12. def createIdentityColumnGenerationExpr(field: StructField): Expression
  13. def createIdentityColumnGenerationExprAsColumn(field: StructField): Column
  14. def createIdentityColumnStatsTracker(spark: SparkSession, hadoopConf: Configuration, path: Path, schema: StructType, statsDataSchema: Seq[Attribute], trackHighWaterMarks: Set[String]): Option[DeltaIdentityColumnStatsTracker]

    Create a stats tracker to collect IDENTITY column high water marks if its values are system generated.

    Create a stats tracker to collect IDENTITY column high water marks if its values are system generated.

    spark

    The SparkSession associated with this query.

    hadoopConf

    The Hadoop configuration object to use on an executor.

    path

    Root Reservoir path

    schema

    The schema of the table to be written into.

    statsDataSchema

    The schema of the output data (this does not include partition columns).

    trackHighWaterMarks

    Column names for which we should track high water marks.

    returns

    The stats tracker.

  15. val defaultStart: Int
  16. val defaultStep: Int
  17. 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
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getCommonTags(deltaLog: DeltaLog, tahoeId: String): Map[TagDefinition, String]
    Definition Classes
    DeltaLogging
  23. def getErrorData(e: Throwable): Map[String, Any]
    Definition Classes
    DeltaLogging
  24. def getIdentityColumns(schema: StructType): Seq[StructField]
  25. def getIdentityInfo(field: StructField): IdentityInfo
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  28. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  31. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  32. def logConsole(line: String): Unit
    Definition Classes
    DatabricksLogging
  33. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  34. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  35. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  38. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  39. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  42. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  43. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  46. def logTableCreation(deltaLog: DeltaLog, schema: StructType): Unit
  47. def logTableWrite(snapshot: Snapshot, generatedIdentityColumns: Set[String], numInsertedRowsOpt: Option[Long]): Unit
  48. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  49. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  50. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logTransactionAbort(deltaLog: DeltaLog): Unit
  53. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  54. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  55. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. val opTypeAbort: String
  61. val opTypeDefinition: String
  62. val opTypeHighWaterMarkUpdate: String
  63. val opTypeWrite: String
  64. 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
  65. 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
  66. 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
  67. def recordEvent(metric: MetricDefinition, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  68. def recordFrameProfile[T](group: String, name: String)(thunk: ⇒ T): T
    Attributes
    protected
    Definition Classes
    DeltaLogging
  69. 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
  70. def recordProductEvent(metric: MetricDefinition with CentralizableMetric, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  71. 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
  72. 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
  73. def roundToNext(start: Long, step: Long, value: Long): Long

    Round value to the next value that follows start and step configuration.

    Round value to the next value that follows start and step configuration.

    Attributes
    protected[delta]
  74. def syncIdentity(deltaLog: DeltaLog, field: StructField, df: DataFrame, allowLoweringHighWaterMarkForSyncIdentity: Boolean): StructField
  75. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  76. def toString(): String
    Definition Classes
    AnyRef → Any
  77. def updateSchema(deltaLog: DeltaLog, schema: StructType, updatedIdentityHighWaterMarks: Seq[(String, Long)]): StructType

    Return a new schema with IDENTITY high water marks updated in the schema.

    Return a new schema with IDENTITY high water marks updated in the schema. The new high watermarks are decided based on the updatedIdentityHighWaterMarks and old high watermark values present in the passed schema.

  78. def updateToValidHighWaterMark(field: StructField, candidateHighWaterMark: Long, allowLoweringHighWaterMarkForSyncIdentity: Boolean): (StructField, Seq[String])

    Update the high water mark of the IDENTITY column based on candidateHighWaterMark.

    Update the high water mark of the IDENTITY column based on candidateHighWaterMark.

    We validate against the identity column definition (start, step) and may insert a high watermark that's different from candidateHighWaterMark if it's not valid. This method may also not update the high watermark if the candidate doesn't respect the start, is below the current watermark or is a NOOP.

    field

    The IDENTITY column to update.

    candidateHighWaterMark

    The candidate high water mark to update to.

    allowLoweringHighWaterMarkForSyncIdentity

    Whether to allow lowering the high water mark. Lowering the high water mark is NOT SAFE in general, but may be a valid operation in SYNC IDENTITY (e.g. repair a high water mark after a bad sync).

    returns

    A new StructField with the high water mark updated to candidateHighWaterMark and a Seq[String] that contains debug information for logging.

    Attributes
    protected[delta]
  79. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  82. 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 Logging

Inherited from AnyRef

Inherited from Any

Ungrouped