btk5h / skript-db

MIT License
5 stars 5 forks source link
database skript sql

skript-db

Sensible SQL support for Skript.

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::::}` Specifying `synchronously` will make skript-db execute the query on the event thread, which is useful for async events. Note that skript-db will ignore this flag if you attempt to run this on the main thread. #### Syntax ``` [synchronously] execute %string% (in|on) %datasource% [and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%] ``` #### Examples ``` execute "select * from table" in {sql} and store the result in {output::*} ``` ``` execute "select * where player=%{player}%" in {sql} and store the result in {output::*} ``` --- ### 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 ``` --- ### Expression `Unsafe Expression` => `text` Opts out of automatic SQL injection protection for a specific expression in a statement. #### Syntax ``` unsafe %text% ``` #### Examples ``` execute "select %unsafe {columns variable}% from %{table variable}%" in {sql} ``` ``` execute unsafe {fully dynamic query} in {sql} ``` --- ### 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. #### Syntax ``` [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%]" ``` #### Examples ``` set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false" ``` ---