vSQLMySQL / MariaDB for FiveM

A modern, high-performance database resource - connection pooling, result caching, migrations, a built-in profiler, deadlock-safe transactions, and first-class MariaDB tuning. A drop-in successor to oxmysql.

Get started

Install

Recipes

GitHub

Two API styles

Every export works with a trailing callback or returns a Promise - use whichever fits the call site. No wrapper required from JS.

Safe parameters

Positional ? and named @name / :name, with automatic IN (?) expansion. Always bound by the driver, never interpolated - injection-safe by construction.

Result caching

Prepared-statement caching plus an optional TTL + LRU result cache. Writes invalidate it automatically; clear targeted entries with cacheClear(pattern).

Migrations

Checksum-validated, lock-protected, dry-run capable, with up / down support - discovered and applied on start, or driven from the vsql console command.

Profiler

Latency percentiles, a slow-query log, per-resource attribution, and pg_stat_statements-style query-shape ranking via vsql top.

MariaDB aware

utf8mb4 defaults, session + statement timeouts, and RETURNING detection with a graceful MySQL fallback. Auto-detects the server on connect.

Resilient

Auto-reconnect with backoff; queries issued during startup or a reconnect queue on whenReady() instead of failing. Transactions auto-retry on deadlock.

Drop-in compatible

Set vsql_compat to claim the oxmysql / ghmattimysql / mysql-async export namespaces, so existing scripts route into vSQL with no edits.

Fast by default

A memoised per-query binding plan makes parameter binding ~9x faster than oxmysql on reused queries - the common case in a running server.