TableFeatureProtocolUtils¶

delta.feature Property Prefix¶

TableFeatureProtocolUtils defines the following property prefix for table features:

delta.feature.

The prefix is used when:

• DeltaConfigsBase is requested to validateConfigurations, mergeGlobalConfigs, normalizeConfigKeys, normalizeConfigKey
• Snapshot is requested to getProperties
• Protocol is requested to assertMetadataContainsNoProtocolProps
• TableFeatureProtocolUtils is requested to propertyKey, getSupportedFeaturesFromTableConfigs, isTableProtocolProperty

spark.databricks.delta.properties.defaults.feature Property Prefix¶

TableFeatureProtocolUtils defines the following prefix for the Spark session properties of table features:

spark.databricks.delta.properties.defaults.feature.

The prefix is used when:

• DeltaConfigsBase is requested to mergeGlobalConfigs
• TableFeatureProtocolUtils is requested for the default session property key of a table feature

isTableProtocolProperty¶

isTableProtocolProperty(
  key: String): Boolean

isTableProtocolProperty holds true when the given key is one of the following:

• delta.minReaderVersion
• delta.minWriterVersion
• delta.ignoreProtocolDefaults
• The key starts with the delta.feature. prefix

isTableProtocolProperty is used when:

• DeltaConfigsBase is requested to mergeGlobalConfigs
• OptimisticTransactionImpl is requested to updateMetadataInternal
• Protocol is requested to forNewTable

getSupportedFeaturesFromTableConfigs¶

getSupportedFeaturesFromTableConfigs(
  configs: Map[String, String]): Set[TableFeature]

getSupportedFeaturesFromTableConfigs...FIXME

getSupportedFeaturesFromTableConfigs is used when:

• OptimisticTransactionImpl is requested to updateMetadataInternal
• Protocol is requested to minProtocolComponentsFromMetadata

Property Key of Table Feature¶

propertyKey(
  feature: TableFeature): String
propertyKey(
  featureName: String): String

propertyKey is the following text:

delta.feature.[featureName]

propertyKey is used when:

• DeltaTable is requested to addFeatureSupport

getSupportedFeaturesFromTableConfigs¶

getSupportedFeaturesFromTableConfigs(
  configs: Map[String, String]): Set[TableFeature]

getSupportedFeaturesFromTableConfigs takes all the delta.feature.-prefixed keys in the given configs collection and makes sure that all supported or enabled.

If there is a table feature not supported or there's no table feature by a name, getSupportedFeaturesFromTableConfigs reports an exception.

getSupportedFeaturesFromTableConfigs is used when:

• OptimisticTransactionImpl is requested to updateMetadataInternal
• Protocol is requested to minProtocolComponentsFromMetadata

Default Session Property Key of Table Property¶

defaultPropertyKey(
  feature: TableFeature): String
defaultPropertyKey(
  featureName: String): String

defaultPropertyKey is the following text:

spark.databricks.delta.properties.defaults.feature.[featureName]

defaultPropertyKey is used when:

• DeltaErrorsBase is requested to convertToDeltaRowTrackingEnabledWithoutStatsCollection