Protocol¶

Protocol is an Action.

Creating Instance¶

Protocol takes the following to be created:

• Minimum Reader Version Allowed (default: 1)
• Minimum Writer Version Allowed (default: 3)

Protocol is created when:

• DeltaTable is requested to upgradeTableProtocol
• FIXME

forNewTable Utility¶

forNewTable(
  spark: SparkSession,
  metadata: Metadata): Protocol

forNewTable creates a new Protocol for the given SparkSession and Metadata.

forNewTable is used when:

• OptimisticTransactionImpl is requested to updateMetadata and updateMetadataForNewTable
• InitialSnapshot is requested to computedState

apply¶

apply(
  spark: SparkSession,
  metadataOpt: Option[Metadata]): Protocol

apply...FIXME

checkProtocolRequirements Utility¶

checkProtocolRequirements(
  spark: SparkSession,
  metadata: Metadata,
  current: Protocol): Option[Protocol]

checkProtocolRequirements...FIXME

checkProtocolRequirements is used when:

• OptimisticTransactionImpl is requested to verifyNewMetadata

Minimum Protocol Required¶

requiredMinimumProtocol(
  spark: SparkSession,
  metadata: Metadata): (Protocol, Seq[String])

requiredMinimumProtocol...FIXME

requiredMinimumProtocol is used when:

• Protocol utility is used to create a Protocol and checkProtocolRequirements