Storage backends

Claimo stores redemption counts — global pools and per-player usage — in a backend you choose under storage: in config.yml.

Restart required

Changing storage.type requires a server restart, not just /code reload.

Choosing a backend

Single server, no setup

Use yaml or sqlite — nothing to install, data stays local.

Multiple servers

Use mysql, postgresql or mongodb so a shared database keeps pools consistent across a network.

type	Setup	Best for
yaml	None → plugins/Claimo/usage.yml	Single server, human-readable
sqlite	None → plugins/Claimo/data.db	Single server, more robust than YAML
mysql	Shared database	Multi-server networks
postgresql	Shared database	Multi-server networks
mongodb	Shared database	Multi-server networks

MariaDB

MariaDB is served by the mysql backend — its driver speaks the MariaDB protocol — so either mysql or mariadb works as the type.

Configuration

The host, port, database, username, password, table-prefix and pool-size keys apply to the network backends (mysql / postgresql / mongodb). The local backends ignore them.

YAML / SQLite

Zero setup — just pick the type. Data lives in the plugin folder.

config.yml

storage:
  type: yaml     # or: sqlite

MySQL / MariaDB

config.yml

storage:
  type: mysql
  host: localhost
  port: 3306
  database: claimo
  username: root
  password: "secret"
  table-prefix: claimo_
  pool-size: 10

PostgreSQL

config.yml

storage:
  type: postgresql
  host: localhost
  port: 5432
  database: claimo
  username: postgres
  password: "secret"
  table-prefix: claimo_
  pool-size: 10

MongoDB

config.yml

storage:
  type: mongodb
  # A full connection string overrides host/port/credentials when set.
  uri: "mongodb+srv://user:pass@cluster.example.net"
  database: claimo
  table-prefix: claimo_

Key reference

Key	Applies to	Meaning
type	all	The backend. yaml, sqlite, mysql, postgresql or mongodb.
uri	mongodb	Full connection string (e.g. mongodb+srv://…). When set, it overrides host/port/credentials.
host / port	network	Server address.
database	network	Database (Mongo: which database) to use.
username / password	network	Credentials.
table-prefix	network	Prefix for tables (Mongo: collections).
pool-size	network	Connection pool size.

MongoDB URI vs fields

For MongoDB you may set uri to a full connection string. When present it overrides host/port/credentials, while database still selects the database and table-prefix still prefixes the collections.