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 MIN_READER_VERSION_PROP: String
5.  val MIN_WRITER_VERSION_PROP: String
6.  def apply(minReaderVersion: Int = Action.readerVersion, minWriterVersion: Int = Action.writerVersion): Protocol

   Construct a Protocol case class of the given reader and writer versions.

   Construct a Protocol case class of the given reader and writer versions. This method will initialize table features fields when reader and writer versions are capable.

7.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

8.  def assertTablePropertyConstraintsSatisfied(spark: SparkSession, metadata: Metadata, snapshot: Snapshot): Unit

   Verify that the table properties satisfy legality constraints.

   Verify that the table properties satisfy legality constraints. Throw an exception if not.

9.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws(classOf[java.lang.CloneNotSupportedException]) @native()

10.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

11.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

12.  def extractAutomaticallyEnabledFeatures(spark: SparkSession, metadata: Metadata, protocol: Option[Protocol] = None): Set[TableFeature]

    Extracts all table features that are enabled by the given metadata and the optional protocol.

    Extracts all table features that are enabled by the given metadata and the optional protocol. This includes all already enabled features (if a protocol is provided), the features enabled directly by metadata, and all of their (transitive) dependencies.

13.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

14.  def forNewTable(spark: SparkSession, metadataOpt: Option[Metadata]): Protocol

    Picks the protocol version for a new table given the Delta table metadata.

    Picks the protocol version for a new table given the Delta table metadata. The result satisfies all active features in the metadata and protocol-related configs in table properties, i.e., configs with keys MIN_READER_VERSION_PROP, MIN_WRITER_VERSION_PROP, and FEATURE_PROP_PREFIX. This method will also consider protocol-related configs: default reader version, default writer version, and features enabled by DEFAULT_FEATURE_PROP_PREFIX.

15.  def forTableFeature(tf: TableFeature): Protocol
16.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

17.  def getProtocolVersionsFromTableConf(conf: Map[String, String]): (Option[Int], Option[Int])
18.  def getReaderVersionFromTableConf(conf: Map[String, String]): Option[Int]
19.  def getWriterVersionFromTableConf(conf: Map[String, String]): Option[Int]
20.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

21.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

22.  def minProtocolComponentsFromAutomaticallyEnabledFeatures(spark: SparkSession, metadata: Metadata): (Int, Int, Set[TableFeature])

    Given the Delta table metadata, returns the minimum required reader and writer version that satisfies all enabled table features in the metadata plus all enabled features as a set.

    Given the Delta table metadata, returns the minimum required reader and writer version that satisfies all enabled table features in the metadata plus all enabled features as a set.

    This function returns the protocol versions and features individually instead of a Protocol, so the caller can identify the features that caused the protocol version. For example, if the return values are (2, 5, columnMapping), the caller can safely ignore all other features required by the protocol with a reader and writer version of 2 and 5.

    This method does not process protocol-related configs in table properties or session defaults, i.e., configs with keys MIN_READER_VERSION_PROP, MIN_WRITER_VERSION_PROP, and FEATURE_PROP_PREFIX.

23.  def minProtocolComponentsFromMetadata(spark: SparkSession, metadata: Metadata): (Int, Int, Set[TableFeature])

    Given the Delta table metadata, returns the minimum required reader and writer version that satisfies all enabled features in the metadata and protocol-related configs in table properties, i.e., configs with keys MIN_READER_VERSION_PROP, MIN_WRITER_VERSION_PROP, and FEATURE_PROP_PREFIX.

    Given the Delta table metadata, returns the minimum required reader and writer version that satisfies all enabled features in the metadata and protocol-related configs in table properties, i.e., configs with keys MIN_READER_VERSION_PROP, MIN_WRITER_VERSION_PROP, and FEATURE_PROP_PREFIX.

    This function returns the protocol versions and features individually instead of a Protocol, so the caller can identify the features that caused the protocol version. For example, if the return values are (2, 5, columnMapping), the caller can safely ignore all other features required by the protocol with a reader and writer version of 2 and 5.

    Note that this method does not consider protocol versions and features configured in session defaults. To make them effective, copy them to metadata using DeltaConfigs.mergeGlobalConfigs.

24.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

25.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

26.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

27.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

28.  def toString(): String

    Definition Classes

    AnyRef → Any

29.  def upgradeProtocolFromMetadataForExistingTable(spark: SparkSession, metadata: Metadata, current: Protocol): Option[Protocol]

    Upgrade the current protocol to satisfy all auto-update capable features required by the table metadata.

    Upgrade the current protocol to satisfy all auto-update capable features required by the table metadata. An Delta error will be thrown if a non-auto-update capable feature is required by the metadata and not in the resulting protocol, in such a case the user must run ALTER TABLE to add support for this feature beforehand using the delta.feature.featureName table property.

    Refer to FeatureAutomaticallyEnabledByMetadata.automaticallyUpdateProtocolOfExistingTables to know more about "auto-update capable" features.

    Note: this method only considers metadata-enabled features. To avoid confusion, the caller must apply and remove protocol-related table properties from the metadata before calling this method.

30.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

31.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

32.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()