YswgCodeGenTool.java 6.77 KB
package yswg.sqoop.plugin;

import com.cloudera.sqoop.Sqoop;
import com.cloudera.sqoop.SqoopOptions;
import com.cloudera.sqoop.SqoopOptions.InvalidOptionsException;
import com.cloudera.sqoop.cli.RelatedOptions;
import com.cloudera.sqoop.cli.ToolOptions;
import com.cloudera.sqoop.hive.HiveImport;
import com.cloudera.sqoop.orm.CompilationManager;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.OptionBuilder;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.util.StringUtils;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * Tool that generates code from a database schema.
 */
public class YswgCodeGenTool extends com.cloudera.sqoop.tool.BaseSqoopTool {

	public static final Log LOG = LogFactory.getLog(YswgCodeGenTool.class.getName());

	private List<String> generatedJarFiles;

	public YswgCodeGenTool() {
		super("codegen");
		generatedJarFiles = new ArrayList<String>();
	}

	/**
	 * @return a list of jar files generated as part of this import process
	 */
	public List<String> getGeneratedJarFiles() {
		ArrayList<String> out = new ArrayList<String>(generatedJarFiles);
		return out;
	}

	/**
	 * Generate the .class and .jar files.
	 *
	 * @return the filename of the emitted jar file.
	 * @throws IOException
	 */
	public String generateORM(SqoopOptions options, String tableName)
			throws IOException {
		String existingJar = options.getExistingJarName();
		if (existingJar != null) {
			// This code generator is being invoked as part of an import or export
			// process, and the user has pre-specified a jar and class to use.
			// Don't generate.
			if (manager.isORMFacilitySelfManaged()) {
				// No need to generated any ORM.  Ignore any jar file given on
				// command line also.
				LOG.info("The connection manager declares that it self manages mapping"
						+ " between records & fields and rows & columns.  The jar file "
						+ " provided will have no effect");
			}
			LOG.info("Using existing jar: " + existingJar);
			return existingJar;
		}
		if (manager.isORMFacilitySelfManaged()) {
			// No need to generated any ORM.  Ignore any jar file given on
			// command line also.
			LOG.info("The connection manager declares that it self manages mapping"
					+ " between records & fields and rows & columns.  No class will"
					+ " will be generated.");
			return null;
		}
		LOG.info("Beginning code generation");

		if (options.getFileLayout() == SqoopOptions.FileLayout.ParquetFile) {
			String className = options.getClassName() != null ?
					options.getClassName() : options.getTableName();
			if (className.equalsIgnoreCase(options.getTableName())) {
				className = "codegen_" + className;
				options.setClassName(className);
				LOG.info("Will generate java class as " + options.getClassName());
			}
		}

		CompilationManager compileMgr = new CompilationManager(options);

		// 此处修改为自定义writer
		YswgClassWriter classWriter = new YswgClassWriter(options, manager, tableName,
				compileMgr);

		classWriter.generate();
		compileMgr.compile();
		compileMgr.jar();
		String jarFile = compileMgr.getJarFilename();
		this.generatedJarFiles.add(jarFile);
		return jarFile;
	}


	@Override
	/** {@inheritDoc} */
	public int run(SqoopOptions options) {
		if (!init(options)) {
			return 1;
		}

		try {
			generateORM(options, options.getTableName());

			// If the user has also specified Hive import code generation,
			// use a HiveImport to generate the DDL statements and write
			// them to files (but don't actually perform the import -- thus
			// the generateOnly=true in the constructor).
			if (options.doHiveImport()) {
				// For Parquet file, the import action will create hive table directly
				// via kite. So there is no need to create hive table again.
				if (options.getFileLayout() != SqoopOptions.FileLayout.ParquetFile) {
					HiveImport hiveImport = new HiveImport(options, manager,
							options.getConf(), true);
					hiveImport.importTable(options.getTableName(),
							options.getHiveTableName(), true);
				}
			}
		} catch (IOException ioe) {
			LOG.error("Encountered IOException running codegen job: "
					+ StringUtils.stringifyException(ioe));
			if (System.getProperty(Sqoop.SQOOP_RETHROW_PROPERTY) != null) {
				throw new RuntimeException(ioe);
			} else {
				return 1;
			}
		} finally {
			destroy(options);
		}

		return 0;
	}

	@Override
	/** Configure the command-line arguments we expect to receive */
	public void configureOptions(ToolOptions toolOptions) {

		toolOptions.addUniqueOptions(getCommonOptions());

		RelatedOptions codeGenOpts = getCodeGenOpts(false);
		codeGenOpts.addOption(OptionBuilder.withArgName("table-name")
				.hasArg()
				.withDescription("Table to generate code for")
				.withLongOpt(TABLE_ARG)
				.create());
		codeGenOpts.addOption(OptionBuilder.withArgName("statement")
				.hasArg()
				.withDescription("SQL 'statement' to generate code for")
				.withLongOpt(SQL_QUERY_ARG)
				.create(SQL_QUERY_SHORT_ARG));
		toolOptions.addUniqueOptions(codeGenOpts);

		toolOptions.addUniqueOptions(getOutputFormatOptions());
		toolOptions.addUniqueOptions(getInputFormatOptions());
		toolOptions.addUniqueOptions(getHiveOptions(true));
		toolOptions.addUniqueOptions(getHCatalogOptions());
	}

	@Override
	/** {@inheritDoc} */
	public void printHelp(ToolOptions toolOptions) {
		super.printHelp(toolOptions);
		System.out.println("");
		System.out.println(
				"At minimum, you must specify --connect and --table");
	}

	@Override
	/** {@inheritDoc} */
	public void applyOptions(CommandLine in, SqoopOptions out)
			throws InvalidOptionsException {

		if (in.hasOption(TABLE_ARG)) {
			out.setTableName(in.getOptionValue(TABLE_ARG));
		}
		if (in.hasOption(SQL_QUERY_ARG)) {
			out.setSqlQuery(in.getOptionValue(SQL_QUERY_ARG));
		}

		applyCommonOptions(in, out);
		applyOutputFormatOptions(in, out);
		applyInputFormatOptions(in, out);
		applyCodeGenOptions(in, out, false);
		applyHiveOptions(in, out);
		applyHCatalogOptions(in, out);
	}

	@Override
	/** {@inheritDoc} */
	public void validateOptions(SqoopOptions options)
			throws InvalidOptionsException {

		if (hasUnrecognizedArgs(extraArguments)) {
			throw new InvalidOptionsException(HELP_STR);
		}

		validateCommonOptions(options);
		validateCodeGenOptions(options);
		validateOutputFormatOptions(options);
		validateHiveOptions(options);
		validateHCatalogOptions(options);

		if (options.getTableName() == null
				&& options.getSqlQuery() == null) {
			throw new InvalidOptionsException(
					"--" + TABLE_ARG + " or --" + SQL_QUERY_ARG
							+ " is required for codegen. " + HELP_STR);
		} else if (options.getTableName() != null
				&& options.getSqlQuery() != null) {
			throw new InvalidOptionsException(
					"Cannot specify --" + TABLE_ARG + " and --" + SQL_QUERY_ARG
							+ " together. " + HELP_STR);
		}
	}
}