Packages

case class DeltaTableV2(spark: SparkSession, path: Path, catalogTable: Option[CatalogTable] = None, tableIdentifier: Option[String] = None, timeTravelOpt: Option[DeltaTimeTravelSpec] = None, options: Map[String, String] = Map.empty) extends Table with SupportsWrite with V2TableWithV1Fallback with DeltaLogging with Product with Serializable

The data source V2 representation of a Delta table that exists.

path

The path to the table

tableIdentifier

The table identifier for this table

Linear Supertypes
Serializable, Serializable, Product, Equals, DeltaLogging, DatabricksLogging, DeltaProgressReporter, LoggingShims, Logging, V2TableWithV1Fallback, SupportsWrite, Table, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeltaTableV2
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DeltaLogging
  7. DatabricksLogging
  8. DeltaProgressReporter
  9. LoggingShims
  10. Logging
  11. V2TableWithV1Fallback
  12. SupportsWrite
  13. Table
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DeltaTableV2(spark: SparkSession, path: Path, catalogTable: Option[CatalogTable] = None, tableIdentifier: Option[String] = None, timeTravelOpt: Option[DeltaTimeTravelSpec] = None, options: Map[String, String] = Map.empty)

    path

    The path to the table

    tableIdentifier

    The table identifier for this table

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 capabilities(): Set[TableCapability]
    Definition Classes
    DeltaTableV2 → Table
  6. val catalogTable: Option[CatalogTable]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  8. lazy val clusterBySpec: Option[ClusterBySpec]
  9. def columns(): Array[connector.catalog.Column]
    Definition Classes
    Table
  10. 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
  11. lazy val deltaLog: DeltaLog
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def getCommonTags(deltaLog: DeltaLog, tahoeId: String): Map[TagDefinition, String]
    Definition Classes
    DeltaLogging
  15. def getErrorData(e: Throwable): Map[String, Any]
    Definition Classes
    DeltaLogging
  16. def getTableIdentifierIfExists: Option[TableIdentifier]
  17. def hasPartitionFilters: Boolean
  18. lazy val initialSnapshot: Snapshot

    The snapshot initially associated with this table.

    The snapshot initially associated with this table. It is captured on first access, usually (but not always) shortly after the table was first created, and is immutable once captured.

    WARNING: This snapshot could be arbitrarily stale for long-lived DeltaTableV2 instances, such as the ones DeltaTable uses internally. Callers who cannot tolerate this potential staleness should use getFreshSnapshot instead.

    WARNING: Because the snapshot is captured lazily, callers should explicitly access the snapshot if they want to be certain it has been captured.

  19. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  20. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  23. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  24. def logConsole(line: String): Unit
    Definition Classes
    DatabricksLogging
  25. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  26. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  27. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  30. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  31. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  34. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  35. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  38. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  39. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  40. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  43. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    LoggingShims
  44. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. def name(): String
    Definition Classes
    DeltaTableV2 → Table
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def newWriteBuilder(info: LogicalWriteInfo): WriteBuilder
    Definition Classes
    DeltaTableV2 → SupportsWrite
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  51. val options: Map[String, String]
  52. def partitioning(): Array[Transform]
    Definition Classes
    DeltaTableV2 → Table
  53. val path: Path
  54. def properties(): Map[String, String]
    Definition Classes
    DeltaTableV2 → Table
  55. 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
  56. 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
  57. 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
  58. def recordEvent(metric: MetricDefinition, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  59. def recordFrameProfile[T](group: String, name: String)(thunk: ⇒ T): T
    Attributes
    protected
    Definition Classes
    DeltaLogging
  60. 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
  61. def recordProductEvent(metric: MetricDefinition with CentralizableMetric, additionalTags: Map[TagDefinition, String] = Map.empty, blob: String = null, trimBlob: Boolean = true): Unit
    Definition Classes
    DatabricksLogging
  62. 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
  63. 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
  64. def schema(): StructType
    Definition Classes
    DeltaTableV2 → Table
  65. val spark: SparkSession
  66. def startTransaction(snapshotOpt: Option[Snapshot] = None): OptimisticTransaction

    Starts a transaction for this table, using Some provided snapshot, or a fresh snapshot if None was provided.

  67. def startTransactionWithInitialSnapshot(): OptimisticTransaction

    Starts a transaction for this table, using the snapshot captured during table resolution.

    Starts a transaction for this table, using the snapshot captured during table resolution.

    WARNING: Caller is responsible to ensure that table resolution was recent (e.g. if working with DataFrame or DeltaTable API, where the table could have been resolved long ago).

  68. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  69. def tableExists: Boolean
  70. val tableIdentifier: Option[String]
  71. val timeTravelOpt: Option[DeltaTimeTravelSpec]
  72. lazy val toBaseRelation: BaseRelation

    Creates a V1 BaseRelation from this Table to allow read APIs to go through V1 DataSource code paths.

  73. def toDf(sparkSession: SparkSession): DataFrame

    Creates a DataFrame that uses the requested spark session to read from this table

  74. lazy val toDf: DataFrame

    Creates a DataFrame that reads from this table

  75. lazy val toLogicalRelation: LogicalRelation

    Creates a LogicalRelation that represents this table

  76. lazy val ttSafeCatalogTable: Option[CatalogTable]

    A "clean" version of the catalog table, safe for use with or without time travel.

  77. def update(): Snapshot

    Updates the delta log for this table and returns a new snapshot

  78. def v1Table: CatalogTable
    Definition Classes
    DeltaTableV2 → V2TableWithV1Fallback
  79. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  81. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. def withOptions(newOptions: Map[String, String]): DeltaTableV2

    Check the passed in options and existing timeTravelOpt, set new time travel by options.

  83. 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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DeltaLogging

Inherited from DatabricksLogging

Inherited from DeltaProgressReporter

Inherited from LoggingShims

Inherited from Logging

Inherited from V2TableWithV1Fallback

Inherited from SupportsWrite

Inherited from Table

Inherited from AnyRef

Inherited from Any

Ungrouped