Limework/skript-db
2
2
Fork 3
Code Issues 4 Pull Requests 1 Projects Releases 14 Wiki Activity

Add experimental support for SkriptDoclet

Browse Source
This commit is contained in:
Bryan Terce
2017-11-21 16:58:47 -08:00
parent e1bbd37a35
commit 3edaa7d107
8 changed files with 108 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
README.md
View File

@@ -1,21 +1,19 @@
# skript-db
> Awesome direct database access for Skript
## Syntax
> Sensible SQL support for Skript.
---
### 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.
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.
The url format for your database may vary! The example provided uses a MySQL database.
#### Syntax
```
[the] data(base|[ ]source) [(of|at)] %string%
```
`[the] data(base|[ ]source) [(of|at)] %string%`
#### Example
#### Examples
```
set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
```
@@ -23,50 +21,52 @@ set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password
---
### 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.
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>}`
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 %string% (in|on) %datasource% [and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]
```
`execute %text% (in|on) %datasource%
[and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %variable%]`
#### Example
#### Examples
```
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.
### Expression `Last Data Source Error` => `text`
Stores the error from the last executed statement, if there was one.
#### Syntax
`unsafe %text%`
#### Example
```
execute "select %unsafe {columns variable}% from %{table variable}%" in {sql} and store the result in {output::*}
[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 `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`
---