#55: Unified the interfaces for creation of DB Objects (#79)

Priyank Agarwal · web-flow · commit ac84d42d20eb · 2021-04-16T13:53:35.000+02:00
diff --git a/doc/changes/changes_3.2.0.md b/doc/changes/changes_3.2.0.md
@@ -7,11 +7,13 @@ Code name: Truncating tables
 In this release following changes are made:
 * Added support for truncating tables. 
 * Used Error Message Builder for Error Messages.
+* Unified the interfaces for creation of dB Objects
 
 ## Features
 
 * #67: Add Table#truncate()
 * #60: Used Error Message Builder for Error Messages
+* #55: Unified the interfaces for creation of dB Objects
 
 ## Dependency Updates
 
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/exasol/ConnectionDefinition.java b/src/main/java/com/exasol/dbbuilder/dialects/exasol/ConnectionDefinition.java
@@ -1,6 +1,6 @@
 package com.exasol.dbbuilder.dialects.exasol;
 
-import com.exasol.db.ExasolIdentifier;
+import com.exasol.db.Identifier;
 import com.exasol.dbbuilder.dialects.AbstractDatabaseObject;
 import com.exasol.dbbuilder.dialects.DatabaseObject;
 import com.exasol.dbbuilder.dialects.DatabaseObjectException;
