mapreduce/src/contrib/vertica/src/java/org/apache/hadoop/vertica/VerticaConfiguration.java

/**
 * 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.hadoop.vertica;

import java.io.IOException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Random;

import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.io.DataInputBuffer;
import org.apache.hadoop.io.DataOutputBuffer;
import org.apache.hadoop.mapreduce.Job;
import org.apache.hadoop.util.StringUtils;

/**
 * A container for configuration property names for jobs with Vertica
 * input/output.
 * 
 * The job can be configured using the static methods in this class,
 * {@link VerticaInputFormat}, and {@link VerticaOutputFormat}. Alternatively,
 * the properties can be set in the configuration with proper values.
 * 
 * @see VerticaConfiguration#configureVertica(Configuration, String[], String,
 *      String, String)
 * @see VerticaConfiguration#configureVertica(Configuration, String[], String,
 *      String, String, String[], String, String, String)
 * @see VerticaInputFormat#setInput(Job, String)
 * @see VerticaInputFormat#setInput(Job, String, Collection<List<Object>>)
 * @see VerticaInputFormat#setInput(Job, String, String)
 * @see VerticaInputFormat#setInput(Job, String, String...)
 * @see VerticaOutputFormat#setOutput(Job, String)
 * @see VerticaOutputFormat#setOutput(Job, String, Collection<VerticaTable>)
 * @see VerticaOutputFormat#setOutput(Job, String, boolean)
 * @see VerticaOutputFormat#setOutput(Job, String, boolean, String...)
 */
public class VerticaConfiguration {
  /** Vertica Version Constants */
  public static final Integer VERSION_3_5 = 305;
  
  /** Class name for Vertica JDBC Driver */
  public static final String VERTICA_DRIVER_CLASS = "com.vertica.Driver";

  /** Host names to connect to, selected from at random */
  public static final String HOSTNAMES_PROP = "mapred.vertica.hostnames";

  /** Name of database to connect to */
  public static final String DATABASE_PROP = "mapred.vertica.database";

  /** User name for Vertica */
  public static final String USERNAME_PROP = "mapred.vertica.username";

  /** Password for Vertica */
  public static final String PASSWORD_PROP = "mapred.vertica.password";

  /** Host names to connect to, selected from at random */
  public static final String OUTPUT_HOSTNAMES_PROP = "mapred.vertica.hostnames.output";

  /** Name of database to connect to */
  public static final String OUTPUT_DATABASE_PROP = "mapred.vertica.database.output";

  /** User name for Vertica */
  public static final String OUTPUT_USERNAME_PROP = "mapred.vertica.username.output";

  /** Password for Vertica */
  public static final String OUTPUT_PASSWORD_PROP = "mapred.vertica.password.output";

  /** Query to run for input */
  public static final String QUERY_PROP = "mapred.vertica.input.query";

  /** Query to run to retrieve parameters */
  public static final String QUERY_PARAM_PROP = "mapred.vertica.input.query.paramquery";

  /** Static parameters for query */
  public static final String QUERY_PARAMS_PROP = "mapred.vertica.input.query.params";

  /** Optional input delimiter for streaming */
  public static final String INPUT_DELIMITER_PROP = "mapred.vertica.input.delimiter";

  /** Optional input terminator for streaming */
  public static final String INPUT_TERMINATOR_PROP = "mapred.vertica.input.terminator";

  /** Whether to marshal dates as strings */
  public static final String DATE_STRING = "mapred.vertica.date_as_string";

  /** Output table name */
  public static final String OUTPUT_TABLE_NAME_PROP = "mapred.vertica.output.table.name";

  /** Definition of output table types */
  public static final String OUTPUT_TABLE_DEF_PROP = "mapred.vertica.output.table.def";

  /** Whether to drop tables */
  public static final String OUTPUT_TABLE_DROP = "mapred.vertica.output.table.drop";

  /** Optional output format delimiter */
  public static final String OUTPUT_DELIMITER_PROP = "mapred.vertica.output.delimiter";

  /** Optional output format terminator */
  public static final String OUTPUT_TERMINATOR_PROP = "mapred.vertica.output.terminator";

  /**
   * Override the sleep timer for optimize to poll when new projetions have
   * refreshed
   */
  public static final String OPTIMIZE_POLL_TIMER_PROP = "mapred.vertica.optimize.poll";

  /**
   * Sets the Vertica database connection information in the (@link
   * Configuration)
   * 
   * @param conf
   *          the configuration
   * @param hostnames
   *          one or more hosts in the Vertica cluster
   * @param database
   *          the name of the Vertica database
   * @param username
   *          Vertica database username
   * @param password
   *          Vertica database password
   */
  public static void configureVertica(Configuration conf, String[] hostnames,
      String database, String username, String password) {
    conf.setStrings(HOSTNAMES_PROP, hostnames);
    conf.set(DATABASE_PROP, database);
    conf.set(USERNAME_PROP, username);
    conf.set(PASSWORD_PROP, password);
  }

