Open Source Repository

Home /hibernate/hibernate-3.2.7.ga | Repository Home


org/hibernate/dialect/HSQLDialect.java
//$Id: HSQLDialect.java 14085 2007-10-16 21:09:15Z [email protected] $
package org.hibernate.dialect;

import java.sql.SQLException;
import java.sql.Types;
import java.io.Serializable;

import org.hibernate.Hibernate;
import org.hibernate.LockMode;
import org.hibernate.StaleObjectStateException;
import org.hibernate.JDBCException;
import org.hibernate.engine.SessionImplementor;
import org.hibernate.persister.entity.Lockable;
import org.hibernate.cfg.Environment;
import org.hibernate.dialect.function.NoArgSQLFunction;
import org.hibernate.dialect.function.StandardSQLFunction;
import org.hibernate.dialect.function.VarArgsSQLFunction;
import org.hibernate.dialect.lock.LockingStrategy;
import org.hibernate.dialect.lock.SelectLockingStrategy;
import org.hibernate.exception.JDBCExceptionHelper;
import org.hibernate.exception.TemplatedViolatedConstraintNameExtracter;
import org.hibernate.exception.ViolatedConstraintNameExtracter;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * An SQL dialect compatible with HSQLDB (Hypersonic SQL).
 <p/>
 * Note this version supports HSQLDB version 1.8 and higher, only.
 *
 @author Christoph Sturm
 @author Phillip Baird
 */
public class HSQLDialect extends Dialect {

