Practical Examples

Ready-to-use examples for the most common use cases on a FiveM server.

---

Player System

SQL Tables

CREATE TABLE `users` (
    `identifier` VARCHAR(60) NOT NULL,
    `money` INT NOT NULL DEFAULT 0,
    `bank` INT NOT NULL DEFAULT 0,
    `job` VARCHAR(50) NOT NULL DEFAULT 'unemployed',
    `group` VARCHAR(50) NOT NULL DEFAULT 'user',
    PRIMARY KEY (`identifier`)
);

Lua Code

local User = OrvexOrvexORM.model("users", {
    identifier = "string",
    money      = "number",
    bank       = "number",
    job        = "string",
    group      = "string",
}, { primaryKey = "identifier" })

-- Player connection
AddEventHandler("playerConnecting", function()
    local src = source
    local license = GetPlayerIdentifierByType(src, "license")

    local player = User.find({ identifier = license })

    if not player then
        player = User.create({
            identifier = license,
            money      = 500,
            bank       = 5000,
            job        = "unemployed",
            group      = "user",
        })
    end
end)

-- Save on disconnect
AddEventHandler("playerDropped", function()
    local src = source
    local license = GetPlayerIdentifierByType(src, "license")

    User.upsert({
        identifier = license,
        money      = GetPlayerMoney(src),
        bank       = GetPlayerBank(src),
    })
end)

-- Give money
RegisterCommand("givemoney", function(src, args)
    local targetId = tonumber(args[1])
    local amount = tonumber(args[2])
    local license = GetPlayerIdentifierByType(targetId, "license")

    local player = User.find({ identifier = license })
    if player then
        player:update({ money = player.money + amount })
        print("Gave " .. amount .. "$ to " .. license)
    end
end, true)

---

Vehicle System

SQL Tables

CREATE TABLE `vehicles` (
    `id` INT AUTO_INCREMENT,
    `owner` VARCHAR(60) NOT NULL,
    `plate` VARCHAR(10) NOT NULL,
    `model` VARCHAR(50) NOT NULL,
    `garage` VARCHAR(50) DEFAULT 'main',
    `fuel` INT DEFAULT 100,
    PRIMARY KEY (`id`)
);

Lua Code

local Vehicle = OrvexORM.model("vehicles", {
    id     = "number",
    owner  = "string",
    plate  = "string",
    model  = "string",
    garage = "string",
    fuel   = "number",
})

-- Relation: a player has many vehicles
User.hasMany("vehicles", Vehicle, { foreignKey = "owner" })
Vehicle.belongsTo("owner_player", User, { foreignKey = "owner" })

-- Buy a vehicle
RegisterCommand("buycar", function(src, args)
    local license = GetPlayerIdentifierByType(src, "license")
    local modelName = args[1]
    local plate = GeneratePlate()

    Vehicle.create({
        owner  = license,
        plate  = plate,
        model  = modelName,
        garage = "main",
        fuel   = 100,
    })

    print(license .. " bought a " .. modelName .. " (" .. plate .. ")")
end, false)

-- View my vehicles
RegisterCommand("mygarage", function(src)
    local license = GetPlayerIdentifierByType(src, "license")

    local vehicles = Vehicle.findAll({ owner = license, garage = "main" })

    for _, v in ipairs(vehicles) do
        print(v.plate .. " — " .. v.model .. " (" .. v.fuel .. "% fuel)")
    end
end, false)

-- Get a player's vehicles using the relation
RegisterCommand("checkvehicles", function(src)
    local license = GetPlayerIdentifierByType(src, "license")
    local player = User.find({ identifier = license })

    if player then
        local vehicles = player:get("vehicles")
        print(player.identifier .. " has " .. #vehicles .. " vehicle(s)")
    end
end, false)

---

Role System (Permissions)

SQL Tables

CREATE TABLE `roles` (
    `id` INT AUTO_INCREMENT,
    `name` VARCHAR(50) NOT NULL UNIQUE,
    PRIMARY KEY (`id`)
);

CREATE TABLE `user_roles` (
    `user_id` VARCHAR(60) NOT NULL,
    `role_id` INT NOT NULL,
    PRIMARY KEY (`user_id`, `role_id`)
);

Lua Code

local Role = OrvexORM.model("roles", {
    id   = "number",
    name = "string",
})

-- Many-to-many relation
User.belongsToMany("roles", Role, {
    pivot      = "user_roles",
    foreignKey = "user_id",
    otherKey   = "role_id",
})

-- Assign a role
RegisterCommand("giverole", function(src, args)
    local targetLicense = args[1]
    local roleName = args[2]

    local player = User.find({ identifier = targetLicense })
    local role = Role.find({ name = roleName })

    if player and role then
        player:attach("roles", role)
        print("Role " .. roleName .. " assigned to " .. targetLicense)
    end
end, true)

-- Remove a role
RegisterCommand("removerole", function(src, args)
    local targetLicense = args[1]
    local roleName = args[2]

    local player = User.find({ identifier = targetLicense })
    local role = Role.find({ name = roleName })

    if player and role then
        player:detach("roles", role)
        print("Role " .. roleName .. " removed from " .. targetLicense)
    end
end, true)

-- Check if a player has a role
RegisterCommand("checkadmin", function(src)
    local license = GetPlayerIdentifierByType(src, "license")
    local player = User.find({ identifier = license })

    if player then
        local roles = player:get("roles")
        for _, role in ipairs(roles) do
            if role.name == "admin" then
                print(license .. " is an admin!")
                return
            end
        end
        print(license .. " is not an admin")
    end
end, false)

---

Leaderboard

-- Top 10 richest players
RegisterCommand("top10", function()
    local top = User.query()
        :where("money", ">", 0)
        :orderBy("money", "DESC")
        :limit(10)
        :get()

    for i, player in ipairs(top) do
        print(("#%d — %s : %d$"):format(i, player.identifier, player.money))
    end
end, false)

-- Server statistics
RegisterCommand("stats", function()
    local totalPlayers = User.count()
    local totalMoney   = User.sum("money")
    local avgMoney     = User.avg("money")
    local richest      = User.max("money")

    print(("Players: %d | Total money: %d$ | Average: %d$ | Max: %d$"):format(
        totalPlayers, totalMoney, avgMoney, richest
    ))
end, false)

-- Players by job
RegisterCommand("jobstats", function()
    local stats = User.query()
        :select("job, COUNT(*) as nb, SUM(money) as total")
        :groupBy("job")
        :orderBy("nb", "DESC")
        :get()

    for _, s in ipairs(stats) do
        print(("%s : %d players, %d$ total"):format(s.job, s.nb, s.total))
    end
end, false)

---

Advanced Search

-- Search for players with combined filters
RegisterCommand("search", function(src, args)
    local results = User.query()
        :where({ job = { "IN", { "police", "medic" } } })
        :where({ money = { "BETWEEN", { 1000, 50000 } } })
        :where({ group = { "!=", "banned" } })
        :orderBy("money", "DESC")
        :limit(20)
        :get()

    print(#results .. " results found")
    for _, p in ipairs(results) do
        print(p.identifier .. " | " .. p.job .. " | " .. p.money .. "$")
    end
end, true)