Packages

sealed abstract class TableFeature extends Serializable

A base class for all table features.

A feature can be explicitly supported by a table's protocol when the protocol contains a feature's name. Writers (for writer-only features) or readers and writers (for reader-writer features) must recognize supported features and must handle them appropriately.

A table feature that released before Delta Table Features (reader version 3 and writer version 7) is considered as a legacy feature. Legacy features are implicitly supported when (a) the protocol does not support table features, i.e., has reader version less than 3 or writer version less than 7 and (b) the feature's minimum reader/writer version is less than or equal to the current protocol's reader/writer version.

Separately, a feature can be automatically supported by a table's metadata when certain feature-specific table properties are set. For example, changeDataFeed is automatically supported when there's a table property delta.enableChangeDataFeed=true. This is independent of the table's enabled features. When a feature is supported (explicitly or implicitly) by the table protocol but its metadata requirements are not satisfied, then clients still have to understand the feature (at least to the extent that they can read and preserve the existing data in the table that uses the feature). See the documentation of FeatureAutomaticallyEnabledByMetadata for more information.

Linear Supertypes
Serializable, AnyRef, Any
Known Subclasses
AllowColumnDefaultsTableFeature, AppendOnlyTableFeature, ChangeDataFeedTableFeature, CheckConstraintsTableFeature, CheckpointProtectionTableFeature, ClusteringTableFeature, ColumnMappingTableFeature, CoordinatedCommitsTableFeature, DeletionVectorsTableFeature, DomainMetadataTableFeature, GeneratedColumnsTableFeature, IcebergCompatV1TableFeature, IcebergCompatV2TableFeature, IdentityColumnsTableFeature, InCommitTimestampTableFeature, InvariantsTableFeature, LegacyReaderWriterFeature, LegacyWriterFeature, ReaderWriterFeature, RedirectReaderWriterFeature, RedirectWriterOnlyFeature, RowTrackingFeature, TestFeatureWithDependency, TestFeatureWithTransitiveDependency, TestLegacyReaderWriterFeature, TestLegacyWriterFeature, TestReaderWriterFeature, TestReaderWriterMetadataAutoUpdateFeature, TestReaderWriterMetadataNoAutoUpdateFeature, TestRemovableLegacyReaderWriterFeature, TestRemovableLegacyWriterFeature, TestRemovableWriterWithHistoryTruncationFeature, TestWriterFeature, TestWriterFeatureWithTransitiveDependency, TestWriterMetadataNoAutoUpdateFeature, TimestampNTZTableFeature, TypeWideningPreviewTableFeature, TypeWideningTableFeature, TypeWideningTableFeatureBase, V2CheckpointTableFeature, VacuumProtocolCheckTableFeature, VariantTypeTableFeature, WriterFeature
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TableFeature
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def isLegacyFeature: Boolean

    Determine if this feature is a legacy feature.

    Determine if this feature is a legacy feature. See the documentation of TableFeature for more information.

  13. def isReaderWriterFeature: Boolean

    Determine if this feature applies to both readers and writers.

  14. def isRemovable: Boolean

    True if this feature can be removed.

  15. def minProtocolVersion: Protocol

    Get a Protocol object stating the minimum reader and writer versions this feature requires.

    Get a Protocol object stating the minimum reader and writer versions this feature requires. For a feature that can only be explicitly supported, this method returns a protocol version that supports table features, either (0,7) or (3,7) depending on the feature is writer-only or reader-writer. For a legacy feature that can be implicitly supported, this method returns the first protocol version which introduced the said feature.

    For all features, if the table's protocol version does not support table features, then the minimum protocol version is enough. However, if the protocol version supports table features for the feature type (writer-only or reader-writer), then the minimum protocol version is not enough to support a feature. In this case the feature must also be explicitly listed in the appropriate feature sets in the Protocol.

  16. val minReaderVersion: Int
  17. val minWriterVersion: Int
  18. val name: String
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def requiredFeatures: Set[TableFeature]

    Set of table features that this table feature depends on.

    Set of table features that this table feature depends on. I.e. the set of features that need to be enabled if this table feature is enabled.

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped