#60:Used error msg builder for error messages (#78)

* #60:Used error msg builder for error messages

Author: Priyank Agarwal

doc/changes/changes_3.2.0.md

@@ -4,8 +4,15 @@ Code name: Truncating tables
 
 ## Summary
 
-In this release we added support for truncating tables.
+In this release following changes are made:
+* Added support for truncating tables. 
+* Used Error Message Builder for Error Messages.
 
 ## Features
 
-* #67: Add Table#truncate()
+* #67: Add Table#truncate()
+* #60: Used Error Message Builder for Error Messages
+
+## Dependency Updates
+
+* Updated `com.exasol:error-reporting-java:0.2.2` to `0.4.0`

pom.xml

@@ -152,7 +152,7 @@
         <dependency>
             <groupId>com.exasol</groupId>
             <artifactId>error-reporting-java</artifactId>
-            <version>0.2.2</version>
+            <version>0.4.0</version>
         </dependency>
     </dependencies>
     <build>

src/main/java/com/exasol/dbbuilder/dialects/AbstractImmediateDatabaseObjectWriter.java

@@ -31,7 +31,7 @@ protected void writeToObject(final DatabaseObject object, final String sql, fina
             }
             preparedStatement.execute();
         } catch (final SQLException exception) {
-            throw new DatabaseObjectException(object, "Failed to write to object: " + sql, exception);
+            throw new DatabaseObjectException(object, ExaError.messageBuilder("E-TDBJ-13").message("Failed to write to object: {{sql}}", sql).toString(), exception);
         }
     }
 
@@ -86,8 +86,7 @@ public void write(final Table table, final Stream<List<Object>> rows) {
         } catch (final SQLException exception) {
             throw new DatabaseObjectException(table,
                     ExaError.messageBuilder("E-TDBJ-2")
-                            .message("Failed to create prepared statement {{statement}} for insert.")
-                            .parameter("statement", sql).toString(),
+                            .message("Failed to create prepared statement {{statement}} for insert.", sql).toString(),
                     exception);
         }
     }
@@ -101,7 +100,7 @@ private void writeRow(final Table table, final String sql, final PreparedStateme
             preparedStatement.execute();
         } catch (final SQLException exception) {
             throw new DatabaseObjectException(table, ExaError.messageBuilder("E-TDBJ-1")
-                    .message("Failed to execute insert query: {{statement}}").parameter("statement", sql).toString(),
+                    .message("Failed to execute insert query: {{statement}}", sql).toString(),
                     exception);
         }
     }
@@ -146,7 +145,7 @@ public void executeSqlFile(final Path... sqlFiles) {
                 final String sql = Files.readString(sqlFile);
                 statement.execute(sql);
             } catch (final IOException | SQLException exception) {
-                throw new DatabaseObjectException("Unable to execute SQL from file: " + sqlFile, exception);
+                throw new DatabaseObjectException(ExaError.messageBuilder("E-TDBJ-14").message("Unable to execute SQL from file: {{sqlFile}}", sqlFile).toString(), exception);
             }
         }
     }

src/main/java/com/exasol/dbbuilder/dialects/AbstractSchema.java

@@ -4,6 +4,7 @@
 import java.util.List;
 
 import com.exasol.db.Identifier;
+import com.exasol.errorreporting.ExaError;
 
 /**
  * This class contains common logic for a database schema.
@@ -68,8 +69,9 @@ public Table createTable(final String name, final List<String> columnNames, fina
             this.tables.add(table);
             return table;
         } else {
-            throw new IllegalArgumentException("Got " + columnNames.size() + " column names but " + columnTypes
-                    + " column types. Please provide the same number of parameters for both when creating a table.");
+            throw new IllegalArgumentException(ExaError.messageBuilder("E-TDBJ-18").message(
+                "Got {{column names size}} column names but {{column types}} column types. Please provide the same number of parameters for both when creating a table.", columnNames.size(), columnTypes.size())
+                .toString());
         }
     }
 

src/main/java/com/exasol/dbbuilder/dialects/AbstractSchemaChild.java

@@ -1,6 +1,7 @@
 package com.exasol.dbbuilder.dialects;
 
 import com.exasol.db.Identifier;
+import com.exasol.errorreporting.ExaError;
 
 /**
  * Base class for all database objects in the scope of a database schema.
@@ -71,8 +72,7 @@ protected void validate() {
          */
         protected void requireNotNull(final Object object, final String name) {
             if (object == null) {
-                throw new IllegalStateException(name + " is a required field. Please provide a value by calling " + name
-                        + "() before build().");
+                throw new IllegalStateException(ExaError.messageBuilder("E-TDBJ-15").message("{{name}} is a required field. Please provide a value by calling {{name|uq}}() before build().", name).toString());
             }
         }
     }

src/main/java/com/exasol/dbbuilder/dialects/Schema.java

@@ -2,6 +2,8 @@
 
 import java.util.List;
 
