Compare commits
8 Commits
Author | SHA1 | Date |
---|---|---|
Govindas | c11980eea5 | |
Govindas | 4124994b83 | |
Govindas | cf61d7589b | |
Govindas | 4d4af1622e | |
Govindas | af25e695f0 | |
Govindas | 54e260e56b | |
Govindas | 587f303ba5 | |
Govindas | 8586aeefcd |
18
README.md
18
README.md
|
@ -5,13 +5,14 @@
|
|||
|
||||
### 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 with use of CachedThreadPool, instead of a fixed hard-coded number
|
||||
- Uses newer versions of dependencies (Increased performance and security)
|
||||
- Replaced `synchronously execute` with `quickly execute`, which allows to speed up queries by 50ms with some risk
|
||||
- SQL Driver is configurable
|
||||
- If a sql query is detected to be running on non-main thread, it becomes synchronous automatically
|
||||
- SQL Driver is configurable both in config and in database connection, comes with shaded MariaDB and PostgreSQL drivers
|
||||
- A few variable type related bugs fixed
|
||||
- Uses Java 11 instead of Java 8
|
||||
|
||||
|
||||
### 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)
|
||||
|
@ -21,15 +22,23 @@
|
|||
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%
|
||||
[the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%] [[(using|with)] [a] driver %-string%]
|
||||
```
|
||||
|
||||
#### 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"
|
||||
|
||||
# Extra parameters:
|
||||
set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false" with a maximum connection lifetime of 30 minutes
|
||||
set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false" with a maximum connection lifetime of 30 minutes using driver "org.postgresql.Driver"
|
||||
```
|
||||
|
||||
---
|
||||
|
@ -71,6 +80,7 @@ Stores the error from the last executed statement, if there was one.
|
|||
|
||||
### Expression `Unsafe Expression` => `text`
|
||||
Opts out of automatic SQL injection protection for a specific expression in a statement.
|
||||
Note: If using PostgreSQL, this will always be needed, due to skript-db not supporting SQL injection protection for PostgreSQL currently.
|
||||
#### Syntax
|
||||
```
|
||||
unsafe %text%
|
||||
|
|
13
pom.xml
13
pom.xml
|
@ -6,7 +6,7 @@
|
|||
|
||||
<groupId>com.btk5h</groupId>
|
||||
<artifactId>skript-db</artifactId>
|
||||
<version>1.3.8</version>
|
||||
<version>1.4.0</version>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<repositories>
|
||||
|
@ -28,7 +28,7 @@
|
|||
</repository>
|
||||
<repository>
|
||||
<id>sk89q</id>
|
||||
<url>http://maven.sk89q.com/repo</url>
|
||||
<url>https://maven.sk89q.com/repo</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
|
||||
|
@ -100,7 +100,14 @@
|
|||
<dependency>
|
||||
<groupId>org.mariadb.jdbc</groupId>
|
||||
<artifactId>mariadb-java-client</artifactId>
|
||||
<version>3.0.9</version>
|
||||
<version>3.1.2</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<!-- https://mvnrepository.com/artifact/org.postgresql/postgresql -->
|
||||
<dependency>
|
||||
<groupId>org.postgresql</groupId>
|
||||
<artifactId>postgresql</artifactId>
|
||||
<version>42.6.0</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
|
||||
|
|
|
@ -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();
|
||||
|
|
|
@ -44,8 +44,7 @@ import java.util.concurrent.Executors;
|
|||
* @since 0.1.0
|
||||
*/
|
||||
public class EffExecuteStatement extends Effect {
|
||||
private static final ExecutorService threadPool =
|
||||
Executors.newCachedThreadPool();
|
||||
private static final ExecutorService threadPool = Executors.newFixedThreadPool(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
|
||||
static String lastError;
|
||||
|
||||
static {
|
||||
|
|
|
@ -22,7 +22,7 @@ import java.util.Map;
|
|||
*
|
||||
* @name Data Source
|
||||
* @index -1
|
||||
* @pattern [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%]"
|
||||
* @pattern [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%] [[(using|with)] [a] driver %-string%]"
|
||||
* @return datasource
|
||||
* @example set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
|
||||
* @since 0.1.0
|
||||
|
@ -33,11 +33,12 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
|
|||
static {
|
||||
Skript.registerExpression(ExprDataSource.class, HikariDataSource.class,
|
||||
ExpressionType.COMBINED, "[the] data(base|[ ]source) [(of|at)] %string% " +
|
||||
"[with [a] [max[imum]] [connection] life[ ]time of %-timespan%]");
|
||||
"[with [a] [max[imum]] [connection] life[ ]time of %-timespan%] " + "[[(using|with)] [a] driver %-string%]");
|
||||
}
|
||||
|
||||
private Expression<String> url;
|
||||
private Expression<Timespan> maxLifetime;
|
||||
private Expression<String> driver;
|
||||
|
||||
@Override
|
||||
protected HikariDataSource[] get(Event e) {
|
||||
|
@ -55,11 +56,18 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
|
|||
}
|
||||
|
||||
HikariDataSource ds = new HikariDataSource();
|
||||
ds.setMaximumPoolSize(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
|
||||
|
||||
//allow specifying of own sql driver class name
|
||||
if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
|
||||
// 30 minutes by default
|
||||
ds.setMaxLifetime(SkriptDB.getInstance().getConfig().getInt("max-connection-lifetime", 1800000));
|
||||
|
||||
// Allow specifying of own sql driver class name
|
||||
if (driver != null && driver.getSingle(e) != null) {
|
||||
ds.setDriverClassName(driver.getSingle(e));
|
||||
} else if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
|
||||
ds.setDriverClassName(SkriptDB.getInstance().getConfig().getString("sql-driver-class-name"));
|
||||
}
|
||||
|
||||
ds.setJdbcUrl(jdbcUrl);
|
||||
|
||||
if (maxLifetime != null) {
|
||||
|
@ -96,6 +104,7 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
|
|||
SkriptParser.ParseResult parseResult) {
|
||||
url = (Expression<String>) exprs[0];
|
||||
maxLifetime = (Expression<Timespan>) exprs[1];
|
||||
driver = (Expression<String>) exprs[2];
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
name: skript-db
|
||||
version: 1.3.5
|
||||
version: 1.4.0
|
||||
main: com.btk5h.skriptdb.SkriptDB
|
||||
depend: [Skript]
|
||||
authors: [btk5h, FranKusmiruk, Govindas, TPGamesNL]
|
||||
|
|
Loading…
Reference in New Issue