io.cdap.plugin.DBConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of database-plugins Show documentation
The newest version!
/*
 * Copyright © 2015-2019 Cask Data, Inc.
 *
 * 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 io.cdap.plugin;

import io.cdap.cdap.api.annotation.Description;
import io.cdap.cdap.api.annotation.Macro;
import io.cdap.cdap.api.annotation.Name;
import io.cdap.cdap.api.plugin.PluginConfig;
import io.cdap.plugin.common.Constants;

import javax.annotation.Nullable;

/**
 * Defines a base {@link PluginConfig} that Database source and sink can re-use
 */
public class DBConfig extends ConnectionConfig {
  @Name(Constants.Reference.REFERENCE_NAME)
  @Description(Constants.Reference.REFERENCE_NAME_DESCRIPTION)
  public String referenceName;

  @Name(COLUMN_NAME_CASE)
  @Description("Sets the case of the column names returned from the query. " +
    "Possible options are upper or lower. By default or for any other input, the column names are not modified and " +
    "the names returned from the database are used as-is. Note that setting this property provides predictability " +
    "of column name cases across different databases but might result in column name conflicts if multiple column " +
    "names are the same when the case is ignored.")
  @Nullable
  @Macro
  public String columnNameCase;

  public Boolean getEnableAutoCommit() {
    return enableAutoCommit;
  }

  @Nullable
  protected String cleanQuery(@Nullable String query) {
    if (query == null) {
      return null;
    }
    query = query.trim();
    if (query.isEmpty()) {
      return query;
    }
    // find the last character that is not whitespace or a semicolon
    int idx = query.length() - 1;
    char currChar = query.charAt(idx);
    while (idx > 0 && currChar == ';' || Character.isWhitespace(currChar)) {
      idx--;
      currChar = query.charAt(idx);
    }
    // why would somebody do this?
    if (idx == 0) {
      return "";
    }
    return query.substring(0, idx + 1);
  }
}