You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "fqaiser94 (via GitHub)" <gi...@apache.org> on 2025/01/15 02:25:52 UTC
[PR] feat(puffin): Add PuffinReader [iceberg-rust]
fqaiser94 opened a new pull request, #892:
URL: https://github.com/apache/iceberg-rust/pull/892
Part of https://github.com/apache/iceberg-rust/issues/744
# Summary
Add PuffinReader
# Context
This is the fourth of a number of PRs to add support for Iceberg Puffin file format.
It might be helpful to refer to the overarching [PR](https://github.com/apache/iceberg-rust/pull/714) from which these changes were split to understand better how these changes will fit in to the larger picture.
It may also be helpful to refer to the Java reference implementation for PuffinReader [here](https://github.com/apache/iceberg/blob/8cd5b1985d3f9c55ab2ced174559a8416b6ca1b4/core/src/main/java/org/apache/iceberg/puffin/PuffinReader.java#L123).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] feat(puffin): Add PuffinReader [iceberg-rust]
Posted by "fqaiser94 (via GitHub)" <gi...@apache.org>.
fqaiser94 commented on code in PR #892:
URL: https://github.com/apache/iceberg-rust/pull/892#discussion_r1929789733
##########
crates/iceberg/src/puffin/reader.rs:
##########
@@ -0,0 +1,126 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::io::{FileRead, InputFile};
+use crate::puffin::blob::Blob;
+use crate::puffin::metadata::{BlobMetadata, FileMetadata};
+use crate::Result;
+
+/// Puffin reader
+pub(crate) struct PuffinReader {
+ input_file: InputFile,
+ file_metadata: Option<FileMetadata>,
+}
+
+impl PuffinReader {
+ /// Returns a new Puffin reader
+ pub(crate) fn new(input_file: InputFile) -> Self {
+ Self {
+ input_file,
+ file_metadata: None,
+ }
+ }
+
+ /// Returns file metadata
+ pub(crate) async fn file_metadata(&mut self) -> Result<&FileMetadata> {
Review Comment:
PTAL, I implemented the lazy initialization using `tokio::sync::OnceCell`.
I couldn't get the async lazy crate approach to work because:
1. It doesn't expose any APIs for fallible operations.
2. My `FileMetadata::read` function needs a reference to the `InputFile` which doesn't work well with this approach:
```
let file_metadata: Lazy<Result<FileMetadata>> = Lazy::new(|| Box::pin(async { FileMetadata::read(&input_file).await }));
mismatched types
expected fn pointer `fn() -> Pin<Box<(dyn futures::Future<Output = std::result::Result<puffin::metadata::FileMetadata, error::Error>> + std::marker::Send + 'static)>>`
found closure `{closure@crates/iceberg/src/puffin/reader.rs:36:67: 36:69}`rustc[Click for full compiler diagnostic](rust-analyzer-diagnostics-view:/diagnostic%20message%20[2]?2#file:///Users/fq/src/iceberg-rust/crates/iceberg/src/puffin/reader.rs)
reader.rs(36, 57): arguments to this function are incorrect
reader.rs(36, 107): closures can only be coerced to `fn` types if they do not capture any variables
lib.rs(73, 12): associated function defined here
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] feat(puffin): Add PuffinReader [iceberg-rust]
Posted by "fqaiser94 (via GitHub)" <gi...@apache.org>.
fqaiser94 commented on code in PR #892:
URL: https://github.com/apache/iceberg-rust/pull/892#discussion_r1926246953
##########
crates/iceberg/src/puffin/reader.rs:
##########
@@ -0,0 +1,126 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::io::{FileRead, InputFile};
+use crate::puffin::blob::Blob;
+use crate::puffin::metadata::{BlobMetadata, FileMetadata};
+use crate::Result;
+
+/// Puffin reader
+pub(crate) struct PuffinReader {
+ input_file: InputFile,
+ file_metadata: Option<FileMetadata>,
+}
+
+impl PuffinReader {
+ /// Returns a new Puffin reader
+ pub(crate) fn new(input_file: InputFile) -> Self {
+ Self {
+ input_file,
+ file_metadata: None,
+ }
+ }
+
+ /// Returns file metadata
+ pub(crate) async fn file_metadata(&mut self) -> Result<&FileMetadata> {
Review Comment:
I would love to be able to get rid of the `&mut` here 👍
Struggling to get a `LazyLock` based implementation working though.
The main challenge is that `FileMetadata::read` is an async function :/
Open to suggestions
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] feat(puffin): Add PuffinReader [iceberg-rust]
Posted by "liurenjie1024 (via GitHub)" <gi...@apache.org>.
liurenjie1024 commented on code in PR #892:
URL: https://github.com/apache/iceberg-rust/pull/892#discussion_r1925017095
##########
crates/iceberg/src/puffin/reader.rs:
##########
@@ -0,0 +1,126 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::io::{FileRead, InputFile};
+use crate::puffin::blob::Blob;
+use crate::puffin::metadata::{BlobMetadata, FileMetadata};
+use crate::Result;
+
+/// Puffin reader
+pub(crate) struct PuffinReader {
+ input_file: InputFile,
+ file_metadata: Option<FileMetadata>,
+}
+
+impl PuffinReader {
+ /// Returns a new Puffin reader
+ pub(crate) fn new(input_file: InputFile) -> Self {
+ Self {
+ input_file,
+ file_metadata: None,
+ }
+ }
+
+ /// Returns file metadata
+ pub(crate) async fn file_metadata(&mut self) -> Result<&FileMetadata> {
Review Comment:
Should we consider using a `LazyLock` to initalize it? This way it could be thread safe, and discard the `&mut` modifier.
##########
crates/iceberg/src/puffin/blob.rs:
##########
@@ -0,0 +1,38 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use std::collections::HashMap;
+
+/// A serialized form of a "compact" Theta sketch produced by the Apache DataSketches library.
+pub(crate) const APACHE_DATASKETCHES_THETA_V1: &str = "apache-datasketches-theta-v1";
+
+/// The blob
+#[derive(Debug, PartialEq, Clone)]
+pub(crate) struct Blob {
+ /// See blob types: https://iceberg.apache.org/puffin-spec/#blob-types
+ pub(crate) r#type: String,
+ /// List of field IDs the blob was computed for; the order of items is used to compute sketches stored in the blob.
+ pub(crate) fields: Vec<i32>,
+ /// ID of the Iceberg table's snapshot the blob was computed from
+ pub(crate) snapshot_id: i64,
+ /// Sequence number of the Iceberg table's snapshot the blob was computed from
+ pub(crate) sequence_number: i64,
+ /// The actual blob data
+ pub(crate) data: Vec<u8>,
Review Comment:
Should we add comment to explain that this is always uncompressed data?
##########
crates/iceberg/src/puffin/reader.rs:
##########
@@ -0,0 +1,126 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::io::{FileRead, InputFile};
+use crate::puffin::blob::Blob;
+use crate::puffin::metadata::{BlobMetadata, FileMetadata};
+use crate::Result;
+
+/// Puffin reader
+pub(crate) struct PuffinReader {
+ input_file: InputFile,
+ file_metadata: Option<FileMetadata>,
+}
+
+impl PuffinReader {
+ /// Returns a new Puffin reader
+ pub(crate) fn new(input_file: InputFile) -> Self {
+ Self {
+ input_file,
+ file_metadata: None,
+ }
+ }
+
+ /// Returns file metadata
+ pub(crate) async fn file_metadata(&mut self) -> Result<&FileMetadata> {
+ if let Some(ref file_metadata) = self.file_metadata {
+ Ok(file_metadata)
+ } else {
+ let file_metadata = FileMetadata::read(&self.input_file).await?;
+ Ok(self.file_metadata.insert(file_metadata))
+ }
+ }
+
+ /// Returns blob
+ pub(crate) async fn blob(&self, blob_metadata: BlobMetadata) -> Result<Blob> {
Review Comment:
```suggestion
pub(crate) async fn blob(&self, blob_metadata: &BlobMetadata) -> Result<Blob> {
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] feat(puffin): Add PuffinReader [iceberg-rust]
Posted by "fqaiser94 (via GitHub)" <gi...@apache.org>.
fqaiser94 commented on code in PR #892:
URL: https://github.com/apache/iceberg-rust/pull/892#discussion_r1926260077
##########
crates/iceberg/src/puffin/blob.rs:
##########
@@ -0,0 +1,38 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use std::collections::HashMap;
+
+/// A serialized form of a "compact" Theta sketch produced by the Apache DataSketches library.
+pub(crate) const APACHE_DATASKETCHES_THETA_V1: &str = "apache-datasketches-theta-v1";
+
+/// The blob
+#[derive(Debug, PartialEq, Clone)]
+pub(crate) struct Blob {
+ /// See blob types: https://iceberg.apache.org/puffin-spec/#blob-types
+ pub(crate) r#type: String,
+ /// List of field IDs the blob was computed for; the order of items is used to compute sketches stored in the blob.
+ pub(crate) fields: Vec<i32>,
+ /// ID of the Iceberg table's snapshot the blob was computed from
+ pub(crate) snapshot_id: i64,
+ /// Sequence number of the Iceberg table's snapshot the blob was computed from
+ pub(crate) sequence_number: i64,
+ /// The actual blob data
+ pub(crate) data: Vec<u8>,
Review Comment:
> Should we add comment to explain that this is always uncompressed data?
Done.
> Or can we include a CompressionCodec in the Blob to indicate the compress method? (we can do this in a follow-up PR)
I can see where you're coming from and while I'm not completely opposed to the idea, I think I prefer to return the uncompressed data at this point. I will also note that the Java PuffinReader API does the same i.e. always returns the data after decompression.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] feat(puffin): Add PuffinReader [iceberg-rust]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo merged PR #892:
URL: https://github.com/apache/iceberg-rust/pull/892
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] feat(puffin): Add PuffinReader [iceberg-rust]
Posted by "waynexia (via GitHub)" <gi...@apache.org>.
waynexia commented on code in PR #892:
URL: https://github.com/apache/iceberg-rust/pull/892#discussion_r1925473444
##########
crates/iceberg/src/puffin/blob.rs:
##########
@@ -0,0 +1,38 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use std::collections::HashMap;
+
+/// A serialized form of a "compact" Theta sketch produced by the Apache DataSketches library.
+pub(crate) const APACHE_DATASKETCHES_THETA_V1: &str = "apache-datasketches-theta-v1";
+
+/// The blob
+#[derive(Debug, PartialEq, Clone)]
+pub(crate) struct Blob {
+ /// See blob types: https://iceberg.apache.org/puffin-spec/#blob-types
+ pub(crate) r#type: String,
+ /// List of field IDs the blob was computed for; the order of items is used to compute sketches stored in the blob.
+ pub(crate) fields: Vec<i32>,
+ /// ID of the Iceberg table's snapshot the blob was computed from
+ pub(crate) snapshot_id: i64,
+ /// Sequence number of the Iceberg table's snapshot the blob was computed from
+ pub(crate) sequence_number: i64,
+ /// The actual blob data
+ pub(crate) data: Vec<u8>,
Review Comment:
Or can we include a `CompressionCodec` in the `Blob` to indicate the compress method? (we can do this in a follow-up PR)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org