Docs / Admin Guide

Admin Guide

This guide covers day-to-day administration of Maree-DB: the admin portal, CLI commands, user management, and backup/restore.

Admin Portal

The admin portal is accessible via the REST API port (default 8080) at http://localhost:8080/admin. It provides a web UI for:

Monitoring connections, query throughput, and resource usage
Managing users and roles
Viewing and managing databases and tables
Running queries in the built-in SQL editor
Reviewing health check results
Managing backups
Cluster management (Enterprise tier)

CLI Reference

Command	Description
maree-db-server start	Start the database server.
maree-db-server stop	Gracefully stop the server.
maree-db-server restart	Restart the server.
maree-db-server status	Show server status and connection counts.
maree-db-server verify --all	Run self-verification benchmarks.
maree-db-server health-check	Run health check manually.
maree-db-server backup create	Create a new backup.
maree-db-server backup restore	Restore from a backup.
maree-db-cli user create	Create a new database user.
maree-db-cli user list	List all users.
maree-db-cli user set-password	Change a user's password.
maree-db-cli user grant	Grant role or permission to user.
maree-db-cli user revoke	Revoke role or permission from user.
maree-db-cli licence activate	Activate a licence key.
maree-db-cli licence info	Show current licence details.
maree-db-cli hardware-id	Print Hardware ID for offline activation.
maree-db-cli migrate	Run migration wizard.

User Management

# Create a new user
maree-db-cli user create \
  --username appuser \
  --password "secure_password" \
  --role read_write

# Or via SQL:
CREATE USER appuser WITH PASSWORD 'secure_password';
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO appuser;

# Create a read-only user
CREATE USER readonly WITH PASSWORD 'secure_password';
GRANT SELECT ON ALL TABLES IN SCHEMA public TO readonly;

# List all users
SELECT username, role, created_at FROM _system.users;

Backup and Restore

# Create a full backup
maree-db-server backup create \
  --output /backup/mareedb-$(date +%Y%m%d).backup

# Create an incremental backup (since last full)
maree-db-server backup create --incremental \
  --output /backup/mareedb-incremental-$(date +%Y%m%d-%H%M).backup

# List available backups
maree-db-server backup list

# Restore from backup
maree-db-server backup restore \
  --input /backup/mareedb-20260601.backup

# Restore to a specific point in time
maree-db-server backup restore \
  --input /backup/mareedb-20260601.backup \
  --point-in-time "2026-06-01 14:30:00"

Monitoring

# View current connections
SELECT * FROM _system.connections;

# View active queries
SELECT * FROM _system.active_queries;

# View query statistics
SELECT * FROM _system.query_stats
  ORDER BY avg_duration_ms DESC LIMIT 20;

# Prometheus metrics endpoint
curl http://localhost:8080/metrics