gobblin.writer.commands.JdbcWriterCommands Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gobblin-core Show documentation
Gobblin Ingestion Framework
There is a newer version: 0.8.0
/*
 * Copyright (C) 2014-2016 LinkedIn Corp. All rights reserved.
 *
 * 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.
 */
package gobblin.writer.commands;

import gobblin.converter.jdbc.JdbcType;

import java.sql.SQLException;
import java.util.Map;

/**
 * JdbcWriterCommands is interface that its implementation will
 * directly talk with underlying RDBMS via JDBC. Different RDBMS may use different SQL syntax,
 * and having this interface decouples JdbcWriter with any syntax difference each RDBMS might have.
 */
public interface JdbcWriterCommands extends JdbcBufferedInserter {

  /**
   * Creates table structure based on the table in parameter. Note that this won't guarantee copy exactly the same as
   * original table such as restraints, foreign keys, sequences, indices, etc
   * @param fromStructure
   * @param targetTableName
   * @throws SQLException
   */
  public void createTableStructure(String fromStructure, String targetTableName) throws SQLException;

  /**
   * Check if table is empty.
   * @param table
   * @return
   * @throws SQLException
   */
  public boolean isEmpty(String table) throws SQLException;

  /**
   * Truncates table. Most RDBMS cannot be rollback from this operation.
   * @param table table name to be truncated.
   * @throws SQLException
   */
  public void truncate(String table) throws SQLException;

  /**
   * Deletes all contents from the table. This method can be rollback if not committed.
   * @param table
   * @throws SQLException
   */
  public void deleteAll(String table) throws SQLException;

  /**
   * Drops the table.
   * @param table
   * @throws SQLException
   */
  public void drop(String table) throws SQLException;

  /**
   * Retrieves date related column such as Date, Time, DateTime, Timestamp etc.
   * @param table
   * @return Map of column name and JdbcType that is date related.
   * @throws SQLException
   */
  public Map retrieveDateColumns(String table) throws SQLException;

  /**
   * Copy all the contents from one table to another. Both table should be in same structure.
   * @param databaseName
   * @param from
   * @param to
   * @throws SQLException
   */
  public void copyTable(String databaseName, String from, String to) throws SQLException;
}