001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.core.persistence.dialect;
021    
022    /**
023     * @since 1.12
024     */
025    public interface Dialect {
026    
027      /**
028       * @return the sonar dialect Id to be matched with the sonar.jdbc.dialect property when provided
029       */
030      String getId();
031    
032      /**
033       * @return the hibernate dialect class to be used
034       */
035      Class<? extends org.hibernate.dialect.Dialect> getHibernateDialectClass();
036    
037      /**
038       * @return the activerecord dialect to be used
039       */
040      String getActiveRecordDialectCode();
041    
042      /**
043       * @return the activerecord-jdbc adapter. See the property 'adapter' in database.yml
044       */
045      String getActiveRecordJdbcAdapter();
046    
047      /**
048       * Used to autodetect a dialect for a given driver URL
049       *
050       * @param jdbcConnectionURL a jdbc driver url such as jdbc:mysql://localhost:3306/sonar
051       * @return true if the dialect supports surch url
052       */
053      boolean matchesJdbcURL(String jdbcConnectionURL);
054    
055      /**
056       * @since 2.13
057       */
058      String getDefaultDriverClassName();
059    
060      String getConnectionInitStatement(String schema);
061    
062      /**
063       * @since 2.14
064       */
065      String getTrueSqlValue();
066    
067      /**
068       * @since 2.14
069       */
070      String getFalseSqlValue();
071    }