Initial commit

README.md

@@ -0,0 +1,64 @@
+# skript-db
+
+> Awesome direct database access for Skript
+
+## Syntax
+
+### Expression `Data Source` => `datasource`
+
+This 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 below uses a MySQL database.
+
+#### Syntax
+
+`[the] data(base|[ ]source) [(of|at)] %string%`
+
+#### Example
+
+```
+set {sql} to the database "mysql://localhost:3306/sys?user=admin&password=12345&useSSL=false"
+```
+
+### Effect `Execute Statement`
+
+Executes a statement on a database and optionally stores the result in a variable. Expressions embedded in the query will be escaped to avoid SQL injection.
+
+If a single variable, such as `{test}`, is passed, the variable will be set to the number of affected rows.
+
+If a list variable, such as `{test::*}`, is passed, the query result will be mapped to the list variable in the form `{test::<column name>::<row number>}`
+
+#### Syntax
+
+`execute %text% (in|on) %datasource% 
+ [and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %variable%]`
+ 
+#### Example
+
+```
+execute "select * from table" in {sql} and store the result in {output::*}
+execute "select * from %{table variable}%" in {sql} and store the result in {output::*}
+```
+
+### Expression `Unsafe Expression` => `text`
+
+Opts out of automatic SQL injection protection for a specific expression in a statement.
+
+#### Syntax
+
+`unsafe %text%`
+
+#### Example
+
+```
+execute "select %unsafe {columns variable}% from %{table variable}%" in {sql} and store the result in {output::*}
+execute unsafe {fully dynamic query} in {sql}
+```
+
+### Expression `Last Data Source Error` => `text`
+
+Stores the error from the last executed statement, if there was one.
+
+#### Syntax
+
+`[the] [last] (sql|db|data(base|[ ]source)) error`