  /**
   * Sets the Vertica database connection information in the (@link
   * Configuration)
   * 
   * @param conf
   *          the configuration
   * @param hostnames
   *          one or more hosts in the source Cluster
   * @param database
   *          the name of the source Vertica database
   * @param username
   *          for the source Vertica database
   * @param password
   *          for he source Vertica database
   * @param output_hostnames
   *          one or more hosts in the output Cluster
   * @param output_database
   *          the name of the output VerticaDatabase
   * @param output_username
   *          for the target Vertica database
   * @param output_password
   *          for the target Vertica database
   */
  public static void configureVertica(Configuration conf, String[] hostnames,
      String database, String username, String password,
      String[] output_hostnames, String output_database,
      String output_username, String output_password) {
    configureVertica(conf, hostnames, database, username, password);

    conf.setStrings(OUTPUT_HOSTNAMES_PROP, output_hostnames);
    conf.set(OUTPUT_DATABASE_PROP, output_database);
    conf.set(OUTPUT_USERNAME_PROP, output_username);
    conf.set(OUTPUT_PASSWORD_PROP, output_password);
  }

  private Configuration conf;

  // default record terminator for writing output to Vertica
  public static final String RECORD_TERMINATER = "\u0008";

  // default delimiter for writing output to Vertica
  public static final String DELIMITER = "\u0007";

  // defulat optimize poll timeout
  public static final int OPTIMIZE_POLL_TIMER = 1000;

  VerticaConfiguration(Configuration conf) {
    this.conf = conf;
  }

  public Configuration getConfiguration() {
    return conf;
  }

  /**
   * Returns a connection to a random host in the Vertica cluster
   * 
   * @param output
   *          true if the connection is for writing
   * @throws IOException
   * @throws ClassNotFoundException
   * @throws SQLException
   */
  Connection getConnection(boolean output) throws IOException,
      ClassNotFoundException, SQLException {
    try {
      Class.forName(VERTICA_DRIVER_CLASS);
    } catch (ClassNotFoundException e) {
      throw new RuntimeException(e);
    }

    String[] hosts = conf.getStrings(HOSTNAMES_PROP);
    String user = conf.get(USERNAME_PROP);
    String pass = conf.get(PASSWORD_PROP);
    String database = conf.get(DATABASE_PROP);

    if (output) {
      hosts = conf.getStrings(OUTPUT_HOSTNAMES_PROP, hosts);
      user = conf.get(OUTPUT_USERNAME_PROP, user);
      pass = conf.get(OUTPUT_PASSWORD_PROP, pass);
      database = conf.get(OUTPUT_DATABASE_PROP, database);
    }

    if (hosts == null)
      throw new IOException("Vertica requies a hostname defined by "
          + HOSTNAMES_PROP);
    if (hosts.length == 0)
      throw new IOException("Vertica requies a hostname defined by "
          + HOSTNAMES_PROP);
    if (database == null)
      throw new IOException("Vertica requies a database name defined by "
          + DATABASE_PROP);
    Random r = new Random();
    if (user == null)
      throw new IOException("Vertica requires a username defined by "
          + USERNAME_PROP);
    return DriverManager.getConnection("jdbc:vertica://"
        + hosts[r.nextInt(hosts.length)] + ":5433/" + database, user, pass);
  }

  public String getInputQuery() {
    return conf.get(QUERY_PROP);
  }

  /**
   * get Run this query and give the results to mappers.
   * 
   * @param inputQuery
   */
  public void setInputQuery(String inputQuery) {
    inputQuery = inputQuery.trim();
    if (inputQuery.endsWith(";")) {
      inputQuery = inputQuery.substring(0, inputQuery.length() - 1);
    }
    conf.set(QUERY_PROP, inputQuery);
  }

  /**
   * Return the query used to retrieve parameters for the input query (if set)
   * 
   * @return Returns the query for input parameters
   */
  public String getParamsQuery() {
    return conf.get(QUERY_PARAM_PROP);
  }

  /**
   * Query used to retrieve parameters for the input query. The result set must
   * match the input query parameters preceisely.
   * 
   * @param segment_params_query
   */
  public void setParamsQuery(String segment_params_query) {
    conf.set(QUERY_PARAM_PROP, segment_params_query);
  }

  /**
   * Return static input parameters if set
   * 
   * @return Collection of list of objects representing input parameters
   * @throws IOException
   */
  public Collection<List<Object>> getInputParameters() throws IOException {
    Collection<List<Object>> values = null;
    String[] query_params = conf.getStrings(QUERY_PARAMS_PROP);
    if (query_params != null) {
      values = new ArrayList<List<Object>>();
      for (String str_params : query_params) {
        DataInputBuffer in = new DataInputBuffer();
        in.reset(StringUtils.hexStringToByte(str_params), str_params.length());
        VerticaRecord record = new VerticaRecord();
        record.readFields(in);
        values.add(record.getValues());
      }
    }
    return values;
  }

