Skip to main content
Version: CloudNet v3.5 🚧

Database-MySQL Module

By default, CloudNet uses H2 to store its data, this module replaces the H2 database with your MySQL database.
Without any modules, CloudNet will only store PermissionData in this database. The default modules extend this by PlayerData, Signs, and NPCs.

Configuration

database

This parameter does not need to be changed. It's value (mysql) has to be put in the local/registry file at the database_provider key to activate the MySQL-Database.

Warning

If you don't change this option, CloudNet will persist on H2 even if you put your correct credentials into the config.

addresses

This is a JsonArray of database addresses. You do not need to add an element if you do not have a MySQL cluster.

useSsl

Whether the module should use ssl to encrypt the connection to the database server

database

This is the database that the module uses to create the individual tables

host

The ip address the database server is bound on

port

The port your database server is listening to

username

This is the username which is used by this module to connect to your database server

password

This is the password which is used by this module to connect to your database server

Warning

useSsl, connectionPoolSize, connectionTimeout & validationTimeout should not be changed if you do not know what they are doing!

Sample Configuration

The default configuration of the Database-MySQL Module looks like this:

{
  "database": "mysql",
  "addresses": [
    {
      "useSsl": false,
      "database": "CloudNet",
      "address": {
        "host": "127.0.0.1",
        "port": 3306
      }
    }
  ],
  "username": "root",
  "password": "root",
  "connectionPoolSize": 15,
  "connectionTimeout": 5000,
  "validationTimeout": 5000
}