DeletionVectorDescriptor¶

DeletionVectorDescriptor describes a deletion vector attached to a file action.

Creating Instance¶

DeletionVectorDescriptor takes the following to be created:

storageType
pathOrInlineDv
offset
sizeInBytes
cardinality
maxRowIndex

DeletionVectorDescriptor is created using the following utilities:

onDiskWithRelativePath
onDiskWithAbsolutePath
inlineInLog
EMPTY

EMPTY¶

EMPTY: DeletionVectorDescriptor

EMPTY is an empty deletion vector (DeletionVectorDescriptor) with the following:

Property	Value
storageType	`i`
pathOrInlineDv	(empty)
sizeInBytes	0
cardinality	0

EMPTY is used when:

DeletionVectorWriter is requested to storeSerializedBitmap
StoredBitmap is requested for The stored bitmap of an empty deletion vector

onDiskWithRelativePath¶

onDiskWithRelativePath(
  id: UUID,
  randomPrefix: String = "",
  sizeInBytes: Int,
  cardinality: Long,
  offset: Option[Int] = None,
  maxRowIndex: Option[Long] = None): DeletionVectorDescriptor

onDiskWithRelativePath creates a DeletionVectorDescriptor with the following:

Property	Value
storageType	`u`
pathOrInlineDv	encodeUUID with the given `id` and `randomPrefix`
offset	The given `offset`
sizeInBytes	The given `sizeInBytes`
cardinality	The given `cardinality`
maxRowIndex	The given `maxRowIndex`

onDiskWithRelativePath is used when:

DeletionVectorWriter is requested to storeSerializedBitmap

inlineInLog¶

inlineInLog(
  data: Array[Byte],
  cardinality: Long): DeletionVectorDescriptor

inlineInLog creates a DeletionVectorDescriptor with the following:

Property	Value
storageType	`i`
pathOrInlineDv	encodeData for the given `data`
sizeInBytes	The size of the given `data`
cardinality	The given `cardinality`

inlineInLog is used when:

CDCReaderImpl is requested to generateFileActionsWithInlineDv

onDiskWithAbsolutePath¶

onDiskWithAbsolutePath(
  path: String,
  sizeInBytes: Int,
  cardinality: Long,
  offset: Option[Int] = None,
  maxRowIndex: Option[Long] = None): DeletionVectorDescriptor

Note

onDiskWithAbsolutePath is used for testing only.