  /**
   * Sets a collection of lists. Each list is passed to an input split and used
   * as arguments to the input query.
   * 
   * @param segmentParams
   * @throws IOException
   */
  public void setInputParams(Collection<List<Object>> segment_params)
      throws IOException {
    String[] values = new String[segment_params.size()];
    int i = 0;
    for (List<Object> params : segment_params) {
      DataOutputBuffer out = new DataOutputBuffer();
      VerticaRecord record = new VerticaRecord(params, true);
      record.write(out);
      values[i++] = StringUtils.byteToHexString(out.getData());
    }
    conf.setStrings(QUERY_PARAMS_PROP, values);
  }

  /**
   * For streaming return the delimiter to separate values to the mapper
   * 
   * @return Returns delimiter used to format streaming input data
   */
  public String getInputDelimiter() {
    return conf.get(INPUT_DELIMITER_PROP, DELIMITER);
  }

  /**
   * For streaming set the delimiter to separate values to the mapper
   */
  public void setInputDelimiter(String delimiter) {
    conf.set(INPUT_DELIMITER_PROP, delimiter);
  }

  /**
   * For streaming return the record terminator to separate values to the mapper
   * 
   * @return Returns recorder terminator for input data
   */
  public String getInputRecordTerminator() {
    return conf.get(INPUT_TERMINATOR_PROP, RECORD_TERMINATER);
  }

  /**
   * For streaming set the record terminator to separate values to the mapper
   */
  public void setInputRecordTerminator(String terminator) {
    conf.set(INPUT_TERMINATOR_PROP, terminator);
  }

  /**
   * Get the table that is the target of output
   * 
   * @return Returns table name for output
   */
  public String getOutputTableName() {
    return conf.get(OUTPUT_TABLE_NAME_PROP);
  }

  /**
   * Set table that is being loaded as output
   * 
   * @param tableName
   */
  public void setOutputTableName(String tableName) {
    conf.set(OUTPUT_TABLE_NAME_PROP, tableName);
  }

  /**
   * Return definition of columns for output table
   * 
   * @return Returns table definition for output table
   */
  public String[] getOutputTableDef() {
    return conf.getStrings(OUTPUT_TABLE_DEF_PROP);
  }

  /**
   * Set the definition of a table for output if it needs to be created
   * 
   * @param fieldNames
   */
  public void setOutputTableDef(String... fieldNames) {
    conf.setStrings(OUTPUT_TABLE_DEF_PROP, fieldNames);
  }

  /**
   * Return whether output table is truncated before loading
   * 
   * @return Returns true if output table should be dropped before loading
   */
  public boolean getDropTable() {
    return conf.getBoolean(OUTPUT_TABLE_DROP, false);
  }

  /**
   * Set whether to truncate the output table before loading
   * 
   * @param drop_table
   */
  public void setDropTable(boolean drop_table) {
    conf.setBoolean(OUTPUT_TABLE_DROP, drop_table);
  }

  /**
   * For streaming return the delimiter used by the reducer
   * 
   * @return Returns delimiter to use for output data
   */
  public String getOutputDelimiter() {
    return conf.get(OUTPUT_DELIMITER_PROP, DELIMITER);
  }

  /**
   * For streaming set the delimiter used by the reducer
   * 
   * @param delimiter
   */
  public void setOutputDelimiter(String delimiter) {
    conf.set(OUTPUT_DELIMITER_PROP, delimiter);
  }

  /**
   * For streaming return the record terminator used by the reducer
   * 
   * @return Returns the record terminator for output data
   */
  public String getOutputRecordTerminator() {
    return conf.get(OUTPUT_TERMINATOR_PROP, RECORD_TERMINATER);
  }

  /**
   * For streaming set the record terminator used by the reducer
   * 
   * @param terminator
   */
  public void setOutputRecordTerminator(String terminator) {
    conf.set(OUTPUT_TERMINATOR_PROP, terminator);
  }

  /**
   * Returns poll timer for optimize loop
   * 
   * @return Returns poll timer for optimize loop
   */
  public Long getOptimizePollTimeout() {
    return conf.getLong(OPTIMIZE_POLL_TIMER_PROP, OPTIMIZE_POLL_TIMER);
  }

  /**
   * Set the timour for the optimize poll loop
   * 
   * @param timeout
   */
  public void setOptimizePollTimeout(Long timeout) {
    conf.setLong(OPTIMIZE_POLL_TIMER_PROP, timeout);
  }
}