-
Notifications
You must be signed in to change notification settings - Fork 182
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
18 changed files
with
1,810 additions
and
8 deletions.
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
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
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 |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# 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. | ||
|
||
[package] | ||
name = "iceberg-puffin" | ||
version = { workspace = true } | ||
edition = { workspace = true } | ||
homepage = { workspace = true } | ||
rust-version = { workspace = true } | ||
|
||
categories = ["database"] | ||
description = "Apache Iceberg Puffin" | ||
repository = { workspace = true } | ||
license = { workspace = true } | ||
keywords = ["iceberg", "puffin"] | ||
|
||
[dependencies] | ||
bytes = { workspace = true } | ||
iceberg = { workspace = true } | ||
once_cell = { workspace = true } | ||
serde = { workspace = true } | ||
serde_json = { workspace = true } | ||
zstd = { workspace = true } | ||
|
||
[dev-dependencies] | ||
tempfile = { workspace = true } | ||
tokio = { workspace = true } |
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 |
---|---|---|
@@ -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 const APACHE_DATASKETCHES_THETA_V1: &str = "apache-datasketches-theta-v1"; | ||
|
||
/// The blob | ||
#[derive(Debug, PartialEq, Clone)] | ||
pub struct Blob { | ||
/// See blob types: https://iceberg.apache.org/puffin-spec/#blob-types | ||
pub 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 input_fields: Vec<i32>, | ||
/// ID of the Iceberg table's snapshot the blob was computed from | ||
pub snapshot_id: i64, | ||
/// Sequence number of the Iceberg table's snapshot the blob was computed from | ||
pub sequence_number: i64, | ||
/// The actual blob data | ||
pub data: Vec<u8>, | ||
/// Arbitrary meta-information about the blob | ||
pub properties: HashMap<String, String>, | ||
} |
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 |
---|---|---|
@@ -0,0 +1,123 @@ | ||
// 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 iceberg::{Error, ErrorKind, Result}; | ||
use serde::{Deserialize, Serialize}; | ||
|
||
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, Clone, Copy)] | ||
#[serde(rename_all = "lowercase")] | ||
#[derive(Default)] | ||
/// Data compression formats | ||
pub enum CompressionCodec { | ||
#[default] | ||
/// No compression | ||
None, | ||
/// LZ4 single compression frame with content size present | ||
Lz4, | ||
/// Zstandard single compression frame with content size present | ||
Zstd, | ||
} | ||
|
||
impl CompressionCodec { | ||
pub(crate) fn decompress(&self, bytes: Vec<u8>) -> Result<Vec<u8>> { | ||
match self { | ||
CompressionCodec::None => Ok(bytes), | ||
CompressionCodec::Lz4 => Err(Error::new( | ||
ErrorKind::FeatureUnsupported, | ||
"LZ4 decompression is not supported currently", | ||
)), | ||
CompressionCodec::Zstd => { | ||
let decompressed = zstd::stream::decode_all(&bytes[..])?; | ||
Ok(decompressed) | ||
} | ||
} | ||
} | ||
|
||
pub(crate) fn compress(&self, bytes: Vec<u8>) -> Result<Vec<u8>> { | ||
match self { | ||
CompressionCodec::None => Ok(bytes), | ||
CompressionCodec::Lz4 => Err(Error::new( | ||
ErrorKind::FeatureUnsupported, | ||
"LZ4 compression is not supported currently", | ||
)), | ||
CompressionCodec::Zstd => { | ||
let writer = Vec::<u8>::new(); | ||
let mut encoder = zstd::stream::Encoder::new(writer, 3)?; | ||
encoder.include_checksum(true)?; | ||
encoder.set_pledged_src_size(Some(bytes.len().try_into()?))?; | ||
std::io::copy(&mut &bytes[..], &mut encoder)?; | ||
let compressed = encoder.finish()?; | ||
Ok(compressed) | ||
} | ||
} | ||
} | ||
|
||
pub(crate) fn is_none(&self) -> bool { | ||
matches!(self, CompressionCodec::None) | ||
} | ||
} | ||
|
||
#[cfg(test)] | ||
mod tests { | ||
use crate::compression::CompressionCodec; | ||
|
||
#[tokio::test] | ||
async fn test_compression_codec_none() { | ||
let compression_codec = CompressionCodec::None; | ||
let bytes_vec = [0_u8; 100].to_vec(); | ||
|
||
let compressed = compression_codec.compress(bytes_vec.clone()).unwrap(); | ||
assert_eq!(bytes_vec, compressed); | ||
|
||
let decompressed = compression_codec.decompress(compressed.clone()).unwrap(); | ||
assert_eq!(compressed, decompressed) | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_compression_codec_lz4() { | ||
let compression_codec = CompressionCodec::Lz4; | ||
let bytes_vec = [0_u8; 100].to_vec(); | ||
|
||
assert_eq!( | ||
compression_codec | ||
.compress(bytes_vec.clone()) | ||
.unwrap_err() | ||
.to_string(), | ||
"FeatureUnsupported => LZ4 compression is not supported currently", | ||
); | ||
|
||
assert_eq!( | ||
compression_codec | ||
.decompress(bytes_vec.clone()) | ||
.unwrap_err() | ||
.to_string(), | ||
"FeatureUnsupported => LZ4 decompression is not supported currently", | ||
) | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_compression_codec_zstd() { | ||
let compression_codec = CompressionCodec::Zstd; | ||
let bytes_vec = [0_u8; 100].to_vec(); | ||
|
||
let compressed = compression_codec.compress(bytes_vec.clone()).unwrap(); | ||
assert!(compressed.len() < bytes_vec.len()); | ||
|
||
let decompressed = compression_codec.decompress(compressed.clone()).unwrap(); | ||
assert_eq!(decompressed, bytes_vec) | ||
} | ||
} |
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 |
---|---|---|
@@ -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. | ||
|
||
//! Iceberg Puffin implementation. | ||
#![deny(missing_docs)] | ||
|
||
mod blob; | ||
pub use blob::{Blob, APACHE_DATASKETCHES_THETA_V1}; | ||
|
||
mod compression; | ||
pub use compression::CompressionCodec; | ||
|
||
mod metadata; | ||
pub use metadata::{BlobMetadata, FileMetadata, CREATED_BY_PROPERTY}; | ||
|
||
mod reader; | ||
pub use reader::PuffinReader; | ||
|
||
#[cfg(test)] | ||
mod test_utils; | ||
|
||
mod writer; | ||
pub use writer::PuffinWriter; |
Oops, something went wrong.