com.github.susom.database.DebugSql Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of database Show documentation
Simplified API and compatibility layer for accessing JDBC data sources.
There is a newer version: 4.0
/*
 * Copyright 2014 The Board of Trustees of The Leland Stanford Junior University.
 *
 * Licensed 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 com.github.susom.database;

import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;

import org.slf4j.Logger;

/**
 * Convenience class to substitute real values into a database query for debugging, logging, etc.
 * 
 * WARNING!!! Never execute this SQL without manual inspection because this class does NOTHING
 * to prevent SQL injection or any other bad things.
 *
 * @author garricko
 */
public class DebugSql {
  public static String printDebugOnlySqlString(String sql, Object[] args) {
    StringBuilder buf = new StringBuilder();
    printSql(buf, sql, args, false, true);
    return buf.toString();
  }

  public static void printSql(StringBuilder buf, String sql, Object[] args, Options options) {
    printSql(buf, sql, args, true, options.isLogParameters());
  }

  public static void printSql(StringBuilder buf, String sql, Object[] args, boolean includeExecSql,
                              boolean includeParameters) {
    Object[] argsToPrint = args;
    if (argsToPrint == null) {
      argsToPrint = new Object[0];
    }
    int batchSize = -1;
    if (argsToPrint.length > 0 && argsToPrint instanceof Object[][]) {
      // The arguments provided were from a batch - just use the first set
      batchSize = argsToPrint.length;
      argsToPrint = (Object[]) argsToPrint[0];
    }
    String[] sqlParts = sql.split("\\?");
    if (sqlParts.length != argsToPrint.length + (sql.endsWith("?") ? 0 : 1)) {
      buf.append("(wrong # args) query: ");
      buf.append(sql);
      if (args != null) {
        buf.append(" args: ");
        if (includeParameters) {
          buf.append(Arrays.toString(argsToPrint));
        } else {
          buf.append(argsToPrint.length);
        }
      }
    } else {
      if (includeExecSql) {
        buf.append(sql);
      }
      if (includeParameters && argsToPrint.length > 0) {
        SimpleDateFormat sdf = null;
        if (includeExecSql) {
          buf.append('|');
        }
        for (int i = 0; i < argsToPrint.length; i++) {
          buf.append(sqlParts[i]);
          if (argsToPrint[i] instanceof String) {
            buf.append("'");
            buf.append(argsToPrint[i]);
            buf.append("'");
          } else if (argsToPrint[i] instanceof StatementAdaptor.SqlNull) {
            buf.append("null");
          } else if (argsToPrint[i] instanceof Date) {
            if (sdf == null) {
              sdf = new SimpleDateFormat("yyyy-MM-dd");
            }
            buf.append("to_date('");
            buf.append(sdf.format((Date) argsToPrint[i]));
            buf.append("', 'YYYY-MM-DD')");
          } else {
            buf.append(argsToPrint[i]);
          }
        }
        if (sqlParts.length > argsToPrint.length) {
          buf.append(sqlParts[sqlParts.length - 1]);
        }
      }
    }
    if (batchSize != -1) {
      buf.append(" (first in batch of ");
      buf.append(batchSize);
      buf.append(')');
    }
  }

  public static String exceptionMessage(String sql, Object[] parameters, String errorCode, Options options) {
    StringBuilder buf = new StringBuilder("Error executing SQL");
    if (errorCode != null) {
      buf.append(" (errorCode=").append(errorCode).append(")");
    }
    if (options.isDetailedExceptions()) {
      buf.append(": ");
      DebugSql.printSql(buf, sql, parameters, options);
    }
    return buf.toString();
  }

  public static void logSuccess(String sqlType, Logger log, Metric metric, String sql, Object[] args, Options options) {
    if (log.isDebugEnabled()) {
      StringBuilder buf = new StringBuilder();
      buf.append(sqlType).append(": ");
      metric.printMessage(buf);
      buf.append(" ");
      printSql(buf, sql, args, options);
      log.debug(buf.toString());
    }
  }

  public static void logWarning(String sqlType, Logger log, Metric metric, String errorCode, String sql, Object[] args,
                          Options options, Throwable t) {
    if (log.isWarnEnabled()) {
      StringBuilder buf = new StringBuilder();
      if (errorCode != null) {
        buf.append("errorCode=").append(errorCode).append(" ");
      }
      buf.append(sqlType).append(": ");
      metric.printMessage(buf);
      buf.append(" ");
      printSql(buf, sql, args, options);
      log.warn(buf.toString(), t);
    }
  }

  public static void logError(String sqlType, Logger log, Metric metric, String errorCode, String sql, Object[] args,
                        Options options, Throwable t) {
    if (log.isErrorEnabled()) {
      StringBuilder buf = new StringBuilder();
      if (errorCode != null) {
        buf.append("errorCode=").append(errorCode).append(" ");
      }
      buf.append(sqlType).append(": ");
      metric.printMessage(buf);
      buf.append(" ");
      printSql(buf, sql, args, options);
      log.error(buf.toString(), t);
    }
  }
}