Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ceifa/sqlier
Yet another gmod database abstraction
https://github.com/ceifa/sqlier
Last synced: 18 days ago
JSON representation
Yet another gmod database abstraction
- Host: GitHub
- URL: https://github.com/ceifa/sqlier
- Owner: ceifa
- License: mit
- Created: 2020-08-22T23:25:35.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-02T10:39:21.000Z (about 2 years ago)
- Last Synced: 2024-10-07T06:06:30.448Z (about 1 month ago)
- Language: Lua
- Size: 58.6 KB
- Stars: 28
- Watchers: 5
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Are you tired of these lots of heavy database libraries which do a lot of things which you don't need? You came at the right place! This project aims to offer a way of writing a very simple code only one time and be able to switch between multiple database drivers without problems. The most easier and lightweight database abstraction of the market!
> Alert: This project will not fill all the edge database cases and does not aim to do so.
## Documentation
You can find the full library documentaion [here](https://github.com/ceifa/sqlier/wiki).
## Usage
### Setup a database
Firstly you will need to setup your databases, sqlier can be initialized by running the initializer function `sqlier.Initialize(name, drive, conn)` which accepts the following arguments:
1. `STRING` `name`: Identification name for the database (can be anything)
2. `STRING` `driver`: The desired database driver, currently supports:
- `sqlite`: Uses default [Garry's Mod Sqlite](https://wiki.facepunch.com/gmod/sql) interface
- `mysqloo`: Uses the [Mysqloo Module](https://github.com/FredyH/MySQLOO) (provides MySQL interface)
- `file`: Uses [plain files](https://wiki.facepunch.com/gmod/file_class) to read and store data
4. `optional` | `STRING` `Connection info`: Only needed when using MySqloo driver, passing the database authentication details.
```lua
-- Sqlite
sqlier.Initialize("db1", "sqlite")
-- MySQL
sqlier.Initialize("db2", "mysqloo", { address = "localhost", port = "3306", database = "GmodServer", user = "root", password = "" })
```
### Setup a model
Now you will have to setup a model, it works like a class:
```lua
local User = sqlier.Model({
Table = "user",
Columns = {
Id = {
Type = sqlier.Type.Integer,
AutoIncrement = true
},
Name = {
Type = sqlier.Type.String
},
Rank = {
Type = sqlier.Type.String,
MaxLength = 15
},
SteamId64 = {
Type = sqlier.Type.SteamId64
},
CreateTimestamp = {
Type = sqlier.Type.Timestamp
}
},
Identity = "Id"
})
```
The columns `CreateTimestamp` and `UpdateTimestamp` are hard-coded internally populated automatically.
### Instantiate, update or delete a model
```lua
local new_user = User({
Name = ply:Nick(),
SteamId = ply:SteamId64(),
Rank = "user"
})
new_user:save()
new_user.Rank = "donator"
new_user:save()
new_user:delete()
```
If you want to know when a save or delete is done, you can pass a callback or use their async api, if using `util.Promise`:
```lua
new_user:save(function()
print("Save is done")
end)
util.PromiseAsync(function()
new_user:saveAsync():Await()
new_user:deleteAsync():Await()
end)
```
### Querying
We have some simple methods to do querying:
```lua
-- The fastest way, get by identity
User:get(2, function(user)
end)
-- Find one by property filtering
User:find({ Name = "ceifa" }, function(user)
end)
-- Get many by property filtering
User:filter({ Rank = "donator" }, function(users)
end)
```
If you have support for `util.Promise`, you can use the async methods:
```lua
util.PromiseAsync(function()
local user = User:getAsync(2):Await()
local user = User:findAsync({ Name = "ceifa" }):Await()
local users = User:filterAsync({ Rank = "donator" }):Await()
end)
```
But if you want more complex queries, you will have to do it yourself:
```lua
local user_db = User:database()
if user_db.Driver == "sqlite" or user_db.Driver == "mysqloo" then
user_db:query("SELECT Name, COUNT(*) as Quantity FROM user GROUP BY Name", function(names)
end)
else
error("Database driver not supported")
end
```