liurenjie1024 commented on code in PR #1735: URL: https://github.com/apache/iceberg-rust/pull/1735#discussion_r2428552676
########## crates/iceberg/src/writer/partitioning/mod.rs: ########## @@ -0,0 +1,49 @@ +// 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. + +pub mod clustered_writer; +pub mod fanout_writer; + +use crate::Result; +use crate::spec::PartitionKey; +use crate::writer::{DefaultInput, DefaultOutput}; + +/// A writer that can write data to partitioned tables. +/// +/// This trait provides methods for writing data with optional partition keys and +/// closing the writer to retrieve the output. +#[async_trait::async_trait] +pub trait PartitioningWriter<I = DefaultInput, O = DefaultOutput>: Send + 'static { + /// Write data with an optional partition key. + /// + /// # Parameters + /// + /// * `partition_key` - Optional partition key to determine which partition to write to + /// * `input` - The input data to write + /// + /// # Returns + /// + /// `Ok(())` on success, or an error if the write operation fails. + async fn write(&mut self, partition_key: Option<PartitionKey>, input: I) -> Result<()>; Review Comment: ```suggestion async fn write(&mut self, partition_key: PartitionKey, input: I) -> Result<()>; ``` For partitioning writer, it should always be partitioned? ########## crates/iceberg/src/writer/partitioning/fanout_writer.rs: ########## @@ -0,0 +1,697 @@ +// 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. + +//! This module provides the `FanoutWriter` implementation. + +use std::collections::HashMap; +use std::marker::PhantomData; + +use async_trait::async_trait; + +use crate::spec::{PartitionKey, Struct}; +use crate::writer::partitioning::PartitioningWriter; +use crate::writer::{DefaultInput, DefaultOutput, IcebergWriter, IcebergWriterBuilder}; +use crate::{Error, ErrorKind, Result}; + +/// A writer that can write data to multiple partitions simultaneously. +/// +/// Unlike `ClusteredWriter` which expects sorted input and maintains only one active writer, +/// `FanoutWriter` can handle unsorted data by maintaining multiple active writers in a map. +/// This allows writing to any partition at any time, but uses more memory as all writers +/// remain active until the writer is closed. +/// +/// # Type Parameters +/// +/// * `B` - The inner writer builder type +/// * `I` - Input type (defaults to `RecordBatch`) +/// * `O` - Output collection type (defaults to `Vec<DataFile>`) +#[derive(Clone)] +pub struct FanoutWriter<B, I = DefaultInput, O = DefaultOutput> +where + B: IcebergWriterBuilder<I, O>, + O: IntoIterator + FromIterator<<O as IntoIterator>::Item>, + <O as IntoIterator>::Item: Clone, +{ + inner_builder: B, + partition_writers: HashMap<Struct, B::R>, + unpartitioned_writer: Option<B::R>, Review Comment: Why we need this? ########## crates/iceberg/src/writer/partitioning/mod.rs: ########## @@ -0,0 +1,49 @@ +// 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. + +pub mod clustered_writer; +pub mod fanout_writer; + +use crate::Result; +use crate::spec::PartitionKey; +use crate::writer::{DefaultInput, DefaultOutput}; + +/// A writer that can write data to partitioned tables. +/// +/// This trait provides methods for writing data with optional partition keys and +/// closing the writer to retrieve the output. +#[async_trait::async_trait] +pub trait PartitioningWriter<I = DefaultInput, O = DefaultOutput>: Send + 'static { + /// Write data with an optional partition key. + /// + /// # Parameters + /// + /// * `partition_key` - Optional partition key to determine which partition to write to + /// * `input` - The input data to write + /// + /// # Returns + /// + /// `Ok(())` on success, or an error if the write operation fails. + async fn write(&mut self, partition_key: Option<PartitionKey>, input: I) -> Result<()>; + + /// Close the writer and return the output. + /// + /// # Returns + /// + /// The accumulated output from all write operations. + async fn close(&mut self) -> Result<O>; Review Comment: ```suggestion async fn close(self) -> Result<O>; ``` Why not consume this writer? ########## crates/iceberg/src/writer/partitioning/fanout_writer.rs: ########## @@ -0,0 +1,676 @@ +// 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. + +//! This module provides the `FanoutDataWriter` implementation. + +use std::collections::HashMap; + +use arrow_array::RecordBatch; +use async_trait::async_trait; + +use crate::spec::{DataFile, PartitionKey, Struct}; +use crate::writer::partitioning::PartitioningWriter; +use crate::writer::{IcebergWriter, IcebergWriterBuilder}; +use crate::{Error, ErrorKind, Result}; + +/// A writer that can write data to multiple partitions simultaneously. +/// +/// Unlike `ClusteredDataWriter` which expects sorted input and maintains only one active writer, +/// `FanoutDataWriter` can handle unsorted data by maintaining multiple active writers in a map. +/// This allows writing to any partition at any time, but uses more memory as all writers +/// remain active until the writer is closed. +#[derive(Clone)] +pub struct FanoutDataWriter<B: IcebergWriterBuilder> { + inner_builder: B, + partition_writers: HashMap<Struct, B::R>, + unpartitioned_writer: Option<B::R>, + output: Vec<DataFile>, +} Review Comment: +1, we don't have to this for now, but at least let's create an issue to track it. ########## crates/iceberg/src/writer/partitioning/clustered_writer.rs: ########## @@ -0,0 +1,623 @@ +// 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. + +//! This module provides the `ClusteredWriter` implementation. + +use std::collections::HashSet; +use std::marker::PhantomData; + +use async_trait::async_trait; + +use crate::spec::{PartitionKey, Struct}; +use crate::writer::partitioning::PartitioningWriter; +use crate::writer::{DefaultInput, DefaultOutput, IcebergWriter, IcebergWriterBuilder}; +use crate::{Error, ErrorKind, Result}; + +/// A writer that writes data to a single partition at a time. +/// +/// This writer expects input data to be sorted by partition key. It maintains only one +/// active writer at a time, making it memory efficient for sorted data. +/// +/// # Type Parameters +/// +/// * `B` - The inner writer builder type +/// * `I` - Input type (defaults to `RecordBatch`) +/// * `O` - Output collection type (defaults to `Vec<DataFile>`) +#[derive(Clone)] +pub struct ClusteredWriter<B, I = DefaultInput, O = DefaultOutput> +where + B: IcebergWriterBuilder<I, O>, + O: IntoIterator + FromIterator<<O as IntoIterator>::Item>, + <O as IntoIterator>::Item: Clone, +{ + inner_builder: B, + current_writer: Option<B::R>, + current_partition: Option<Struct>, + closed_partitions: HashSet<Struct>, + output: Vec<<O as IntoIterator>::Item>, + _phantom: PhantomData<I>, +} + +impl<B, I, O> ClusteredWriter<B, I, O> +where + B: IcebergWriterBuilder<I, O>, + I: Send + 'static, + O: IntoIterator + FromIterator<<O as IntoIterator>::Item>, + <O as IntoIterator>::Item: Send + Clone, +{ + /// Create a new `ClusteredWriter`. + pub fn new(inner_builder: B) -> Self { + Self { + inner_builder, + current_writer: None, + current_partition: None, + closed_partitions: HashSet::new(), + output: Vec::new(), + _phantom: PhantomData, + } + } + + /// Closes the current writer if it exists, flushes the written data to output, and record closed partition. + async fn close_current_writer(&mut self) -> Result<()> { + if let Some(mut writer) = self.current_writer.take() { + self.output.extend(writer.close().await?); + + // Add the current partition to the set of closed partitions + if let Some(current_partition) = self.current_partition.take() { + self.closed_partitions.insert(current_partition); + } + } + + Ok(()) + } +} + +#[async_trait] +impl<B, I, O> PartitioningWriter<I, O> for ClusteredWriter<B, I, O> +where + B: IcebergWriterBuilder<I, O>, + I: Send + 'static, + O: IntoIterator + FromIterator<<O as IntoIterator>::Item> + Send + 'static, + <O as IntoIterator>::Item: Send + Clone, +{ + async fn write(&mut self, partition_key: Option<PartitionKey>, input: I) -> Result<()> { + if let Some(partition_key) = partition_key { + let partition_value = partition_key.data(); + + // Check if this partition has been closed already + if self.closed_partitions.contains(partition_value) { Review Comment: It's odd to add the check here. It's the caller's responsibility to ensure that inputs are sorted, but if it's not, we should not throw error. ########## crates/iceberg/src/writer/mod.rs: ########## @@ -260,8 +270,8 @@ pub trait IcebergWriterBuilder<I = DefaultInput, O = DefaultOutput>: { /// The associated writer type. type R: IcebergWriter<I, O>; - /// Build the iceberg writer. - async fn build(self) -> Result<Self::R>; + /// Build the iceberg writer for an optional partition key. + async fn build_with_partition(self, partition_key: Option<PartitionKey>) -> Result<Self::R>; Review Comment: I'm fine with this change, but I want a further change as following: ``` async fn build(&self, partition_key: Option<PartitionKey>) -> Result<Self::R> ``` If the builder could be reused for creating actual `IcebergWriter`, I want to avoid cloning. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