+import com.exasol.errorreporting.ExaError;
+
 /**
  * Database schema.
  */
@@ -87,7 +89,6 @@ default boolean hasParent() {
 
     @Override
     default DatabaseObject getParent() {
-        throw new DatabaseObjectException(this,
-                "Illegal attempt to access parent object of a SCHEMA which is a top-level object.");
+        throw new DatabaseObjectException(this,ExaError.messageBuilder("E-TDBJ-16").message("Illegal attempt to access parent object of a SCHEMA which is a top-level object.").toString());
     }
 }

src/main/java/com/exasol/dbbuilder/dialects/Table.java

@@ -92,11 +92,8 @@ public Table bulkInsert(final Stream<List<Object>> rows) {
         this.writer.write(this, rows.peek(row -> {
             if (row.size() != getColumnCount()) {
                 throw new IllegalArgumentException(ExaError.messageBuilder("E-TDBJ-3").message(
-                        "Column count mismatch. Tried to insert row with {{actual}} values into table {{table name}} which has {{expected}} columns. If this is a bulk insert, multiple other rows might have already been written. Consider a rollback on the connection, to discard the changes.")
-                        .parameter("actual", row.size())//
-                        .parameter("table name", getFullyQualifiedName())//
-                        .parameter("expected", getColumnCount())//
-                        .toString());
+                    "Column count mismatch. Tried to insert row with {{actual}} values into table {{table name}} which has {{expected}} columns. If this is a bulk insert, multiple other rows might have already been written. Consider a rollback on the connection, to discard the changes.", row.size(), getFullyQualifiedName(), getColumnCount())
+                    .toString());
             }
         }));
         return this;

src/main/java/com/exasol/dbbuilder/dialects/User.java

@@ -3,6 +3,8 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.exasol.errorreporting.ExaError;
+
 /**
  * Database user.
  */
@@ -66,7 +68,6 @@ default boolean hasParent() {
 
     @Override
     default DatabaseObject getParent() {
-        throw new DatabaseObjectException(this,
-                "Illegal attempt to access parent object of a USER which is a top-level object.");
+        throw new DatabaseObjectException(this,ExaError.messageBuilder("E-TDBJ-17").message("Illegal attempt to access parent object of a USER which is a top-level object.").toString());
     }
 }

src/main/java/com/exasol/dbbuilder/dialects/exasol/ConnectionDefinition.java

@@ -4,6 +4,7 @@
 import com.exasol.dbbuilder.dialects.AbstractDatabaseObject;
 import com.exasol.dbbuilder.dialects.DatabaseObject;
 import com.exasol.dbbuilder.dialects.DatabaseObjectException;
+import com.exasol.errorreporting.ExaError;
 
 /**
  * Definition of a connection to another database or service.
@@ -92,8 +93,7 @@ public boolean hasParent() {
 
     @Override
     public DatabaseObject getParent() {
-        throw new DatabaseObjectException(this,
-                "Illegal attempt to access parent object of a CONNECTION which is a top-level object.");
+        throw new DatabaseObjectException(this, ExaError.messageBuilder("E-TDBJ-8").message("Illegal attempt to access parent object of a CONNECTION which is a top-level object.").toString());
     }
 
     @Override

src/main/java/com/exasol/dbbuilder/dialects/exasol/ExasolImmediateDatabaseObjectWriter.java

@@ -78,9 +78,7 @@ public void write(final ConnectionDefinition definition) {
         } else {
             if (definition.hasPassword()) {
                 throw new DatabaseObjectException(definition,
-                        "User name missing when trying to write connection definition "
-                                + definition.getFullyQualifiedName()
-                                + ". Please always provide user name and password together or not at all.");
+                    ExaError.messageBuilder("E-TDBJ-5").message("User name missing when trying to write connection definition {{definition name}}. Please always provide user name and password together or not at all.", definition.getFullyQualifiedName()).toString());
             } else {
                 writeToObject(definition, "CREATE CONNECTION " + definition.getFullyQualifiedName() + " TO '"
                         + definition.getTarget() + "'");
@@ -271,7 +269,7 @@ public int execute(final Script script, final Object... parameterValues) {
             return statement.getUpdateCount();
         } catch (final SQLException exception) {
             throw new DatabaseObjectException(script, ExaError.messageBuilder("E-TDBJ-4")
-                    .message("Failed to execute script query {{query}}.").parameter("query", query).toString(),
+                    .message("Failed to execute script query {{query}}.", query).toString(),
                     exception);
         }
     }
@@ -331,7 +329,7 @@ public List<List<Object>> executeQuery(final Script script, final Object... para
             return table;
         } catch (final SQLException exception) {
             throw new DatabaseObjectException(script,
-                    "Failed to execute script returning table" + script.getFullyQualifiedName(), exception);
+                ExaError.messageBuilder("E-TDBJ-6").message("Failed to execute script returning table {{script name}}", script.getFullyQualifiedName()).toString(), exception);
         }
     }
 }