#867 - ENH: Add ability to globally use quoted identifiers on all tables and columns

src/main/java/io/ebean/config/MatchingNamingConvention.java

@@ -31,7 +31,7 @@ public class MatchingNamingConvention extends AbstractNamingConvention {
 
   @Override
   public String getColumnFromProperty(Class<?> beanClass, String propertyName) {
-    return propertyName;
+    return quoteIdentifiers(propertyName);
   }
 
   @Override
@@ -47,8 +47,11 @@ public class MatchingNamingConvention extends AbstractNamingConvention {
 
   @Override
   public String getForeignKey(String prefix, String fkProperty) {
+    prefix = databasePlatform.unQuote(prefix);
+    fkProperty = databasePlatform.unQuote(fkProperty);
     // add fkProperty as init caps
-    return prefix + fkProperty.substring(0, 1).toUpperCase() + fkProperty.substring(1);
+    String fullName = prefix + fkProperty.substring(0, 1).toUpperCase() + fkProperty.substring(1);
+    return quoteIdentifiers(fullName);
   }
 
 }

src/main/java/io/ebean/config/ServerConfig.java

@@ -313,6 +313,8 @@ public class ServerConfig {
    */
   private String databaseBooleanFalse;
 
+  private boolean allQuotedIdentifiers;
+
   /**
    * The naming convention.
    */
@@ -1274,6 +1276,24 @@ public class ServerConfig {
     this.namingConvention = namingConvention;
   }
 
+  /**
+   * Return true if all DB column and table names should use quoted identifiers.
+   */
+  public boolean isAllQuotedIdentifiers() {
+    return allQuotedIdentifiers;
+  }
+
+  /**
+   * Set to true if all DB column and table names should use quoted identifiers.
+   */
+  public void setAllQuotedIdentifiers(boolean allQuotedIdentifiers) {
+    this.allQuotedIdentifiers = allQuotedIdentifiers;
+    if (allQuotedIdentifiers && namingConvention instanceof UnderscoreNamingConvention) {
+      // we need to use matching naming convention
+      this.namingConvention = new MatchingNamingConvention();
+    }
+  }
+
   /**
    * Return true if this EbeanServer is a Document store only instance (has no JDBC DB).
    */
@@ -2472,6 +2492,11 @@ public class ServerConfig {
 
     migrationConfig.loadSettings(p, name);
 
+    boolean quotedIdentifiers = p.getBoolean("allQuotedIdentifiers", allQuotedIdentifiers);
+    if (quotedIdentifiers != allQuotedIdentifiers) {
+      // potentially also set to use matching naming convention
+      setAllQuotedIdentifiers(quotedIdentifiers);
+    }
     namingConvention = createNamingConvention(p, namingConvention);
     if (namingConvention != null) {
       namingConvention.loadFromProperties(p);

src/main/java/io/ebean/config/dbplatform/DatabasePlatform.java

@@ -64,6 +64,11 @@ public class DatabasePlatform {
    */
   protected String closeQuote = "\"";
 
+  /**
+   * When set to true all db column names and table names use quoted identifiers.
+   */
+  protected boolean allQuotedIdentifiers;
+
   /**
    * For limit/offset, row_number etc limiting of SQL queries.
    */
@@ -174,7 +179,7 @@ public class DatabasePlatform {
   protected boolean supportsNativeIlike;
 
   protected SqlExceptionTranslator exceptionTranslator = new SqlCodeTranslator();
-  
+
   protected char[] specialLikeCharacters = { '%', '_' };
 
   /**
@@ -193,7 +198,8 @@ public class DatabasePlatform {
   /**
    * Configure UUID Storage etc based on ServerConfig settings.
    */
-  public void configure(DbTypeConfig config) {
+  public void configure(DbTypeConfig config, boolean allQuotedIdentifiers) {
+    this.allQuotedIdentifiers = allQuotedIdentifiers;
     addGeoTypes(config.getGeometrySRID());
     configureIdType(config.getIdType());
     dbTypeMap.config(nativeUuidType, config.getDbUuid());
@@ -535,24 +541,33 @@ public class DatabasePlatform {
    * naming rules.
    * </p>
    *
-   * @param dbName the db name
-   * @return the string
+   * @param dbName the db table or column name
+   * @return the db table or column name with potentially platform specific quoted identifiers
    */
   public String convertQuotedIdentifiers(String dbName) {
     // Ignore null values e.g. schema name or catalog
     if (dbName != null && !dbName.isEmpty()) {
       if (dbName.charAt(0) == BACK_TICK) {
         if (dbName.charAt(dbName.length() - 1) == BACK_TICK) {
-
-          String quotedName = getOpenQuote();
-          quotedName += dbName.substring(1, dbName.length() - 1);
-          quotedName += getCloseQuote();
-
-          return quotedName;
-
+          return openQuote + dbName.substring(1, dbName.length() - 1) + closeQuote;
         } else {
           logger.error("Missing backquote on [" + dbName + "]");
         }
+      } else if (allQuotedIdentifiers) {
+        return openQuote + dbName + closeQuote;
+      }
+    }
+    return dbName;
+  }
+
+  /**
+   * Remove quoted identifier quotes from the table or column name if present.
+   */
+  public String unQuote(String dbName) {
+    if (dbName != null && !dbName.isEmpty()) {
+      if (dbName.startsWith(openQuote)) {
+        // trim off the open and close quotes
+        return dbName.substring(1, dbName.length()-1);
       }
     }
     return dbName;
@@ -648,7 +663,7 @@ public class DatabasePlatform {
       return sb.toString();
     }
   }
-  
+
   protected void escapeLikeCharacter(char ch, StringBuilder sb) {
     sb.append('\\').append(ch);
   }

src/main/java/io/ebeaninternal/server/core/DefaultContainer.java

@@ -244,17 +244,17 @@ public class DefaultContainer implements SpiContainer {
    */
   private void setDatabasePlatform(ServerConfig config) {
 
-    DatabasePlatform dbPlatform = config.getDatabasePlatform();
-    if (dbPlatform == null) {
+    DatabasePlatform platform = config.getDatabasePlatform();
+    if (platform == null) {
       if (config.getTenantMode().isDynamicDataSource()) {
         throw new IllegalStateException("DatabasePlatform must be explicitly set on ServerConfig for TenantMode "+config.getTenantMode());
       }
-      DatabasePlatformFactory factory = new DatabasePlatformFactory();
-      DatabasePlatform db = factory.create(config);
-      db.configure(config.getDbTypeConfig());
-      config.setDatabasePlatform(db);
-      logger.info("DatabasePlatform name:{} platform:{}", config.getName(), db.getName());
+      // automatically determine the platform
+      platform = new DatabasePlatformFactory().create(config);
+      config.setDatabasePlatform(platform);
     }
+    logger.info("DatabasePlatform name:{} platform:{}", config.getName(), platform.getName());
+    platform.configure(config.getDbTypeConfig(), config.isAllQuotedIdentifiers());
   }
 
   /**