org.apache.hadoop.hive.ql.hooks.HookContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hive-exec
There is a newer version: 4.0.1
/*
 * 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.hive.ql.hooks;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.apache.hadoop.fs.ContentSummary;
import org.apache.hadoop.hive.common.classification.InterfaceAudience;
import org.apache.hadoop.hive.common.classification.InterfaceStability;
import org.apache.hadoop.hive.conf.HiveConf;
import org.apache.hadoop.hive.ql.QueryInfo;
import org.apache.hadoop.hive.ql.QueryPlan;
import org.apache.hadoop.hive.ql.QueryState;
import org.apache.hadoop.hive.ql.exec.TaskRunner;
import org.apache.hadoop.hive.ql.history.HiveHistory;
import org.apache.hadoop.hive.ql.log.PerfLogger;
import org.apache.hadoop.hive.ql.optimizer.lineage.LineageCtx.Index;
import org.apache.hadoop.hive.shims.Utils;
import org.apache.hadoop.security.UserGroupInformation;
import org.apache.hadoop.yarn.api.records.ApplicationId;
/**
 * Hook Context keeps all the necessary information for all the hooks.
 * New implemented hook can get the query plan, job conf and the list of all completed tasks from this hook context
 */
@InterfaceAudience.Public
@InterfaceStability.Stable
public class HookContext {

  static public enum HookType {
    PRE_EXEC_HOOK, POST_EXEC_HOOK, ON_FAILURE_HOOK
  }

  private QueryPlan queryPlan;
  private final QueryState queryState;
  private HiveConf conf;
  private List completeTaskList;
  private Set inputs;
  private Set outputs;
  private LineageInfo linfo;
  private Index depMap;
  private UserGroupInformation ugi;
  private HookType hookType;
  private String errorMessage;
  private Throwable exception;
  final private Map inputPathToContentSummary;
  private final String ipAddress;
  private final String hiveInstanceAddress;
  private final String userName;
  // unique id set for operation when run from HS2, base64 encoded value of
  // TExecuteStatementResp.TOperationHandle.THandleIdentifier.guid
  private final String operationId;
  private final String sessionId;
  private final String threadId;
  private final boolean isHiveServerQuery;
  private final PerfLogger perfLogger;
  private final QueryInfo queryInfo;

  public HookContext(QueryPlan queryPlan, QueryState queryState,
      Map inputPathToContentSummary, String userName, String ipAddress,
      String hiveInstanceAddress, String operationId, String sessionId, String threadId,
      boolean isHiveServerQuery, PerfLogger perfLogger, QueryInfo queryInfo) throws Exception {
    this.queryPlan = queryPlan;
    this.queryState = queryState;
    this.conf = queryState.getConf();
    this.inputPathToContentSummary = inputPathToContentSummary;
    completeTaskList = new ArrayList();
    inputs = queryPlan.getInputs();
    outputs = queryPlan.getOutputs();
    ugi = Utils.getUGI();
    linfo = queryState.getLineageState().getLineageInfo();
    depMap = queryState.getLineageState().getIndex();
    this.userName = userName;
    this.ipAddress = ipAddress;
    this.hiveInstanceAddress = hiveInstanceAddress;
    this.operationId = operationId;
    this.sessionId = sessionId;
    this.threadId = threadId;
    this.isHiveServerQuery = isHiveServerQuery;
    this.perfLogger = perfLogger;
    this.queryInfo = queryInfo;
  }

  public QueryPlan getQueryPlan() {
    return queryPlan;
  }

  public void setQueryPlan(QueryPlan queryPlan) {
    this.queryPlan = queryPlan;
  }

  public HiveConf getConf() {
    return conf;
  }

  public void setConf(HiveConf conf) {
    this.conf = conf;
  }

  public List getCompleteTaskList() {
    return completeTaskList;
  }

  public void setCompleteTaskList(List completeTaskList) {
    this.completeTaskList = completeTaskList;
  }

  public void addCompleteTask(TaskRunner completeTaskRunner) {
    completeTaskList.add(completeTaskRunner);
  }

  public Set getInputs() {
    return inputs;
  }

  public void setInputs(Set inputs) {
    this.inputs = inputs;
  }

  public Set getOutputs() {
    return outputs;
  }

  public void setOutputs(Set outputs) {
    this.outputs = outputs;
  }

  public LineageInfo getLinfo() {
    return linfo;
  }

  public void setLinfo(LineageInfo linfo) {
    this.linfo = linfo;
  }

  public Index getIndex() {
    return depMap;
  }

  public void setIndex(Index depMap) {
    this.depMap = depMap;
  }

  public UserGroupInformation getUgi() {
    return ugi;
  }

  public void setUgi(UserGroupInformation ugi) {
    this.ugi = ugi;
  }

  public Map getInputPathToContentSummary() {
    return inputPathToContentSummary;
  }

  public HookType getHookType() {
    return hookType;
  }

  public void setHookType(HookType hookType) {
    this.hookType = hookType;
  }

  public String getIpAddress() {
    return this.ipAddress;
  }

  public String getHiveInstanceAddress() {
    return hiveInstanceAddress;
  }

  public void setErrorMessage(String errorMessage) {
    this.errorMessage = errorMessage;
  }

  public String getErrorMessage() {
    return errorMessage;
  }

  public void setException(Throwable exception) {
    this.exception = exception;
  }

  public Throwable getException() {
    return exception;
  }

  public String getOperationName() {
    return queryPlan.getOperationName();
  }

  public String getUserName() {
    return this.userName;
  }

  public String getOperationId() {
    return operationId;
  }

  public QueryState getQueryState() {
    return queryState;
  }

  public String getSessionId() {
    return sessionId;
  }

  public String getThreadId() {
    return threadId;
  }

  public boolean isHiveServerQuery() {
    return isHiveServerQuery;
  }

  public PerfLogger getPerfLogger() {
    return perfLogger;
  }

  public QueryInfo getQueryInfo() {
    return queryInfo;
  }
}