Database Migration Tools - QBCore Guide for FiveM
Introduction
This tutorial turns Database Migration Tools into a clean, developer-friendly guide for QBCore/FiveM. You will follow a step-by-step flow, copy the relevant code patterns, and learn the “why” behind the setup.
Requirements
- QBCore installed and running on a dev server
- Basic Lua knowledge and comfort reading FiveM patterns
- A test workflow for iterating safely (dev server, not production)
- Optional: a code editor with Lua/FiveM helpers (VS Code recommended)
Step-by-Step Guide
Step 1: Overview
In this step, you will apply the overview concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 2: Quick Start
In this step, you will apply the quick start concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 3: 1. Download Migration Tools
In this step, you will apply the 1. download migration tools concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 4: 2. Configure Database Connection
In this step, you will apply the 2. configure database connection concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 5: 3. Run Pre-Migration Check
In this step, you will apply the 3. run pre-migration check concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 6: 4. Execute Migration
In this step, you will apply the 4. execute migration concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 7: Migration Scripts
In this step, you will apply the migration scripts concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Step 8: QBCore v1.0 to v2.0 Migration
In this step, you will apply the qbcore v1.0 to v2.0 migration concept as a practical change: define the pieces, wire them together, then verify the behavior in your dev server.
Code Example
# Clone the migration toolkit
git clone https://github.com/qbcore-framework/qb-migration-tools.git
cd qb-migration-tools
# Make scripts executable
chmod +x scripts/*.shTips & Best Practices
- Keep authority on the server: validate inputs before money/database operations.
- Start with one resource/module at a time, then refactor after you verify it works.
- Use callbacks for request/response flows and events for push/UX updates.
- When you run loops, avoid freezes: always yield with Wait() (client/server) and cache hot values.