oxmysql for FiveM

At a glance

Figures read from the repository on 2026-09-22.

Why servers run it

• Prepared statements by default, which closes the SQL injection hole the older wrappers left wide open.
• Promise-based with await support, so database code reads top to bottom.
• Drop-in shims for mysql-async and ghmattimysql, so migration is incremental rather than a big bang.
• A built-in slow-query log, which is usually how you find the script quietly costing you 40ms a tick.

Installing oxmysql

1. 1. Start it first

   oxmysql has to be the first resource in server.cfg that touches the database.

2. 2. Set the connection string

   set mysql_connection_string in server.cfg, in either URI or key=value form. Do not put it in a config.lua that ends up in a public repository.

3. 3. Turn on the slow-query log

   set mysql_slow_query_warning 150 prints anything over 150ms with the query attached.

4. 4. Use the shim while migrating

   Old scripts keep working through the compatibility layer; convert them as you touch them rather than all at once.

Working examples

set mysql_connection_string "mysql://user:password@localhost:3306/fivem?charset=utf8mb4"
set mysql_slow_query_warning 150
set mysql_debug false

-- Single row
local row = MySQL.single.await(
    'SELECT citizenid, charinfo FROM players WHERE license = ?', { license })

-- Many rows
local screens = MySQL.query.await(
    'SELECT slug, title FROM loading_screens WHERE owner = ?', { userId })

-- Insert, returning the new id
local id = MySQL.insert.await(
    'INSERT INTO loading_screens (owner, slug, title) VALUES (?, ?, ?)',
    { userId, slug, title })

MySQL.transaction.await({
    { query = 'UPDATE accounts SET balance = balance - ? WHERE id = ?', values = { 500, from } },
    { query = 'UPDATE accounts SET balance = balance + ? WHERE id = ?', values = { 500, to } },
})

What goes wrong

oxmysql — questions people ask

Runs alongside