beeline/src/java/org/apache/hive/beeline/SQLCompleter.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.
 */

/*
 * This source file is based on code taken from SQLLine 1.0.2
 * See SQLLine notice in LICENSE
 */
package org.apache.hive.beeline;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.sql.SQLException;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TreeSet;

import jline.console.completer.StringsCompleter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

class SQLCompleter extends StringsCompleter {
  private static final Logger LOG = LoggerFactory.getLogger(SQLCompleter.class.getName());


  public SQLCompleter(Set<String> completions){
    super(completions);
  }

  public static Set<String> getSQLCompleters(BeeLine beeLine, boolean skipmeta)
      throws IOException, SQLException {
    Set<String> completions = new TreeSet<String>();

    // add the default SQL completions
    String keywords = new BufferedReader(new InputStreamReader(
        SQLCompleter.class.getResourceAsStream(
            "/sql-keywords.properties"))).readLine();

    // now add the keywords from the current connection
    try {
      keywords += "," + beeLine.getDatabaseConnection().getDatabaseMetaData().getSQLKeywords();
    } catch (Exception e) {
      LOG.debug("fail to get SQL key words from database metadata due to the exception: " + e, e);
    }
    try {
      keywords += "," + beeLine.getDatabaseConnection().getDatabaseMetaData().getStringFunctions();
    } catch (Exception e) {
      LOG.debug(
        "fail to get string function names from database metadata due to the exception: " + e, e);
    }
    try {
      keywords += "," + beeLine.getDatabaseConnection().getDatabaseMetaData().getNumericFunctions();
    } catch (Exception e) {
      LOG.debug(
        "fail to get numeric function names from database metadata due to the exception: " + e, e);
    }
    try {
      keywords += "," + beeLine.getDatabaseConnection().getDatabaseMetaData().getSystemFunctions();
    } catch (Exception e) {
      LOG.debug(
        "fail to get system function names from database metadata due to the exception: " + e, e);
    }
    try {
      keywords += "," + beeLine.getDatabaseConnection().getDatabaseMetaData().getTimeDateFunctions();
    } catch (Exception e) {
      LOG.debug(
        "fail to get time date function names from database metadata due to the exception: " + e,
        e);
    }

    // also allow lower-case versions of all the keywords
    keywords += "," + keywords.toLowerCase();

    for (StringTokenizer tok = new StringTokenizer(keywords, ", "); tok.hasMoreTokens(); completions
        .add(tok.nextToken())) {
      ;
    }

    // now add the tables and columns from the current connection
    if (!(skipmeta)) {
      String[] columns = beeLine.getColumnNames(beeLine.getDatabaseConnection().getDatabaseMetaData());
      for (int i = 0; columns != null && i < columns.length; i++) {
        completions.add(columns[i++]);
      }
    }

    return completions;
  }
}