database.yml

# ============================================================================
# VHoppers database configuration
# ----------------------------------------------------------------------------
# This file controls only storage and SQL connection details.
#
# Supported storage types:
# - LOCAL   = JSON files
# - MYSQL   = MySQL backend
# - MARIADB = MariaDB backend
# - H2      = embedded SQL backend
#
# Runtime behavior:
# - Data is loaded when the plugin starts.
# - Changes are kept in memory first.
# - Data is flushed automatically every 5 minutes.
# - Data is flushed again when the plugin shuts down.
# ============================================================================

# Internal config format version. Used for future automatic config upgrades.
config-version: 1

# Storage backend and connection settings.
storage:
  # Active storage backend.
  # LOCAL writes JSON files under plugins/VHoppers/storage.
  # LOCAL is intended for small/test servers. Use H2, MYSQL, or MARIADB for
  # production servers with many hoppers to reduce JSON rewrite IO and GC.
  # MYSQL, MARIADB, and H2 write to SQL tables.
  Type: LOCAL

  # Hostname or IP address for MYSQL and MARIADB.
  # Ignored by LOCAL and ignored when Jdbc Url is set.
  Hostname: 172.168.0.1

  # SQL port for MYSQL and MARIADB.
  # Common default: 3306.
  Port: 3306

  # SQL username used by MYSQL and MARIADB.
  Username: minecraft

  # SQL password used by MYSQL and MARIADB.
  Password: ""

  # Database name or schema used by MYSQL and MARIADB.
  Database: minecraft

  # HikariCP maximum connection pool size.
  # Higher values can help busy servers, but each connection costs database resources.
  Pool Size: 5

  # Adds SSL options to generated MYSQL and MARIADB JDBC URLs.
  # Ignored when Jdbc Url is set.
  Use SSL: false

  # Optional full JDBC URL override.
  # Leave empty to let the plugin build the URL automatically.
  Jdbc Url: ""

  # Optional explicit JDBC driver class override.
  # Leave empty to use the default driver for the selected storage Type.
  Driver Class: ""

  # Prefix added before every VHoppers SQL table name.
  # The plugin currently creates one table for hopper records:
  # <Prefix>hoppers
  Prefix: vhoppers_