You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by co...@locus.apache.org on 2000/07/24 16:27:14 UTC

cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs SQLExec.java defaults.properties

conor       00/07/24 07:27:14

  Modified:    src/main/org/apache/tools/ant/taskdefs defaults.properties
  Added:       src/main/org/apache/tools/ant/taskdefs SQLExec.java
  Log:
  Task to execute SQL from a file (or directly in the task)
  
  Submitted by:	Jeff Martin <je...@synamic.co.uk>
  
  Revision  Changes    Path
  1.27      +1 -0      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/defaults.properties
  
  Index: defaults.properties
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/defaults.properties,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  --- defaults.properties	2000/07/21 13:29:57	1.26
  +++ defaults.properties	2000/07/24 14:27:13	1.27
  @@ -38,6 +38,7 @@
   antstructure=org.apache.tools.ant.taskdefs.AntStructure
   executeon=org.apache.tools.ant.taskdefs.ExecuteOn
   antcall=org.apache.tools.ant.taskdefs.CallTarget
  +sql=org.apache.tools.ant.taskdefs.SQLExec
   
   # optional tasks
   script=org.apache.tools.ant.taskdefs.optional.Script
  
  
  
  1.1                  jakarta-ant/src/main/org/apache/tools/ant/taskdefs/SQLExec.java
  
  Index: SQLExec.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer. 
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:  
   *       "This product includes software developed by the 
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written 
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  package org.apache.tools.ant.taskdefs;
  
  import org.apache.tools.ant.*;
  
  import java.io.*;
  import java.util.Enumeration;
  import java.util.StringTokenizer;
  import java.util.Vector;
  import java.util.zip.*;
  import java.sql.*;
  
  /**
   * Reads in a text file containing SQL statements seperated with semicolons
   * and executes it in a given db.
   * Both -- and // maybe used as comments.
   * 
   * @author <a href="mailto:jeff@custommonkey.org">Jeff Martin</a>
   */
  public class SQLExec extends Task {
  
      /**
       * DB driver.
       */
      private String driver = null;
  
      /**
       * DB url.
       */
      private String url = null;
  
      /**
       * User name.
       */
      private String userId = null;
  
      /**
       * Password
       */
      private String password = null;
  
      /**
       * SQL input file
       */
      private File inputFile = null;
  
      /**
       * SQL input command
       */
      private String sqlCommand = null;
      
      /**
       * Set the name of the sql file to be run.
       */
      public void setInputfile(File inputFile) {
          this.inputFile = inputFile;
      }
      
      /**
       * Set the name of the sql file to be run.
       */
      public void setSQL(String sql) {
          this.sqlCommand = sql;
      }
      
      /**
       * Set the JDBC driver to be used.
       */
      public void setDriver(String driver) {
          this.driver = driver;
      }
      
      /**
       * Set the DB connection url.
       */
      public void setUrl(String url) {
          this.url = url;
      }
      
      /**
       * Set the user name for the DB connection.
       */
      public void setUserid(String userId) {
          this.userId = userId;
      }
      
      /**
       * Set the password for the DB connection.
       */
      public void setPassword(String password) {
          this.password = password;
      }
      
      /**
       * Load the sql file and then execute it
       */
      public void execute() throws BuildException {
          Connection conn = null;
  
          if (inputFile == null && sqlCommand == null) {
              throw new BuildException("Input file or sql attribute must be set!");
          }
          if (driver == null) {
              throw new BuildException("Driver attribute must be set!");
          }
          if (userId == null) {
              throw new BuildException("User Id attribute must be set!");
          }
          if (password == null) {
              throw new BuildException("Password attribute must be set!");
          }
          if (url == null) {
              throw new BuildException("Url attribute must be set!");
          }
          if (inputFile != null && !inputFile.exists()) {
              throw new BuildException("Input file does not exist!");
          }
  
          try{
              Class.forName(driver);
          }catch(ClassNotFoundException e){
              throw new BuildException("JDBC driver " + driver + " could not be loaded");
          }
  
          String line = "";
          String sql = "";
          Statement statement = null;
  
          try{
              log("connectiing to " + url, Project.MSG_VERBOSE );
              conn = DriverManager.getConnection(url, userId, password);
              statement = conn.createStatement();
  
              if (sqlCommand != null) {
                  execSQL(statement, sqlCommand);
              }
              
              if (inputFile != null) {
                  BufferedReader in = new BufferedReader(new FileReader(inputFile));
    
                  while ((line=in.readLine()) != null){
                      if (line.trim().startsWith("//")) continue;
                      if (line.trim().startsWith("--")) continue;
   
                      sql += " " + line;
                      if (sql.trim().endsWith(";")){
                          log("SQL: " + sql, Project.MSG_VERBOSE);
                          execSQL(statement, sql.substring(0, sql.length()-1));
                          sql = "";
                      }
                  }
              }
              
              conn.commit();
          } catch(IOException e){
              throw new BuildException(e);
          } catch(SQLException e){
              log("Failed to execute: " + sql, Project.MSG_ERR);
              throw new BuildException(e);
          }
          finally {
              try {
                  if (statement != null) {
                      statement.close();
                  }
                  if (conn != null) {
                      conn.close();
                  }
              }
              catch (SQLException e) {}
          }
            
          log("SQL statements executed successfully", Project.MSG_VERBOSE);
      }
  
      /**
      * Exec the sql statement.
      */
      private void execSQL(Statement statement, String sql) throws SQLException{
          statement.executeQuery(sql);
      }
  
  }