feat: add visitor SidecarVisitor and Sidecar action struct
#673
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,14 +12,13 @@ use crate::{DeltaResult, Error}; | |
| use super::deletion_vector::DeletionVectorDescriptor; | ||
| use super::schemas::ToSchema as _; | ||
| use super::{ | ||
| Add, Cdc, Format, Metadata, Protocol, Remove, SetTransaction, Sidecar, ADD_NAME, CDC_NAME, | ||
| METADATA_NAME, PROTOCOL_NAME, REMOVE_NAME, SET_TRANSACTION_NAME, SIDECAR_NAME, | ||
| }; | ||
|
|
||
| #[derive(Default)] | ||
| #[cfg_attr(feature = "developer-visibility", visibility::make(pub))] | ||
| pub(crate) struct MetadataVisitor { | ||
| pub(crate) metadata: Option<Metadata>, | ||
| } | ||
|
|
||
|
|
@@ -114,8 +113,7 @@ impl RowVisitor for SelectionVectorVisitor { | |
|
|
||
| #[derive(Default)] | ||
| #[cfg_attr(feature = "developer-visibility", visibility::make(pub))] | ||
| pub(crate) struct ProtocolVisitor { | ||
| pub(crate) protocol: Option<Protocol>, | ||
| } | ||
|
|
||
|
|
@@ -318,15 +316,13 @@ impl RowVisitor for RemoveVisitor { | |
| #[allow(unused)] | ||
| #[derive(Default)] | ||
| #[cfg_attr(feature = "developer-visibility", visibility::make(pub))] | ||
| pub(crate) struct CdcVisitor { | ||
| pub(crate) cdcs: Vec<Cdc>, | ||
| } | ||
|
|
||
| impl CdcVisitor { | ||
| #[cfg_attr(feature = "developer-visibility", visibility::make(pub))] | ||
| pub(crate) fn visit_cdc<'a>( | ||
| row_index: usize, | ||
| path: String, | ||
| getters: &[&'a dyn GetData<'a>], | ||
|
|
@@ -377,7 +373,6 @@ pub type SetTransactionMap = HashMap<String, SetTransaction>; | |
| /// | ||
| #[derive(Default, Debug)] | ||
| #[cfg_attr(feature = "developer-visibility", visibility::make(pub))] | ||
| pub(crate) struct SetTransactionVisitor { | ||
| pub(crate) set_transactions: SetTransactionMap, | ||
| pub(crate) application_id: Option<String>, | ||
|
|
@@ -393,8 +388,7 @@ impl SetTransactionVisitor { | |
| } | ||
|
|
||
| #[cfg_attr(feature = "developer-visibility", visibility::make(pub))] | ||
| pub(crate) fn visit_txn<'a>( | ||
| row_index: usize, | ||
| app_id: String, | ||
| getters: &[&'a dyn GetData<'a>], | ||
|
|
@@ -444,6 +438,52 @@ impl RowVisitor for SetTransactionVisitor { | |
| } | ||
| } | ||
|
|
||
| #[allow(unused)] //TODO: Remove once we implement V2 checkpoint file processing | ||
| #[derive(Default)] | ||
| #[cfg_attr(feature = "developer-visibility", visibility::make(pub))] | ||
| pub(crate) struct SidecarVisitor { | ||
| pub(crate) sidecars: Vec<Sidecar>, | ||
| } | ||
|
|
||
| impl SidecarVisitor { | ||
| fn visit_sidecar<'a>( | ||
| row_index: usize, | ||
| path: String, | ||
| getters: &[&'a dyn GetData<'a>], | ||
| ) -> DeltaResult<Sidecar> { | ||
| Ok(Sidecar { | ||
| path, | ||
| size_in_bytes: getters[1].get(row_index, "sidecar.sizeInBytes")?, | ||
| modification_time: getters[2].get(row_index, "sidecar.modificationTime")?, | ||
| tags: getters[3].get_opt(row_index, "sidecar.tags")?, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| impl RowVisitor for SidecarVisitor { | ||
| fn selected_column_names_and_types(&self) -> (&'static [ColumnName], &'static [DataType]) { | ||
| static NAMES_AND_TYPES: LazyLock<ColumnNamesAndTypes> = | ||
| LazyLock::new(|| Sidecar::to_schema().leaves(SIDECAR_NAME)); | ||
| NAMES_AND_TYPES.as_ref() | ||
| } | ||
| fn visit<'a>(&mut self, row_count: usize, getters: &[&'a dyn GetData<'a>]) -> DeltaResult<()> { | ||
| require!( | ||
| getters.len() == 4, | ||
| Error::InternalError(format!( | ||
| "Wrong number of SidecarVisitor getters: {}", | ||
| getters.len() | ||
| )) | ||
| ); | ||
| for i in 0..row_count { | ||
| // Since path column is required, use it to detect presence of a sidecar action | ||
| if let Some(path) = getters[0].get_opt(i, "sidecar.path")? { | ||
| self.sidecars.push(Self::visit_sidecar(i, path, getters)?); | ||
| } | ||
| } | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| /// Get a DV out of some engine data. The caller is responsible for slicing the `getters` slice such | ||
| /// that the first element contains the `storageType` element of the deletion vector. | ||
| pub(crate) fn visit_deletion_vector_at<'a>( | ||
|
|
@@ -501,7 +541,8 @@ mod tests { | |
| r#"{"commitInfo":{"timestamp":1677811178585,"operation":"WRITE","operationParameters":{"mode":"ErrorIfExists","partitionBy":"[]"},"isolationLevel":"WriteSerializable","isBlindAppend":true,"operationMetrics":{"numFiles":"1","numOutputRows":"10","numOutputBytes":"635"},"engineInfo":"Databricks-Runtime/<unknown>","txnId":"a6a94671-55ef-450e-9546-b8465b9147de"}}"#, | ||
| r#"{"protocol":{"minReaderVersion":3,"minWriterVersion":7,"readerFeatures":["deletionVectors"],"writerFeatures":["deletionVectors"]}}"#, | ||
| r#"{"metaData":{"id":"testId","format":{"provider":"parquet","options":{}},"schemaString":"{\"type\":\"struct\",\"fields\":[{\"name\":\"value\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}","partitionColumns":[],"configuration":{"delta.enableDeletionVectors":"true","delta.columnMapping.mode":"none", "delta.enableChangeDataFeed":"true"},"createdTime":1677811175819}}"#, | ||
| r#"{"cdc":{"path":"_change_data/age=21/cdc-00000-93f7fceb-281a-446a-b221-07b88132d203.c000.snappy.parquet","partitionValues":{"age":"21"},"size":1033,"dataChange":false}}"#, | ||
| r#"{"sidecar":{"path":"016ae953-37a9-438e-8683-9a9a4a79a395.parquet","sizeInBytes":9268,"modificationTime":1714496113961,"tags":{"tag_foo":"tag_bar"}}}"#, | ||
|
There was a problem hiding this comment. qq: would a relative path look like this or would it be There was a problem hiding this comment. A relative path would just be the filename. |
||
| ] | ||
| .into(); | ||
| let output_schema = get_log_schema().clone(); | ||
|
|
@@ -544,6 +585,29 @@ mod tests { | |
| Ok(()) | ||
| } | ||
|
|
||
| #[test] | ||
|
There was a problem hiding this comment. Aside: None of these tests check the error case where a required field is missing 🤔 Maybe we should make an issue to add those. Personally I'd also like to see a There was a problem hiding this comment. good idea! #674 There was a problem hiding this comment. couldn't we also add a trivial case just for these additions to see it fail if sidecar.path is missing? (and keep the issue to extend to other cases?) |
||
| fn test_parse_sidecar() -> DeltaResult<()> { | ||
| let data = action_batch(); | ||
|
|
||
| let mut visitor = SidecarVisitor::default(); | ||
| visitor.visit_rows_of(data.as_ref())?; | ||
|
|
||
| let sidecar1 = Sidecar { | ||
| path: "016ae953-37a9-438e-8683-9a9a4a79a395.parquet".into(), | ||
| size_in_bytes: 9268, | ||
| modification_time: 1714496113961, | ||
| tags: Some(HashMap::from([( | ||
| "tag_foo".to_string(), | ||
| "tag_bar".to_string(), | ||
| )])), | ||
| }; | ||
|
|
||
| assert_eq!(visitor.sidecars.len(), 1); | ||
| assert_eq!(visitor.sidecars[0], sidecar1); | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_parse_metadata() -> DeltaResult<()> { | ||
| let data = action_batch(); | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: could add some docs and link to sidecar action in protocol?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good idea 👍