org.apache.iceberg.spark.SparkConfParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iceberg-spark-3.5_2.13 Show documentation
A table format for huge analytic datasets
The newest version!
/*
 * 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 org.apache.iceberg.spark;

import java.time.Duration;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import org.apache.iceberg.Table;
import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap;
import org.apache.iceberg.relocated.com.google.common.collect.Lists;
import org.apache.spark.network.util.JavaUtils;
import org.apache.spark.sql.RuntimeConfig;
import org.apache.spark.sql.SparkSession;
import org.apache.spark.sql.internal.SQLConf;
import org.apache.spark.sql.util.CaseInsensitiveStringMap;

class SparkConfParser {

  private final Map properties;
  private final RuntimeConfig sessionConf;
  private final CaseInsensitiveStringMap options;

  SparkConfParser() {
    this.properties = ImmutableMap.of();
    this.sessionConf = new RuntimeConfig(SQLConf.get());
    this.options = CaseInsensitiveStringMap.empty();
  }

  SparkConfParser(SparkSession spark, Table table, Map options) {
    this.properties = table.properties();
    this.sessionConf = spark.conf();
    this.options = asCaseInsensitiveStringMap(options);
  }

  public BooleanConfParser booleanConf() {
    return new BooleanConfParser();
  }

  public IntConfParser intConf() {
    return new IntConfParser();
  }

  public LongConfParser longConf() {
    return new LongConfParser();
  }

  public StringConfParser stringConf() {
    return new StringConfParser();
  }

  public DurationConfParser durationConf() {
    return new DurationConfParser();
  }

  public > EnumConfParser enumConf(Function toEnum) {
    return new EnumConfParser<>(toEnum);
  }

  private static CaseInsensitiveStringMap asCaseInsensitiveStringMap(Map map) {
    if (map instanceof CaseInsensitiveStringMap) {
      return (CaseInsensitiveStringMap) map;
    } else {
      return new CaseInsensitiveStringMap(map);
    }
  }

  class BooleanConfParser extends ConfParser {
    private Boolean defaultValue;
    private boolean negate = false;

    @Override
    protected BooleanConfParser self() {
      return this;
    }

    public BooleanConfParser defaultValue(boolean value) {
      this.defaultValue = value;
      return self();
    }

    public BooleanConfParser defaultValue(String value) {
      this.defaultValue = Boolean.parseBoolean(value);
      return self();
    }

    public BooleanConfParser negate() {
      this.negate = true;
      return self();
    }

    public boolean parse() {
      Preconditions.checkArgument(defaultValue != null, "Default value cannot be null");
      boolean value = parse(Boolean::parseBoolean, defaultValue);
      return negate ? !value : value;
    }
  }

  class IntConfParser extends ConfParser {
    private Integer defaultValue;

    @Override
    protected IntConfParser self() {
      return this;
    }

    public IntConfParser defaultValue(int value) {
      this.defaultValue = value;
      return self();
    }

    public int parse() {
      Preconditions.checkArgument(defaultValue != null, "Default value cannot be null");
      return parse(Integer::parseInt, defaultValue);
    }

    public Integer parseOptional() {
      return parse(Integer::parseInt, defaultValue);
    }
  }

  class LongConfParser extends ConfParser {
    private Long defaultValue;

    @Override
    protected LongConfParser self() {
      return this;
    }

    public LongConfParser defaultValue(long value) {
      this.defaultValue = value;
      return self();
    }

    public long parse() {
      Preconditions.checkArgument(defaultValue != null, "Default value cannot be null");
      return parse(Long::parseLong, defaultValue);
    }

    public Long parseOptional() {
      return parse(Long::parseLong, defaultValue);
    }
  }

  class StringConfParser extends ConfParser {
    private String defaultValue;

    @Override
    protected StringConfParser self() {
      return this;
    }

    public StringConfParser defaultValue(String value) {
      this.defaultValue = value;
      return self();
    }

    public String parse() {
      Preconditions.checkArgument(defaultValue != null, "Default value cannot be null");
      return parse(Function.identity(), defaultValue);
    }

    public String parseOptional() {
      return parse(Function.identity(), defaultValue);
    }
  }

  class DurationConfParser extends ConfParser {
    private Duration defaultValue;

    @Override
    protected DurationConfParser self() {
      return this;
    }

    public DurationConfParser defaultValue(Duration value) {
      this.defaultValue = value;
      return self();
    }

    public Duration parse() {
      Preconditions.checkArgument(defaultValue != null, "Default value cannot be null");
      return parse(this::toDuration, defaultValue);
    }

    public Duration parseOptional() {
      return parse(this::toDuration, defaultValue);
    }

    private Duration toDuration(String time) {
      return Duration.ofSeconds(JavaUtils.timeStringAsSec(time));
    }
  }

  class EnumConfParser> extends ConfParser, T> {
    private final Function toEnum;
    private T defaultValue;

    EnumConfParser(Function toEnum) {
      this.toEnum = toEnum;
    }

    @Override
    protected EnumConfParser self() {
      return this;
    }

    public EnumConfParser defaultValue(T value) {
      this.defaultValue = value;
      return self();
    }

    public EnumConfParser defaultValue(String value) {
      this.defaultValue = toEnum.apply(value);
      return self();
    }

    public T parse() {
      Preconditions.checkArgument(defaultValue != null, "Default value cannot be null");
      return parse(toEnum, defaultValue);
    }

    public T parseOptional() {
      return parse(toEnum, defaultValue);
    }
  }

  abstract class ConfParser {
    private final List optionNames = Lists.newArrayList();
    private String sessionConfName;
    private String tablePropertyName;

    protected abstract ThisT self();

    public ThisT option(String name) {
      this.optionNames.add(name);
      return self();
    }

    public ThisT sessionConf(String name) {
      this.sessionConfName = name;
      return self();
    }

    public ThisT tableProperty(String name) {
      this.tablePropertyName = name;
      return self();
    }

    protected T parse(Function conversion, T defaultValue) {
      for (String optionName : optionNames) {
        String optionValue = options.get(optionName);
        if (optionValue != null) {
          return conversion.apply(optionValue);
        }

        String sparkOptionValue = options.get(toCamelCase(optionName));
        if (sparkOptionValue != null) {
          return conversion.apply(sparkOptionValue);
        }
      }

      if (sessionConfName != null) {
        String sessionConfValue = sessionConf.get(sessionConfName, null);
        if (sessionConfValue != null) {
          return conversion.apply(sessionConfValue);
        }

        String sparkSessionConfValue = sessionConf.get(toCamelCase(sessionConfName), null);
        if (sparkSessionConfValue != null) {
          return conversion.apply(sparkSessionConfValue);
        }
      }

      if (tablePropertyName != null) {
        String propertyValue = properties.get(tablePropertyName);
        if (propertyValue != null) {
          return conversion.apply(propertyValue);
        }
      }

      return defaultValue;
    }

    private String toCamelCase(String key) {
      StringBuilder transformedKey = new StringBuilder();
      boolean capitalizeNext = false;

      for (char character : key.toCharArray()) {
        if (character == '-') {
          capitalizeNext = true;
        } else if (capitalizeNext) {
          transformedKey.append(Character.toUpperCase(character));
          capitalizeNext = false;
        } else {
          transformedKey.append(character);
        }
      }

      return transformedKey.toString();
    }
  }
}