Database and multi-server
SQLite, MySQL, Redis multi-server and taking backups safely.
Choosing a driver
database:
driver: "SQLITE"
host: "localhost"
database: "database"
username: ""
password: ""
port: 3306
use-ssl: false
use-extra-flags: false
flush-interval-seconds: 5
driver is not case-sensitive: MYSQL and mysql are the same. SQLite is the default and is correct for a single server: the file lives in the plugin folder and
needs no setup.
MySQL is required the moment more than one server needs to see the same farmers. Set driver to
MYSQL and fill in the connection details.
use-extra-flags should stay false unless UXPLIMA support tells you otherwise: it changes the
JDBC connection string, and the default string is the one that has been tested.
Multi-server
multi-server:
enabled: false
redis-host: ""
stream-retention-seconds: 300
stream-max-length: 20000
A shared MySQL database is not enough on its own. Two servers reading the same rows will each cache a farmer and each write over the other. Redis carries the messages that keep them in step: a change made on one server is announced to the others rather than discovered later.
The messages go through a Redis stream, so a server that loses its connection reads what it missed
when it reconnects. stream-retention-seconds is how far back it can catch up, and needs Redis 6.2
or newer; stream-max-length caps the stream on every Redis version, at about 250 bytes an entry.
A server that missed more than the stream holds reloads its farmers from the database instead.
Every server on the network runs the same uxmFarmer version. 4.0.0 renamed its Redis channels, so a 3.x.x server and a 4.0.0 server do not hear each other.
Enable both together, or neither:
| MySQL | Redis | Result |
|---|---|---|
| No | No | Single server, fine |
| Yes | No | Farmers appear on both servers and silently overwrite each other |
| Yes | Yes | Supported |
Saving
The database is the record of every farmer. Sales, withdrawals, upgrades and conversions are
decided and written in the database the moment they happen, under a lock on the farmer,
so two servers cannot spend the same stock twice. What the farmer collects is buffered and written
every flush-interval-seconds, and once more on shutdown.
/uxmfarmer save writes the buffer immediately, which is what to run before taking a backup.
Backups
Back up the plugin folder and, if you are on MySQL, the database. Both together: the configuration
and the data are separate, and a restored database with a mismatched
collected-materials.yml gives you farmers holding products that no longer have levels.
plugins/uxmFarmer/database.db is being written to. Copying it live can produce a file that opens
and is missing recent farmers. Run /uxmfarmer save, stop the server, then copy, or move to MySQL,
where your usual dump tooling handles this properly.
Migrating from SQLite to MySQL
There is no in-plugin migration. The reliable path on a live server is:
- Announce downtime and stop the server.
- Back up
plugins/uxmFarmer/in full. - Set up the MySQL database and user.
- Change
database.drivertoMYSQLand fill in the details. - Start the server: the schema is created automatically.
Existing SQLite farmers do not come across. Plan the switch for before launch, or open a ticket with UXPLIMA support if you need to move data that already exists.
Was this page helpful?