executeAndReturnKey for inserts, Optionals for selectOnes, documentation

Author: Schubi1981

README.md

@@ -22,15 +22,16 @@ A Java-Library to build SQL-Statements
 <dependency>
   <groupId>de.jaggl.sqlbuilder</groupId>
   <artifactId>sqlbuilder-core</artifactId>
-  <version>2.6.3</version>
+  <version>2.6.4</version>
 </dependency>
 ```
 
 ### Simple Example
 
 ```java
 private static final Table PERSONS = Table.create("persons");
-private static final VarCharColumn LASTNAME = PERSONS.varCharColumn("lastname").build();
+private static final VarCharColumn FORENAME = PERSONS.varCharColumn("forename").size(50).build();
+private static final VarCharColumn LASTNAME = PERSONS.varCharColumn("lastname").size(50).build();
 
 public static final void main(String[] args)
 {
@@ -46,6 +47,48 @@ SELECT * FROM `persons` WHERE `persons`.`lastname` = 'Doe'
 ```
 To get the SQL-statement as a string, call `build()` instead of `print()`
 
+#### Some other examples:
+
+```java
+Queries.insertInto(PERSONS)
+	.set(FORENAME, "John")
+	.set(LASTNAME, "Doe")
+	.print();
+```
+Output:
+```sql
+INSERT INTO `persons` SET `persons`.`forename` = 'John', `persons`.`lastname` = 'Doe'
+```
+
+```java
+Queries.update(PERSONS)
+	.set(FORENAME, "John")
+	.where(LASTNAME.eq("Doe"))
+	.print();
+```
+Output:
+```sql
+UPDATE `persons` SET `persons`.`forename` = 'John', WHERE `persons`.`lastname` = 'Doe'
+```
+
+```java
+Queries.deleteFrom(PERSONS)
+	.where(LASTNAME.eq("Doe"))
+	.print();
+```
+Output:
+```sql
+DELETE FROM `persons` WHERE `persons`.`lastname` = 'Doe'
+```
+
+```java
+PERSONS.buildCreateTable().println()
+```
+Output:
+```sql
+CREATE TABLE `persons` (`forename` VARCHAR(50) DEFAULT NULL, `lastname` VARCHAR(50) DEFAULT NULL)
+```
+
 ### Features
 
 - Build SQL-queries in different dialects, currently supported are:

pom.xml

@@ -3,7 +3,7 @@
 
   <groupId>de.jaggl.sqlbuilder</groupId>
   <artifactId>sqlbuilder-core</artifactId>
-  <version>2.6.3</version>
+  <version>2.6.4</version>
 
   <packaging>jar</packaging>
 

src/main/java/de/jaggl/sqlbuilder/queries/Insert.java

@@ -15,6 +15,7 @@
 import de.jaggl.sqlbuilder.domain.ValuableColumn;
 import de.jaggl.sqlbuilder.domain.ValuableFunction;
 import de.jaggl.sqlbuilder.functions.Function;
+import de.jaggl.sqlbuilder.queryexecutor.QueryExecutor;
 import de.jaggl.sqlbuilder.schema.Table;
 import de.jaggl.sqlbuilder.utils.Indentation;
 import lombok.Getter;
@@ -97,4 +98,9 @@ public static Insert copy(Insert insert)
     {
         return new Insert(insert);
     }
+
+    public long executeAndReturnKey(QueryExecutor queryExecutor)
+    {
+        return queryExecutor.executeAndReturnKey(this);
+    }
 }

src/main/java/de/jaggl/sqlbuilder/queries/UpdatebleQuery.java

@@ -9,7 +9,7 @@
  */
 public interface UpdatebleQuery extends Query
 {
-    default int execute(QueryExecutor queryExecutor)
+    default long execute(QueryExecutor queryExecutor)
     {
         return queryExecutor.execute(this);
     }

src/main/java/de/jaggl/sqlbuilder/queryexecutor/QueryExecutor.java

@@ -1,6 +1,7 @@
 package de.jaggl.sqlbuilder.queryexecutor;
 
 import de.jaggl.sqlbuilder.queries.ExecutableQuery;
+import de.jaggl.sqlbuilder.queries.Insert;
 import de.jaggl.sqlbuilder.queries.UpdatebleQuery;
 
 /**
@@ -14,7 +15,9 @@ public interface QueryExecutor
 
     <T> SelectQueryExecutor<T> select(Class<T> elementType);
 
-    int execute(UpdatebleQuery updatebleQuery);
+    long execute(UpdatebleQuery updatebleQuery);
+
+    long executeAndReturnKey(Insert insert);
 
     void execute(ExecutableQuery executableQuery);
 }

src/test/java/de/jaggl/sqlbuilder/queries/UpdatebleQueryTest.java

@@ -1,5 +1,6 @@
 package de.jaggl.sqlbuilder.queries;
 
+import static de.jaggl.sqlbuilder.queries.Queries.insertInto;
 import static de.jaggl.sqlbuilder.queries.Queries.update;
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -22,4 +23,12 @@ void testQuery()
 
         assertThat(update(TABLE).set(LASTNAME, "Schumacher").execute(queryExecutor)).isEqualTo(5);
     }
+
+    @Test
+    void testInsertQuery()
+    {
+        var queryExecutor = new MyQueryExecutor();
+
+        assertThat(insertInto(TABLE).set(LASTNAME, "Schumacher").executeAndReturnKey(queryExecutor)).isEqualTo(3);
+    }
 }

src/test/java/de/jaggl/sqlbuilder/testsupport/QueryExecutorTestSupport.java

@@ -1,6 +1,7 @@
 package de.jaggl.sqlbuilder.testsupport;
 
 import de.jaggl.sqlbuilder.queries.ExecutableQuery;
+import de.jaggl.sqlbuilder.queries.Insert;
 import de.jaggl.sqlbuilder.queries.UpdatebleQuery;
 import de.jaggl.sqlbuilder.queryexecutor.QueryExecutor;
 import de.jaggl.sqlbuilder.queryexecutor.RowExtractor;
@@ -29,11 +30,17 @@ public <T> SelectQueryExecutor<T> select(Class<T> elementType)
         }
 
         @Override
-        public int execute(UpdatebleQuery updatebleQuery)
+        public long execute(UpdatebleQuery updatebleQuery)
         {
             return 5;
         }
 
+        @Override
+        public long executeAndReturnKey(Insert insert)
+        {
+            return 3;
+        }
+
         @Override
         public void execute(ExecutableQuery executableQuery)
         {