Database Setup

ClearLaggEnhanced requires a database to store its operational data and statistics. You can choose between SQLite (easy setup) or MySQL (high performance).

SQLite (Default)

SQLite is the simplest option and is recommended for most servers. It creates a local file (clearlagg.db) in your plugin folder.

Configuration

database:
  enabled: true
  type: "sqlite"
  file: "clearlagg.db"

No additional setup is required.

MySQL

For large servers or networks with multiple instances, MySQL is the preferred choice.

Configuration

database:
  enabled: true
  type: "mysql"
  mysql:
    host: "localhost"
    port: 3306
    database: "clearlagg"
    username: "root"
    password: "your_password"
    ssl-mode: "PREFERRED"

Connection Pool Settings

You can fine-tune the connection pool settings (using HikariCP) in the pool section:

  pool:
    maximum-pool-size: 10
    minimum-idle: 2
    connection-timeout-ms: 10000
    idle-timeout-ms: 600000
    max-lifetime-ms: 1800000

Migration Note

Switching between database types (e.g., SQLite to MySQL) will change where new data is stored, but it will not automatically migrate your existing data. You will need to manually move the data if preservation is required.