@@ -27,9 +27,9 @@ public class ConnectionDefinition extends AbstractDatabaseObject {
      * @param target target the connection points to
      */
     // [impl~creating-connections~1]
-    public ConnectionDefinition(final ExasolImmediateDatabaseObjectWriter writer, final String name,
+    public ConnectionDefinition(final ExasolImmediateDatabaseObjectWriter writer, final Identifier name,
             final String target) {
-        super(ExasolIdentifier.of(name), false);
+        super(name, false);
         this.writer = writer;
         this.target = target;
         this.writer.write(this);
@@ -44,9 +44,9 @@ public ConnectionDefinition(final ExasolImmediateDatabaseObjectWriter writer, fi
      * @param userName user as which to connect
      * @param password password or password-like credential
      */
-    public ConnectionDefinition(final ExasolImmediateDatabaseObjectWriter writer, final String name,
+    public ConnectionDefinition(final ExasolImmediateDatabaseObjectWriter writer, final Identifier name,
             final String target, final String userName, final String password) {
-        super(ExasolIdentifier.of(name), false);
+        super(name, false);
         this.target = target;
         this.writer = writer;
         this.userName = userName;
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/exasol/ExasolObjectFactory.java b/src/main/java/com/exasol/dbbuilder/dialects/exasol/ExasolObjectFactory.java
@@ -2,6 +2,7 @@
 
 import java.sql.Connection;
 
+import com.exasol.db.ExasolIdentifier;
 import com.exasol.dbbuilder.dialects.AbstractObjectFactory;
 import com.exasol.dbbuilder.dialects.DatabaseObjectWriter;
 import com.exasol.dbbuilder.dialects.User;
@@ -41,7 +42,7 @@ public ExasolObjectFactory(final Connection connection, final ExasolObjectConfig
      */
     // [impl->dsn~creating-connections~1]
     public ConnectionDefinition createConnectionDefinition(final String name, final String to) {
-        return new ConnectionDefinition(this.writer, name, to);
+        return new ConnectionDefinition(this.writer, ExasolIdentifier.of(name), to);
     }
 
     /**
@@ -55,22 +56,22 @@ public ConnectionDefinition createConnectionDefinition(final String name, final
      */
     public ConnectionDefinition createConnectionDefinition(final String name, final String to, final String userName,
             final String password) {
-        return new ConnectionDefinition(this.writer, name, to, userName, password);
+        return new ConnectionDefinition(this.writer, ExasolIdentifier.of(name), to, userName, password);
     }
 
     @Override
     public ExasolSchema createSchema(final String name) {
-        return new ExasolSchema(this.writer, name);
+        return new ExasolSchema(this.writer, ExasolIdentifier.of(name));
     }
 
     @Override
     public User createUser(final String name) {
-        return new ExasolUser(this.writer, name);
+        return new ExasolUser(this.writer, ExasolIdentifier.of(name));
     }
 
     @Override
     public User createUser(final String name, final String password) {
-        return new ExasolUser(this.writer, name, password);
+        return new ExasolUser(this.writer, ExasolIdentifier.of(name), password);
     }
 
     @Override
@@ -90,7 +91,7 @@ public User createLoginUser(final String name, final String password) {
      * @return builder
      */
     public VirtualSchema.Builder createVirtualSchemaBuilder(final String name) {
-        return VirtualSchema.builder(this.writer, name);
+        return VirtualSchema.builder(this.writer, ExasolIdentifier.of(name));
     }
 
     @Override
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/exasol/ExasolSchema.java b/src/main/java/com/exasol/dbbuilder/dialects/exasol/ExasolSchema.java
@@ -23,8 +23,8 @@ public class ExasolSchema extends AbstractSchema {
      * @param writer database object writer
      * @param name   name of the database schema
      */
-    public ExasolSchema(final ExasolImmediateDatabaseObjectWriter writer, final String name) {
-        super(ExasolIdentifier.of(name));
+    public ExasolSchema(final ExasolImmediateDatabaseObjectWriter writer, final Identifier name) {
+        super(name);
         this.writer = writer;
         writer.write(this);
     }
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/exasol/ExasolUser.java b/src/main/java/com/exasol/dbbuilder/dialects/exasol/ExasolUser.java
@@ -1,6 +1,6 @@
 package com.exasol.dbbuilder.dialects.exasol;
 
-import com.exasol.db.ExasolIdentifier;
+import com.exasol.db.Identifier;
 import com.exasol.dbbuilder.dialects.AbstractUser;
 import com.exasol.dbbuilder.dialects.DatabaseObject;
 import com.exasol.dbbuilder.dialects.DatabaseObjectWriter;
@@ -19,8 +19,8 @@ public class ExasolUser extends AbstractUser {
      * @param writer database object writer
      * @param name   user name
      */
-    public ExasolUser(final ExasolImmediateDatabaseObjectWriter writer, final String name) {
-        super(ExasolIdentifier.of(name));
+    public ExasolUser(final ExasolImmediateDatabaseObjectWriter writer, final Identifier name) {
+        super(name);
         this.writer = writer;
         this.writer.write(this);
     }
@@ -32,8 +32,8 @@ public ExasolUser(final ExasolImmediateDatabaseObjectWriter writer, final String
      * @param name     user name
      * @param password login password
      */
-    public ExasolUser(final ExasolImmediateDatabaseObjectWriter writer, final String name, final String password) {
-        super(ExasolIdentifier.of(name), password);
+    public ExasolUser(final ExasolImmediateDatabaseObjectWriter writer, final Identifier name, final String password) {
+        super(name, password);
         this.writer = writer;
         writer.write(this);
     }
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/exasol/VirtualSchema.java b/src/main/java/com/exasol/dbbuilder/dialects/exasol/VirtualSchema.java
@@ -3,7 +3,6 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import com.exasol.db.ExasolIdentifier;
 import com.exasol.db.Identifier;
 import com.exasol.dbbuilder.dialects.AbstractDatabaseObject;
 import com.exasol.dbbuilder.dialects.DatabaseObject;
@@ -40,8 +39,8 @@ private VirtualSchema(final Builder builder) {
      * @param name   name of the Virtual Schema to be built
      * @return builder instance
      */
-    public static Builder builder(final ExasolImmediateDatabaseObjectWriter writer, final String name) {
-        return new Builder(writer, ExasolIdentifier.of(name));
+    public static Builder builder(final ExasolImmediateDatabaseObjectWriter writer, final Identifier name) {
+        return new Builder(writer, name);
     }
 
     private void addReservedProperties(final Builder builder) {
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/mysql/MySqlObjectFactory.java b/src/main/java/com/exasol/dbbuilder/dialects/mysql/MySqlObjectFactory.java
@@ -24,12 +24,12 @@ public MySqlObjectFactory(final Connection connection) {
 
     @Override
     public User createUser(final String name) {
-        return new MySqlUser(this.writer, name);
+        return new MySqlUser(this.writer, MySQLIdentifier.of(name));
     }
 
     @Override
     public User createUser(final String name, final String password) {
-        return new MySqlUser(this.writer, name, password);
+        return new MySqlUser(this.writer, MySQLIdentifier.of(name), password);
     }
 
     @Override
@@ -44,7 +44,7 @@ public User createLoginUser(final String name, final String password) {
 
     @Override
     public MySqlSchema createSchema(final String name) {
-        return new MySqlSchema(this.writer, name);
+        return new MySqlSchema(this.writer, MySQLIdentifier.of(name));
     }
 
     @Override
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/mysql/MySqlSchema.java b/src/main/java/com/exasol/dbbuilder/dialects/mysql/MySqlSchema.java
@@ -16,8 +16,8 @@ public class MySqlSchema extends AbstractSchema {
      * @param writer database object writer
      * @param name   name of the database schema
      */
-    public MySqlSchema(final MySqlImmediateDatabaseObjectWriter writer, final String name) {
-        super(MySQLIdentifier.of(name));
+    public MySqlSchema(final MySqlImmediateDatabaseObjectWriter writer, final Identifier name) {
+        super(name);
         this.writer = writer;
         this.writer.write(this);
     }
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/mysql/MySqlUser.java b/src/main/java/com/exasol/dbbuilder/dialects/mysql/MySqlUser.java
@@ -1,5 +1,6 @@
 package com.exasol.dbbuilder.dialects.mysql;
 
+import com.exasol.db.Identifier;
 import com.exasol.dbbuilder.dialects.AbstractUser;
 import com.exasol.dbbuilder.dialects.DatabaseObject;
 import com.exasol.dbbuilder.dialects.DatabaseObjectWriter;
@@ -18,8 +19,8 @@ public class MySqlUser extends AbstractUser {
      * @param writer database object writer
      * @param name   user name
      */
-    public MySqlUser(final MySqlImmediateDatabaseObjectWriter writer, final String name) {
-        super(MySQLIdentifier.of(name));
+    public MySqlUser(final MySqlImmediateDatabaseObjectWriter writer, final Identifier name) {
+        super(name);
         this.writer = writer;
         this.writer.write(this);
     }
@@ -31,8 +32,8 @@ public MySqlUser(final MySqlImmediateDatabaseObjectWriter writer, final String n
      * @param name     user name
      * @param password login password
      */
-    public MySqlUser(final MySqlImmediateDatabaseObjectWriter writer, final String name, final String password) {
-        super(MySQLIdentifier.of(name), password);
+    public MySqlUser(final MySqlImmediateDatabaseObjectWriter writer, final Identifier name, final String password) {
+        super(name, password);
         this.writer = writer;
         this.writer.write(this);
     }
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/postgres/PostgreSqlObjectFactory.java b/src/main/java/com/exasol/dbbuilder/dialects/postgres/PostgreSqlObjectFactory.java
@@ -46,6 +46,6 @@ public User createLoginUser(final String name, final String password) {
 
     @Override
     public Schema createSchema(final String name) {
-        return new PostgreSqlSchema(this.writer, name);
+        return new PostgreSqlSchema(this.writer, PostgreSqlIdentifier.of(name));
     }
 }
diff --git a/src/main/java/com/exasol/dbbuilder/dialects/postgres/PostgreSqlSchema.java b/src/main/java/com/exasol/dbbuilder/dialects/postgres/PostgreSqlSchema.java
@@ -15,8 +15,8 @@ public class PostgreSqlSchema extends AbstractSchema {
      * @param writer object writer
      * @param name   name of the schema
      */
-    public PostgreSqlSchema(final PostgreSqlImmediateDatabaseObjectWriter writer, final String name) {
-        super(PostgreSqlIdentifier.of(name));
+    public PostgreSqlSchema(final PostgreSqlImmediateDatabaseObjectWriter writer, final Identifier name) {
+        super(name);
         this.writer = writer;
         this.writer.write(this);
     }
diff --git a/src/test/java/com/exasol/dbbuilder/dialects/exasol/ConnectionDefinitionTest.java b/src/test/java/com/exasol/dbbuilder/dialects/exasol/ConnectionDefinitionTest.java
@@ -5,6 +5,8 @@
 import static org.junit.jupiter.api.Assertions.assertAll;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
+import com.exasol.db.ExasolIdentifier;
+import com.exasol.db.Identifier;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
@@ -16,14 +18,15 @@
 // [utest->dsn~creating-connections~1]
 class ConnectionDefinitionTest {
     private static final String CONNECTION_TARGET = "THE_TARGET";
-    private static final String CONNECTION_NAME = "THE_CONNECTION_NAME";
+    private static final Identifier CONNECTION_NAME = ExasolIdentifier.of("THE_CONNECTION_NAME");
+
     @Mock
     private ExasolImmediateDatabaseObjectWriter writerMock;
 
     @Test
     void testGetName() {
         assertThat(new ConnectionDefinition(this.writerMock, CONNECTION_NAME, CONNECTION_TARGET).getName(),
-                equalTo(CONNECTION_NAME));
+                equalTo(CONNECTION_NAME.toString()));
     }
 
     @Test
diff --git a/src/test/java/com/exasol/dbbuilder/dialects/exasol/ExasolImmediateDatabaseObjectWriterTest.java b/src/test/java/com/exasol/dbbuilder/dialects/exasol/ExasolImmediateDatabaseObjectWriterTest.java
@@ -7,6 +7,7 @@
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.when;
 
+import com.exasol.db.ExasolIdentifier;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
@@ -41,7 +42,7 @@ void testWriteConnectionDefinitionThrowsExceptionWhenPasswordIsGivenWithoutUser(
     void testWriteAdapterScript() {
         final ExasolImmediateDatabaseObjectWriterStub objectWriter = spy(new ExasolImmediateDatabaseObjectWriterStub(
                 this.connectionMock, ExasolObjectConfiguration.builder().build()));
-        final ExasolSchema schema = new ExasolSchema(objectWriter, "TEST_SCHEMA");
+        final ExasolSchema schema = new ExasolSchema(objectWriter, ExasolIdentifier.of("TEST_SCHEMA"));
         final AdapterScript adapterScript = schema.createAdapterScriptBuilder("MY_ADAPTER").content("content")
                 .language(AdapterScript.Language.JAVA).build();
         objectWriter.write(adapterScript);
@@ -54,7 +55,7 @@ void testWriteAdapterScript() {
     void testWriteAdapterScriptWithJvmOption() {
         final ExasolImmediateDatabaseObjectWriterStub objectWriter = new ExasolImmediateDatabaseObjectWriterStub(
                 this.connectionMock, ExasolObjectConfiguration.builder().withJvmOptions("-DmyProp=1").build());
-        final ExasolSchema schema = new ExasolSchema(objectWriter, "TEST_SCHEMA");
+        final ExasolSchema schema = new ExasolSchema(objectWriter, ExasolIdentifier.of("TEST_SCHEMA"));
         final AdapterScript adapterScript = schema.createAdapterScriptBuilder("MY_ADAPTER").content("content")
                 .language(AdapterScript.Language.JAVA).build();
         objectWriter.write(adapterScript);
diff --git a/src/test/java/com/exasol/dbbuilder/dialects/exasol/ExasolSchemaTest.java b/src/test/java/com/exasol/dbbuilder/dialects/exasol/ExasolSchemaTest.java
@@ -3,6 +3,7 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
 
+import com.exasol.db.ExasolIdentifier;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
@@ -19,7 +20,7 @@ class ExasolSchemaTest extends AbstractSchemaTest {
 
     @Override
     protected Schema createSchema(final String name) {
-        return new ExasolSchema(this.writerMock, name);
+        return new ExasolSchema(this.writerMock, ExasolIdentifier.of(name));
     }
 
     @Test
@@ -30,14 +31,14 @@ void testGetFullyQualifiedName() {
 
     @Test
     void testCreateTableBuilder() {
-        final ExasolSchema exasolSchema = new ExasolSchema(this.writerMock, "THE_SCHEMA");
+        final ExasolSchema exasolSchema = new ExasolSchema(this.writerMock, ExasolIdentifier.of("THE_SCHEMA"));
         final Table table = exasolSchema.createTableBuilder("TABLE_D").column("A", "DATE").build();
         assertThat(table.getName(), equalTo("TABLE_D"));
     }
 
     @Test
     void testCreateAdapterScriptBuilder() {
-        final ExasolSchema exasolSchema = new ExasolSchema(this.writerMock, "THE_SCHEMA");
+        final ExasolSchema exasolSchema = new ExasolSchema(this.writerMock, ExasolIdentifier.of("THE_SCHEMA"));
         final AdapterScript adapterScript = exasolSchema.createAdapterScriptBuilder("TEST_SCRIPT")
                 .language(AdapterScript.Language.JAVA).content("test").build();
         assertThat(adapterScript.getParent(), equalTo(exasolSchema));
diff --git a/src/test/java/com/exasol/dbbuilder/dialects/exasol/ExasolUserTest.java b/src/test/java/com/exasol/dbbuilder/dialects/exasol/ExasolUserTest.java
@@ -5,6 +5,7 @@
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.collection.IsMapContaining.hasEntry;
 
+import com.exasol.db.ExasolIdentifier;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
@@ -23,39 +24,39 @@ class ExasolUserTest extends AbstractUserTest {
 
     @Override
     protected User createUser(final String name) {
-        return new ExasolUser(this.writerMock, name);
+        return new ExasolUser(this.writerMock, ExasolIdentifier.of(name));
     }
 
     @Override
     protected User createUser(final String name, final String password) {
-        return new ExasolUser(this.writerMock, name, password);
+        return new ExasolUser(this.writerMock, ExasolIdentifier.of(name), password);
     }
 
     @Test
     void testGetFullyQualifiedName() {
-        assertThat(new ExasolUser(this.writerMock, "JOHNDOE").getFullyQualifiedName(), equalTo("\"JOHNDOE\""));
+        assertThat(new ExasolUser(this.writerMock, ExasolIdentifier.of("JOHNDOE")).getFullyQualifiedName(), equalTo("\"JOHNDOE\""));
     }
 
     @Test
     void testGetObjectPrivileges(@Mock final DatabaseObject objectMock) {
         final ObjectPrivilege[] expectedObjectPrivileges = { ExasolObjectPrivilege.INSERT,
                 ExasolObjectPrivilege.DELETE };
-        final User user = new ExasolUser(this.writerMock, "OBJUSER") //
+        final User user = new ExasolUser(this.writerMock, ExasolIdentifier.of("OBJUSER")) //
                 .grant(objectMock, expectedObjectPrivileges);
         assertThat(user.getObjectPrivileges(), hasEntry(objectMock, expectedObjectPrivileges));
     }
 
     @Test
     // [utest->dsn~granting-system-privileges-to-database-users~1]
     void testGetSystemPrivileges() {
-        final User user = new ExasolUser(this.writerMock, "SYTEMUSER") //
+        final User user = new ExasolUser(this.writerMock, ExasolIdentifier.of("SYTEMUSER")) //
                 .grant(ExasolGlobalPrivilege.CREATE_SESSION);
         assertThat(user.getGlobalPrivileges(), contains(ExasolGlobalPrivilege.CREATE_SESSION));
     }
 
     @Test
     void testGrantAllAccess(@Mock final DatabaseObject objectMock) {
-        final User user = new ExasolUser(this.writerMock, "OBJSUPERUSER").grantAllAccess(objectMock);
+        final User user = new ExasolUser(this.writerMock, ExasolIdentifier.of("OBJSUPERUSER")).grantAllAccess(objectMock);
         assertThat(user.getObjectPrivileges(), hasEntry(objectMock, ExasolObjectPrivilege.values()));
     }
 }
diff --git a/src/test/java/com/exasol/dbbuilder/dialects/exasol/VirtualSchemaTest.java b/src/test/java/com/exasol/dbbuilder/dialects/exasol/VirtualSchemaTest.java
diff --git a/src/test/java/com/exasol/dbbuilder/dialects/mysql/MySqlSchemaTest.java b/src/test/java/com/exasol/dbbuilder/dialects/mysql/MySqlSchemaTest.java
diff --git a/src/test/java/com/exasol/dbbuilder/dialects/mysql/MySqlUserTest.java b/src/test/java/com/exasol/dbbuilder/dialects/mysql/MySqlUserTest.java
diff --git a/src/test/java/com/exasol/dbbuilder/dialects/postgres/PostgreSqlSchemaTest.java b/src/test/java/com/exasol/dbbuilder/dialects/postgres/PostgreSqlSchemaTest.java

Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,12 @@ public MySqlObjectFactory(final Connection connection) {`
`24`	`24`
`25`	`25`	`@Override`
`26`	`26`	`public User createUser(final String name) {`
`27`		`- return new MySqlUser(this.writer, name);`
	`27`	`+ return new MySqlUser(this.writer, MySQLIdentifier.of(name));`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`@Override`
`31`	`31`	`public User createUser(final String name, final String password) {`
`32`		`- return new MySqlUser(this.writer, name, password);`
	`32`	`+ return new MySqlUser(this.writer, MySQLIdentifier.of(name), password);`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Override`
`@@ -44,7 +44,7 @@ public User createLoginUser(final String name, final String password) {`
`44`	`44`
`45`	`45`	`@Override`
`46`	`46`	`public MySqlSchema createSchema(final String name) {`
`47`		`- return new MySqlSchema(this.writer, name);`
	`47`	`+ return new MySqlSchema(this.writer, MySQLIdentifier.of(name));`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,6 @@ public User createLoginUser(final String name, final String password) {`
`46`	`46`
`47`	`47`	`@Override`
`48`	`48`	`public Schema createSchema(final String name) {`
`49`		`- return new PostgreSqlSchema(this.writer, name);`
	`49`	`+ return new PostgreSqlSchema(this.writer, PostgreSqlIdentifier.of(name));`
`50`	`50`	`}`
`51`	`51`	`}`