org.apache.hudi.common.config.HoodieMetaserverConfig Maven / Gradle / Ivy

Go to download
/*
 * 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.hudi.common.config;

import org.apache.hudi.common.table.HoodieTableConfig;

import javax.annotation.concurrent.Immutable;

import java.util.Properties;

/**
 * Configurations used by the HUDI Metaserver.
 */
@Immutable
@ConfigClassProperty(name = "Metaserver Configs",
    groupName = ConfigGroups.Names.WRITE_CLIENT,
    description = "Configurations used by the Hudi Metaserver.")
public class HoodieMetaserverConfig extends HoodieConfig {

  public static final String METASERVER_PREFIX = "hoodie.metaserver";

  public static final ConfigProperty METASERVER_ENABLE = ConfigProperty
      .key(METASERVER_PREFIX + ".enabled")
      .defaultValue(false)
      .markAdvanced()
      .sinceVersion("0.13.0")
      .withDocumentation("Enable Hudi metaserver for storing Hudi tables' metadata.");

  public static final ConfigProperty DATABASE_NAME = HoodieTableConfig.DATABASE_NAME
      .markAdvanced()
      .sinceVersion("0.13.0");

  public static final ConfigProperty TABLE_NAME = HoodieTableConfig.NAME
      .markAdvanced()
      .sinceVersion("0.13.0");

  public static final ConfigProperty METASERVER_URLS = ConfigProperty
      .key(METASERVER_PREFIX + ".uris")
      .defaultValue("thrift://localhost:9090")
      .markAdvanced()
      .sinceVersion("0.13.0")
      .withDocumentation("Metaserver server uris");

  public static final ConfigProperty METASERVER_CONNECTION_RETRIES = ConfigProperty
      .key(METASERVER_PREFIX + ".connect.retries")
      .defaultValue(3)
      .markAdvanced()
      .sinceVersion("0.13.0")
      .withDocumentation("Number of retries while opening a connection to metaserver");

  public static final ConfigProperty METASERVER_CONNECTION_RETRY_DELAY = ConfigProperty
      .key(METASERVER_PREFIX + ".connect.retry.delay")
      .defaultValue(1)
      .markAdvanced()
      .sinceVersion("0.13.0")
      .withDocumentation("Number of seconds for the client to wait between consecutive connection attempts");

  public static HoodieMetaserverConfig.Builder newBuilder() {
    return new HoodieMetaserverConfig.Builder();
  }

  public boolean isMetaserverEnabled() {
    return getBoolean(METASERVER_ENABLE);
  }

  public String getDatabaseName() {
    return getString(DATABASE_NAME);
  }

  public String getTableName() {
    return getString(TABLE_NAME);
  }

  public String getMetaserverUris() {
    return getStringOrDefault(METASERVER_URLS);
  }

  public int getConnectionRetryLimit() {
    return getIntOrDefault(METASERVER_CONNECTION_RETRIES);
  }

  public int getConnectionRetryDelay() {
    return getIntOrDefault(METASERVER_CONNECTION_RETRY_DELAY);
  }

  /**
   * Builder for {@link HoodieMetaserverConfig}.
   */
  public static class Builder {
    private final HoodieMetaserverConfig config = new HoodieMetaserverConfig();

    public Builder fromProperties(Properties props) {
      this.config.getProps().putAll(props);
      return this;
    }

    public Builder setUris(String uris) {
      config.setValue(METASERVER_URLS, uris);
      return this;
    }

    public HoodieMetaserverConfig build() {
      config.setDefaults(HoodieMetaserverConfig.class.getName());
      return config;
    }
  }
}