Change database

/perplayerkit migrate <from> <to>

Permission: perplayerkit.admin. Works in game and from the console. The copy runs in the background while the server stays online.

Type	Use it for
`sqlite`	One server. The default.
`mysql`	A network, or a bigger server
`postgresql`	A network, or a bigger server
`redis`	A large, fast network
`yml`	Testing only. Never production.

/perplayerkit migrate sqlite mysql
/perplayerkit migrate sqlite postgresql
/perplayerkit migrate mysql redis
/perplayerkit migrate redis sqlite

Back up first. For SQLite, copy plugins/PerPlayerKit/database.db; for YAML, copy please-use-a-real-database.yml.

Step by step

Back up your data

Copy the file; for a managed database take a .

Put the new details in config.yml

Add the credentials and leave storage.type on the old database.

MySQL
PostgreSQL
Redis

config.yml

storage:
  mysql:
    host: localhost
    port: '3306'
    dbname: kitdatabase
    username: username
    password: pa55w0rd
    use-ssl: false
    maximum-pool-size: 10

config.yml

storage:
  postgresql:
    host: localhost
    port: '5432'
    dbname: kitdatabase
    username: username
    password: pa55w0rd
    use-ssl: false
    maximum-pool-size: 10

config.yml

storage:
  redis:
    host: localhost
    port: 6379
    password: pa55w0rd

Check the new database is reachable

Confirm it is running and reachable through any .

Run the migration

/perplayerkit migrate sqlite mysql

Progress prints to chat and console every 100 entries.

Wait for the success message

Watch for “Migration completed successfully!”.

Do not restart or change storage.type before that message appears.

Switch storage.type

config.yml

storage:
  type: mysql

Restart the server

Fully. A reload does not reconnect the plugin.

Check it worked

No storage errors at startup
A test account’s kits load
Saving a kit survives a relog
The kit room and public kits are intact
Every server on this database has the same kits.max-slots

Going back

The migration copies; the old database is untouched. To roll back, set storage.type to the old type and restart.

Problems

Symptom	Fix
Connection error during the migration	Check host, port, username, and password in `config.yml`. Confirm the database is running. For a remote database, open the port: `3306` MySQL, `5432` PostgreSQL, `6379` Redis. Set `use-ssl: false` to rule out .
Data is missing afterwards	Check the console for errors during the copy. Confirm the success message appeared before you changed `storage.type`, and that you did a full restart, not a reload.
The migration stopped part way	Run it again. Entries that already made it are overwritten and the missing ones filled in.
It refuses to run	The source and the destination cannot be the same type.

Start here

Features

Commands

Settings

Managing data

Common issues

For developers

Step by step

Check it worked

Going back

Problems

​Step by step

​Check it worked

​Going back

​Problems

Step by step

Check it worked

Going back

Problems