Astral Realms Documentation Help

Database Configuration

AstralSync uses a MariaDB database to store player snapshots. The connection is configured in plugins/AstralSync/database.properties, which is generated on first start.

Default database.properties

jdbcUrl=jdbc:mariadb://localhost:3306/sync?useSSL=false driverClassName=org.mariadb.jdbc.Driver dataSource.user=testuser dataSource.password=test623 poolName=AstralSync

Properties Reference

jdbcUrl

The full JDBC connection URL for your MariaDB instance.

Format:

jdbc:mariadb://<host>:<port>/<database>?<options>

Example with SSL disabled (typical for local/private networks):

jdbc:mariadb://localhost:3306/astralsync?useSSL=false

Example with SSL enabled:

jdbc:mariadb://db.example.com:3306/astralsync?useSSL=true&requireSSL=true

driverClassName

The JDBC driver class name. Do not change this unless you are switching database vendors.

driverClassName=org.mariadb.jdbc.Driver

dataSource.user

The MariaDB username used to authenticate.

dataSource.user=astralsync_user

dataSource.password

The MariaDB password for the configured user.

dataSource.password=your_secure_password_here

poolName

The name assigned to the HikariCP connection pool. Useful for identifying the pool in monitoring tools.

poolName=AstralSync

Database Schema

AstralSync creates and manages the snapshots table automatically on startup. No manual schema setup is required.

Column

Type

Description

unique_id

CHAR(36)

Primary key — snapshot UUID

user_id

CHAR(36)

Player UUID this snapshot belongs to

data

LONGBLOB

Compressed, serialized snapshot data

checksum

VARBINARY(32)

Integrity checksum (SHA-256)

cause

VARCHAR(32)

SnapshotCause enum value

created_at

BIGINT

Unix timestamp of creation

updated_at

BIGINT

Unix timestamp of last update

24 April 2026