  private static final Log log = LogFactory.getLogHSQLDialect.class );

  public HSQLDialect() {
    super();
    registerColumnTypeTypes.BIGINT, "bigint" );
    registerColumnTypeTypes.BINARY, "binary" );
    registerColumnTypeTypes.BIT, "bit" );
    registerColumnTypeTypes.CHAR, "char(1)" );
    registerColumnTypeTypes.DATE, "date" );
    registerColumnTypeTypes.DECIMAL, "decimal" );
    registerColumnTypeTypes.DOUBLE, "double" );
    registerColumnTypeTypes.FLOAT, "float" );
    registerColumnTypeTypes.INTEGER, "integer" );
    registerColumnTypeTypes.LONGVARBINARY, "longvarbinary" );
    registerColumnTypeTypes.LONGVARCHAR, "longvarchar" );
    registerColumnTypeTypes.SMALLINT, "smallint" );
    registerColumnTypeTypes.TINYINT, "tinyint" );
    registerColumnTypeTypes.TIME, "time" );
    registerColumnTypeTypes.TIMESTAMP, "timestamp" );
    registerColumnTypeTypes.VARCHAR, "varchar($l)" );
    registerColumnTypeTypes.VARBINARY, "varbinary($l)" );
    registerColumnTypeTypes.NUMERIC, "numeric" );
    //HSQL has no Blob/Clob support .... but just put these here for now!
    registerColumnTypeTypes.BLOB, "longvarbinary" );
    registerColumnTypeTypes.CLOB, "longvarchar" );

    registerFunction"ascii"new StandardSQLFunction"ascii", Hibernate.INTEGER ) );
    registerFunction"char"new StandardSQLFunction"char", Hibernate.CHARACTER ) );
    registerFunction"length"new StandardSQLFunction"length", Hibernate.LONG ) );
    registerFunction"lower"new StandardSQLFunction"lower" ) );
    registerFunction"upper"new StandardSQLFunction"upper" ) );
    registerFunction"lcase"new StandardSQLFunction"lcase" ) );
    registerFunction"ucase"new StandardSQLFunction"ucase" ) );
    registerFunction"soundex"new StandardSQLFunction"soundex", Hibernate.STRING ) );
    registerFunction"ltrim"new StandardSQLFunction"ltrim" ) );
    registerFunction"rtrim"new StandardSQLFunction"rtrim" ) );
    registerFunction"reverse"new StandardSQLFunction"reverse" ) );
    registerFunction"space"new StandardSQLFunction"space", Hibernate.STRING ) );
    registerFunction"rawtohex"new StandardSQLFunction"rawtohex" ) );
    registerFunction"hextoraw"new StandardSQLFunction"hextoraw" ) );

    registerFunction"user"new NoArgSQLFunction"user", Hibernate.STRING ) );
    registerFunction"database"new NoArgSQLFunction"database", Hibernate.STRING ) );

    registerFunction"current_date"new NoArgSQLFunction"current_date", Hibernate.DATE, false ) );
    registerFunction"curdate"new NoArgSQLFunction"curdate", Hibernate.DATE ) );
    registerFunction"current_timestamp"new NoArgSQLFunction"current_timestamp", Hibernate.TIMESTAMP, false ) );
    registerFunction"now"new NoArgSQLFunction"now", Hibernate.TIMESTAMP ) );
    registerFunction"current_time"new NoArgSQLFunction"current_time", Hibernate.TIME, false ) );
    registerFunction"curtime"new NoArgSQLFunction"curtime", Hibernate.TIME ) );
    registerFunction"day"new StandardSQLFunction"day", Hibernate.INTEGER ) );
    registerFunction"dayofweek"new StandardSQLFunction"dayofweek", Hibernate.INTEGER ) );
    registerFunction"dayofyear"new StandardSQLFunction"dayofyear", Hibernate.INTEGER ) );
    registerFunction"dayofmonth"new StandardSQLFunction"dayofmonth", Hibernate.INTEGER ) );
    registerFunction"month"new StandardSQLFunction"month", Hibernate.INTEGER ) );
    registerFunction"year"new StandardSQLFunction"year", Hibernate.INTEGER ) );
    registerFunction"week"new StandardSQLFunction"week", Hibernate.INTEGER ) );
    registerFunction"quater"new StandardSQLFunction"quater", Hibernate.INTEGER ) );
    registerFunction"hour"new StandardSQLFunction"hour", Hibernate.INTEGER ) );
    registerFunction"minute"new StandardSQLFunction"minute", Hibernate.INTEGER ) );
    registerFunction"second"new StandardSQLFunction"second", Hibernate.INTEGER ) );
    registerFunction"dayname"new StandardSQLFunction"dayname", Hibernate.STRING ) );
    registerFunction"monthname"new StandardSQLFunction"monthname", Hibernate.STRING ) );

    registerFunction"abs"new StandardSQLFunction"abs" ) );
    registerFunction"sign"new StandardSQLFunction"sign", Hibernate.INTEGER ) );

    registerFunction"acos"new StandardSQLFunction"acos", Hibernate.DOUBLE ) );
    registerFunction"asin"new StandardSQLFunction"asin", Hibernate.DOUBLE ) );
    registerFunction"atan"new StandardSQLFunction"atan", Hibernate.DOUBLE ) );
    registerFunction"cos"new StandardSQLFunction"cos", Hibernate.DOUBLE ) );
    registerFunction"cot"new StandardSQLFunction"cot", Hibernate.DOUBLE ) );
    registerFunction"exp"new StandardSQLFunction"exp", Hibernate.DOUBLE ) );
    registerFunction"log"new StandardSQLFunction"log", Hibernate.DOUBLE ) );
    registerFunction"log10"new StandardSQLFunction"log10", Hibernate.DOUBLE ) );
    registerFunction"sin"new StandardSQLFunction"sin", Hibernate.DOUBLE ) );
    registerFunction"sqrt"new StandardSQLFunction"sqrt", Hibernate.DOUBLE ) );
    registerFunction"tan"new StandardSQLFunction"tan", Hibernate.DOUBLE ) );
    registerFunction"pi"new NoArgSQLFunction"pi", Hibernate.DOUBLE ) );
    registerFunction"rand"new StandardSQLFunction"rand", Hibernate.FLOAT ) );

    registerFunction"radians"new StandardSQLFunction"radians", Hibernate.DOUBLE ) );
    registerFunction"degrees"new StandardSQLFunction"degrees", Hibernate.DOUBLE ) );
    registerFunction"roundmagic"new StandardSQLFunction"roundmagic" ) );

    registerFunction"ceiling"new StandardSQLFunction"ceiling" ) );
    registerFunction"floor"new StandardSQLFunction"floor" ) );

    // Multi-param dialect functions...
    registerFunction"mod"new StandardSQLFunction"mod", Hibernate.INTEGER ) );

    // function templates
    registerFunction"concat"new VarArgsSQLFunctionHibernate.STRING, "(""||"")" ) );

    getDefaultProperties().setPropertyEnvironment.STATEMENT_BATCH_SIZE, DEFAULT_BATCH_SIZE );
  }

  public String getAddColumnString() {
    return "add column";
  }

  public boolean supportsIdentityColumns() {
    return true;
  }

  public String getIdentityColumnString() {
    return "generated by default as identity (start with 1)"//not null is implicit
  }

  public String getIdentitySelectString() {
    return "call identity()";
  }

  public String getIdentityInsertString() {
    return "null";
  }

  public String getForUpdateString() {
    return "";
  }

  public boolean supportsUnique() {
    return false;
  }

  public boolean supportsLimit() {
    return true;
  }

  public String getLimitString(String sql, boolean hasOffset) {
    return new StringBuffersql.length() 10 )
        .appendsql )
        .insertsql.toLowerCase().indexOf"select" 6, hasOffset ? " limit ? ?" " top ?" )
        .toString();
  }

  public boolean bindLimitParametersFirst() {
    return true;
  }

  public boolean supportsIfExistsAfterTableName() {
    return true;
  }

  public boolean supportsColumnCheck() {
    return false;
  }

  public boolean supportsSequences() {
    return true;
  }

  public boolean supportsPooledSequences() {
    return true;
  }

  protected String getCreateSequenceString(String sequenceName) {
    return "create sequence " + sequenceName;
  }

  protected String getDropSequenceString(String sequenceName) {
    return "drop sequence " + sequenceName;
  }

  public String getSelectSequenceNextValString(String sequenceName) {
    return "next value for " + sequenceName;
  }

  public String getSequenceNextValString(String sequenceName) {
    return "call next value for " + sequenceName;
  }

  public String getQuerySequencesString() {
    // this assumes schema support, which is present in 1.8.0 and later...
    return "select sequence_name from information_schema.system_sequences";
  }

  public ViolatedConstraintNameExtracter getViolatedConstraintNameExtracter() {
    return EXTRACTER;
  }

  private static ViolatedConstraintNameExtracter EXTRACTER = new TemplatedViolatedConstraintNameExtracter() {

    /**
     * Extract the name of the violated constraint from the given SQLException.
     *
     @param sqle The exception that was the result of the constraint violation.
     @return The extracted constraint name.
     */
    public String extractConstraintName(SQLException sqle) {
      String constraintName = null;

      int errorCode = JDBCExceptionHelper.extractErrorCodesqle );

      if errorCode == -) {
        constraintName = extractUsingTemplate(
            "Integrity constraint violation "" table:", sqle.getMessage()
        );
      }
      else if errorCode == -) {
        constraintName = extractUsingTemplate(
            "Violation of unique index: "" in statement [", sqle.getMessage()
        );
      }
      else if errorCode == -104 ) {
        constraintName = extractUsingTemplate(
            "Unique constraint violation: "" in statement [", sqle.getMessage()
        );
      }
      else if errorCode == -177 ) {
        constraintName = extractUsingTemplate(
            "Integrity constraint violation - no parent "" table:", sqle.getMessage()
        );
      }

      return constraintName;
    }

  };

  /**
   * HSQL does not really support temp tables; just take advantage of the
   * fact that it is a single user db...
   */
  public boolean supportsTemporaryTables() {
    return true;
  }

  public boolean supportsCurrentTimestampSelection() {
    return false;
  }

  public LockingStrategy getLockingStrategy(Lockable lockable, LockMode lockMode) {
    // HSQLDB only supports READ_UNCOMMITTED transaction isolation
    return new ReadUncommittedLockingStrategylockable, lockMode );
  }

  public static class ReadUncommittedLockingStrategy extends SelectLockingStrategy {
    public ReadUncommittedLockingStrategy(Lockable lockable, LockMode lockMode) {
      superlockable, lockMode );
    }

    public void lock(Serializable id, Object version, Object object, SessionImplementor session)
        throws StaleObjectStateException, JDBCException {
      if getLockMode().greaterThanLockMode.READ ) ) {
        log.warn"HSQLDB supports only READ_UNCOMMITTED isolation" );
      }
      super.lockid, version, object, session );
    }
  }


  // Overridden informational metadata ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  public boolean supportsEmptyInList() {
    return false;
  }

  public boolean supportsLobValueChangePropogation() {
    return false;
  }
}