file_writer.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#pragma once
 
 
#include <functional>
#include <memory>
#include <optional>
#include <vector>
 
#include "iceberg/arrow_c_data.h"
#include "iceberg/file_format.h"
#include "iceberg/metrics.h"
#include "iceberg/metrics_config.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/util/config.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT WriterProperties : public ConfigBase<WriterProperties> {
 public:
  template <typename T>
  using Entry = const ConfigBase<WriterProperties>::Entry<T>;
 
  inline static Entry<std::string> kAvroSchemaName{"write.avro.schema-name", ""};
  inline static Entry<int64_t> kAvroBufferSize{"write.avro.buffer-size", 1024 * 1024};
  inline static Entry<int64_t> kAvroSyncInterval{"write.avro.sync-interval", 16 * 1024};
  inline static Entry<bool> kAvroSkipDatum{"write.avro.skip-datum", true};
  inline static Entry<std::string> kAvroCompression{"write.avro.compression-codec",
                                                    "gzip"};
  inline static Entry<std::string> kAvroCompressionLevel{"write.avro.compression-level",
                                                         ""};
 
  inline static Entry<std::string> kParquetCompression{"write.parquet.compression-codec",
                                                       "zstd"};
  inline static Entry<std::string> kParquetCompressionLevel{
      "write.parquet.compression-level", ""};
  inline static Entry<int64_t> kParquetMaxRowGroupRows{"write.parquet.max-row-group-rows",
                                                       1024 * 1024};
 
 
  static WriterProperties FromMap(
      const std::unordered_map<std::string, std::string>& properties);
};
 
struct ICEBERG_EXPORT WriterOptions {
  std::string path;
  std::shared_ptr<Schema> schema;
  std::shared_ptr<class FileIO> io;
  std::unordered_map<std::string, std::string> metadata;
  std::shared_ptr<MetricsConfig> metrics_config = MetricsConfig::Default();
  WriterProperties properties;
};
 
class ICEBERG_EXPORT Writer {
 public:
  virtual ~Writer() = default;
  Writer() = default;
  Writer(const Writer&) = delete;
  Writer& operator=(const Writer&) = delete;
 
  virtual Status Open(const WriterOptions& options) = 0;
 
  virtual Status Close() = 0;
 
  virtual Status Write(ArrowArray* data) = 0;
 
  virtual Result<Metrics> metrics() = 0;
 
  virtual Result<int64_t> length() = 0;
 
  virtual std::vector<int64_t> split_offsets() = 0;
};
 
using WriterFactory = std::function<Result<std::unique_ptr<Writer>>()>;
 
struct ICEBERG_EXPORT WriterFactoryRegistry {
  WriterFactoryRegistry(FileFormatType format_type, WriterFactory factory);
 
  static WriterFactory& GetFactory(FileFormatType format_type);
 
  static Result<std::unique_ptr<Writer>> Open(FileFormatType format_type,
                                              const WriterOptions& options);
};
 
}  // namespace iceberg