Update README.md

Reviewed-on: Limework/skript-db#20

README.md

@@ -5,16 +5,25 @@
 
 ### Difference from original skript-db
 - Fixed local variables disappearance in newer Skript versions (very hacky fix, but it works, so that's good!)
-- Thread-pool size is now automatically increasing on demand to use of CachedThreadPool, instead of a fixed hard-coded number
+- Uses newer versions of dependencies (Increased performance and security)
-- Uses a newer version of HikariCP
-- Only meant to be used by newer Minecraft versions (1.8 is not supported)
 - Replaced `synchronously execute` with `quickly execute`, which allows to speed up queries by 50ms with some risk
+- If a sql query is detected to be running on non-main thread, it becomes synchronous automatically
+- SQL Driver is configurable, comes with shaded MariaDB and PostgreSQL drivers
+- A few variable type related bugs fixed
+- Uses Java 11 instead of Java 8
+- Configurable max-connection-lifetime
 
+### Installation
+1. Use 1.8+ Minecraft server version.
+2. Use Skript 2.5+ (1.8 Skript fork is needed if you're using 1.8)
+3. Use Java 11+ (If you use 1.8, a spigot fork is needed to support Java 11+)
+4. Put skript-db in plugins folder and restart the server
 ### Expression `Data Source` => `datasource`
 Stores the connection information for a data source. This should be saved to a variable in a
  `script load` event or manually through an effect command.
 
- The url format for your database may vary! The example provided uses a MySQL database.
+ The url format for your database may vary depending on database you are using. 
+ MariaDB/PostgreSQL users: make sure to check `config.yml` to use the correct driver.
 #### Syntax
 ```
 [the] data(base|[ ]source) [(of|at)] %string%
@@ -23,6 +32,9 @@ Stores the connection information for a data source. This should be saved to a v
 #### Examples
 ```
 set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
+set {sql} to the database "mariadb://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
+set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false"
+set {sql} to the database "sqlite:database.db"
 ```
 
 ---
@@ -77,4 +89,23 @@ execute "select %unsafe {columns variable}% from %{table variable}%" in {sql}
 execute unsafe {fully dynamic query} in {sql}
 ```
 
+#### FAQ: How to return sql data in a function?
+You can't because functions don't allow delays, but you can use skript-reflect sections for this:
+```
+on load:
+	create new section stored in {-section::getPlayersFromDatabase}:
+		execute "SELECT uuid FROM table" in {-sql} and store the result in {_result::*}
+		return {_result::uuid::*}
+command /showplayers [<text>]:
+	trigger:
+		run section {-section::getPlayersFromDatabase} async and store result in {_uuids::*} and wait
+		send "%{_uuids::*}%"
+```
 ---
+### Configuration
+plugins/skript-db/config.yml
+```
+# Only change this if you wish to use a different driver than Java's default, like MariaDB driver.
+# If you use MariaDB, its driver is shaded together with skript-db, so you can just specify: "org.mariadb.jdbc.Driver"
+sql-driver-class-name: "default"
+```

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.btk5h</groupId>
     <artifactId>skript-db</artifactId>
-    <version>1.3.1</version>
+    <version>1.3.9</version>
     <packaging>jar</packaging>
 
     <repositories>
@@ -19,8 +19,8 @@
             <url>https://jitpack.io</url>
         </repository>
         <repository>
-            <id>commons-pool2</id>
+            <id>mvnrepository</id>
-            <url>https://mvnrepository.com/artifact/org.apache.commons/commons-pool2</url>
+            <url>https://mvnrepository.com</url>
         </repository>
         <repository>
             <id>PaperMC</id>
@@ -45,8 +45,8 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.6.1</version>
                 <configuration>
-                    <source>8</source>
+                    <source>11</source>
-                    <target>8</target>
+                    <target>11</target>
                     <encoding>UTF-8</encoding>
                 </configuration>
             </plugin>
@@ -81,7 +81,7 @@
         <dependency>
             <groupId>com.zaxxer</groupId>
             <artifactId>HikariCP</artifactId>
-            <version>4.0.3</version>
+            <version>5.0.1</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
@@ -93,14 +93,21 @@
         <dependency>
             <groupId>com.github.SkriptLang</groupId>
             <artifactId>Skript</artifactId>
-            <version>2.6-alpha1</version>
+            <version>2.6.1</version>
             <scope>provided</scope>
         </dependency>
         <!-- https://mvnrepository.com/artifact/org.mariadb.jdbc/mariadb-java-client -->
         <dependency>
             <groupId>org.mariadb.jdbc</groupId>
             <artifactId>mariadb-java-client</artifactId>
-            <version>2.7.2</version>
+            <version>3.0.9</version>
+            <scope>compile</scope>
+        </dependency>
+        <!-- https://mvnrepository.com/artifact/org.postgresql/postgresql -->
+        <dependency>
+            <groupId>org.postgresql</groupId>
+            <artifactId>postgresql</artifactId>
+            <version>42.5.1</version>
             <scope>compile</scope>
         </dependency>
 

src/main/java/com/btk5h/skriptdb/SkriptDB.java

@@ -73,8 +73,14 @@ public final class SkriptDB extends JavaPlugin {
       }
       try {
         if (out == null) return;
-        out.write("# Only change this if you wish to use a different driver than Java's default, like MariaDB driver.\n");
+
-        out.write("# If you use MariaDB, its driver is shaded together with skript-db, so you can just specify:" + "\"org.mariadb.jdbc.Driver\"" + ".\n");
+        out.write("# How many connections can be awaited for simultaneously, may be useful to increase if SQL database is hosted on a separate machine to account for ping.\n");
+        out.write("# If it is hosted within the same machine, set it to the count of cores your processor has or the count of threads your processor can process at once.\n");
+        out.write("thread-pool-size: " + (Runtime.getRuntime().availableProcessors() + 2) + "\n");
+        out.write("# How long SQL connections should be kept alive in HikariCP. Default: 1800000 (30 minutes)");
+        out.write("max-connection-lifetime: 1800000");
+        out.write("# Only change this if you wish to use a different driver than Java's default, like MariaDB/PostgreSQL driver.\n");
+        out.write("# If you use MariaDB or PostgreSQL, its driver is shaded together with skript-db, so you can just specify:" + "\"org.mariadb.jdbc.Driver\"" + " or " + "\"org.postgresql.Driver\"" + ".\n");
         out.write("sql-driver-class-name: " + "\"default\"" + "\n");
       } catch (IOException e) {
         e.printStackTrace();

src/main/java/com/btk5h/skriptdb/skript/EffExecuteStatement.java

@@ -14,6 +14,9 @@ import org.bukkit.event.Event;
 
 import javax.sql.DataSource;
 import javax.sql.rowset.CachedRowSet;
+import javax.sql.rowset.serial.SerialBlob;
+import javax.sql.rowset.serial.SerialException;
+import java.io.IOException;
 import java.sql.Connection;
 import java.sql.PreparedStatement;
 import java.sql.ResultSetMetaData;
@@ -41,8 +44,7 @@ import java.util.concurrent.Executors;
  * @since 0.1.0
  */
 public class EffExecuteStatement extends Effect {
-    private static final ExecutorService threadPool =
+    private static final ExecutorService threadPool = Executors.newFixedThreadPool(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
-            Executors.newCachedThreadPool();
     static String lastError;
 
     static {
@@ -57,7 +59,8 @@ public class EffExecuteStatement extends Effect {
     private VariableString var;
     private boolean isLocal;
     private boolean isList;
-    private boolean isSync;
+    private boolean quickly;
+    private boolean isSync = false;
 
     private void continueScriptExecution(Event e, Object populatedVariables) {
         lastError = null;
@@ -79,77 +82,74 @@ public class EffExecuteStatement extends Effect {
         String baseVariable = var != null ? var.toString(e).toLowerCase(Locale.ENGLISH) : null;
         //if data source isn't set
         if (ds == null) return;
-
-        boolean sync = !Bukkit.isPrimaryThread();
-
-        //if current thread is not main thread, then make this query to not have delays
-
         Object locals = Variables.removeLocals(e);
 
         //execute SQL statement
-        CompletableFuture<Object> sql =
+        if (Bukkit.isPrimaryThread()) {
-                CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
+            CompletableFuture<Object> sql = CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
-
+            sql.whenComplete((res, err) -> {
-        //when SQL statement is completed
+                if (err != null) {
-        boolean finalSync = sync;
+                    err.printStackTrace();
-        sql.whenComplete((res, err) -> {
+                }
-            if (err != null) {
+                //handle last error syntax data
-                err.printStackTrace();
+                lastError = null;
-            }
+                if (res instanceof String) {
-
+                    lastError = (String) res;
-            //handle last error syntax data
+                }
-            lastError = null;
-            if (res instanceof String) {
-                lastError = (String) res;
-            }
-
-            if (getNext() != null) {
                 //if local variables are present
-                if (locals != null) {
+                //bring back local variables
-                    //bring back local variables
+                //populate SQL data into variables
-
+                if (!quickly) {
-                    //populate SQL data into variables
+                    Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
-                    if (!(res instanceof String)) {
+                        if (locals != null && getNext() != null) {
-
+                            Variables.setLocalVariables(e, locals);
-                        //also set variables in the sql query complete event
+                        }
-
-                        //TEMPORARILY DISABLED, AS THIS WOULD WORSEN PERFORMANCE OF THE QUERIES AND NOT BE USED BY MOST PEOPLE.
-                        //I may add config option to enable this later?
-
-                        //SQLQueryCompleteEvent event = new SQLQueryCompleteEvent(this.query.getSingle(e));
-                        //((Map<String, Object>) res).forEach((name, value) -> setVariable(event, name, value));
-                        //SkriptDB.getPlugin(SkriptDB.class).getServer().getPluginManager().callEvent(event);
-                    }
-                    if (isSync || finalSync) {
-                        Variables.setLocalVariables(e, locals);
                         if (!(res instanceof String)) {
                             ((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
                         }
                         TriggerItem.walk(getNext(), e);
+                        //the line below is required to prevent memory leaks
                         Variables.removeLocals(e);
-                    } else {
+                    });
-                        Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
+                } else {
-                            Variables.setLocalVariables(e, locals);
+                    if (locals != null && getNext() != null) {
-                            if (!(res instanceof String)) {
+                        Variables.setLocalVariables(e, locals);
-                                ((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
-                            }
-                            TriggerItem.walk(getNext(), e);
-                            //the line below is required to prevent memory leaks
-                            //no functionality difference notice with it being removed from my test, but the memory gets filled with leaks
-                            //so it must be kept
-                            Variables.removeLocals(e);
-                        });
                     }
+                    if (!(res instanceof String)) {
+                        ((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
+                    }
+                    TriggerItem.walk(getNext(), e);
+                    //the line below is required to prevent memory leaks
+                    Variables.removeLocals(e);
                 }
+            });
+            // sync executed SQL query, same as above, just sync
+        } else {
+            isSync = true;
+            Object resources = executeStatement(ds, baseVariable, query);
+            //handle last error syntax data
+            lastError = null;
+            if (resources instanceof String) {
+                lastError = (String) resources;
             }
-        });
+            //if local variables are present
+            //bring back local variables
+            //populate SQL data into variables
+            if (locals != null && getNext() != null) {
+                Variables.setLocalVariables(e, locals);
+            }
+            if (!(resources instanceof String)) {
+                ((Map<String, Object>) resources).forEach((name, value) -> setVariable(e, name, value));
+            }
+            TriggerItem.walk(getNext(), e);
+            Variables.removeLocals(e);
+        }
     }
 
     @Override
     protected TriggerItem walk(Event e) {
         debug(e, true);
-        //I think no longer needed as of 1.3.0, uncomment if something breaks
+        if (!quickly || !isSync) {
-        if (!isSync) {
             Delay.addDelayedEvent(e);
         }
         execute(e);
@@ -174,7 +174,11 @@ public class EffExecuteStatement extends Effect {
             if (o instanceof String) {
                 sb.append(o);
             } else {
-                Expression<?> expr = SkriptUtil.getExpressionFromInfo(o);
+                Expression<?> expr;
+                if (o instanceof Expression)
+                    expr = (Expression<?>) o;
+                else
+                    expr = SkriptUtil.getExpressionFromInfo(o);
 
                 String before = getString(objects, i - 1);
                 String after = getString(objects, i + 1);
@@ -293,6 +297,21 @@ public class EffExecuteStatement extends Effect {
     }
 
     private void setVariable(Event e, String name, Object obj) {
+
+        //fix mediumblob and similar column types, so they return a String correctly
+        if (obj != null) {
+            if (obj.getClass().getName().equals("[B")) {
+                obj = new String((byte[]) obj);
+
+                //in some servers instead of being byte array, it appears as SerialBlob (depends on mc version, 1.12.2 is bvte array, 1.16.5 SerialBlob)
+            } else if (obj instanceof SerialBlob) {
+                try {
+                    obj = new String(((SerialBlob) obj).getBinaryStream().readAllBytes());
+                } catch (IOException | SerialException ex) {
+                    ex.printStackTrace();
+                }
+            }
+        }
         Variables.setVariable(name.toLowerCase(Locale.ENGLISH), obj, e, isLocal);
     }
 
@@ -316,7 +335,7 @@ public class EffExecuteStatement extends Effect {
         }
         dataSource = (Expression<HikariDataSource>) exprs[1];
         Expression<?> expr = exprs[2];
-        isSync = matchedPattern == 1;
+        quickly = matchedPattern == 1;
         if (expr instanceof Variable) {
             Variable<?> varExpr = (Variable<?>) expr;
             var = varExpr.getName();

src/main/java/com/btk5h/skriptdb/skript/EvtSQLQueryComplete.java

@@ -6,7 +6,6 @@ import ch.njol.skript.lang.SkriptEvent;
 import ch.njol.skript.lang.SkriptParser;
 import com.btk5h.skriptdb.events.SQLQueryCompleteEvent;
 import org.bukkit.event.Event;
-import org.eclipse.jdt.annotation.Nullable;
 
 public class EvtSQLQueryComplete extends SkriptEvent {
     static {
@@ -24,7 +23,7 @@ public class EvtSQLQueryComplete extends SkriptEvent {
     }
 
     @Override
-    public String toString(@Nullable Event event, boolean debug) {
+    public String toString(Event event, boolean debug) {
         return "complete of sql query";
     }
 }

src/main/java/com/btk5h/skriptdb/skript/ExprDataSource.java

@@ -55,7 +55,9 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
         }
 
         HikariDataSource ds = new HikariDataSource();
-
+        ds.setMaximumPoolSize(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
+        // 30 minutes by default
+        ds.setMaxLifetime(SkriptDB.getInstance().getConfig().getInt("max-connection-lifetime", 1800000));
         //allow specifying of own sql driver class name
         if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
             ds.setDriverClassName(SkriptDB.getInstance().getConfig().getString("sql-driver-class-name"));

src/main/java/com/btk5h/skriptdb/skript/Types.java

@@ -30,10 +30,6 @@ public class Types {
                         return o.getJdbcUrl();
                     }
 
-                    @Override
-                    public String getVariableNamePattern() {
-                        return "jdbc:.+";
-                    }
                 })
                 .serializer(new Serializer<HikariDataSource>() {
                     @Override

src/main/resources/plugin.yml

@@ -1,6 +1,6 @@
 name: skript-db
-version: 1.3.1
+version: 1.3.9
 main: com.btk5h.skriptdb.SkriptDB
 depend: [Skript]
-authors: [btk5h, FranKusmiruk, Govindas]
+authors: [btk5h, FranKusmiruk, Govindas, TPGamesNL]
 api-version: 1.13