mtdb

README

Minetest database repositories for the golang ecosystem

Docs: https://pkg.go.dev/github.com/minetest-go/mtdb

Features

• Read and write users/privs from and to the auth database
• Read and write from and to the map database
• Read and write from the mod_storage database

Supported databases:

• Sqlite3 (auth,blocks,mod_storage)
• Postgres (auth.blocks)

License

Code: MIT

Documentation

Index

• Constants
• func CoordToPlain(x, y, z int) int64
• func EnableWAL(db *sql.DB) error
• func MigrateAuthDB(db *sql.DB, dbtype DatabaseType) error
• func MigrateBlockDB(db *sql.DB, dbtype DatabaseType) error
• func MigrateModStorageDB(db *sql.DB, dbtype DatabaseType) error
• func MigratePlayerDB(db *sql.DB, dbtype DatabaseType) error
• func PlainToCoord(i int64) (x, y, z int)
• type AuthEntry
• type AuthRepository
  • func NewAuthRepository(db *sql.DB, dbtype DatabaseType) *AuthRepository
  • func (repo *AuthRepository) Count(s *AuthSearch) (int, error)
  • func (repo *AuthRepository) Create(entry *AuthEntry) error
  • func (repo *AuthRepository) Delete(id int64) error
  • func (repo *AuthRepository) GetByUsername(username string) (*AuthEntry, error)
  • func (repo *AuthRepository) Search(s *AuthSearch) ([]*AuthEntry, error)
  • func (repo *AuthRepository) Update(entry *AuthEntry) error
• type AuthSearch
• type Block
• type BlockRepository
  • func NewBlockRepository(db *sql.DB, dbtype DatabaseType) BlockRepository
• type Context
  • func New(world_dir string) (*Context, error)
  • func (ctx *Context) Close()
• type DatabaseType
• type ModStorageEntry
• type ModStorageRepository
  • func NewModStorageRepository(db *sql.DB, dbtype DatabaseType) ModStorageRepository
• type Player
• type PlayerInventories
• type PlayerInventoryItems
• type PlayerMetadata
• type PlayerRepository
  • func NewPlayerRepository(db *sql.DB, dbtype DatabaseType) *PlayerRepository
  • func (r *PlayerRepository) GetPlayer(name string) (*Player, error)
• type PrivRepository
  • func NewPrivilegeRepository(db *sql.DB, dbtype DatabaseType) *PrivRepository
  • func (repo *PrivRepository) Create(entry *PrivilegeEntry) error
  • func (repo *PrivRepository) Delete(id int64, privilege string) error
  • func (repo *PrivRepository) GetByID(id int64) ([]*PrivilegeEntry, error)
• type PrivilegeEntry

Examples

• Context

Constants

const (
	MinPlainCoord = -34351347711
)

https://bitbucket.org/s_l_teichmann/mtsatellite/src/e1bf980a2b278c570b3f44f9452c9c087558acb3/common/coords.go?at=default&fileviewer=file-view-default

Functions

func CoordToPlain

func CoordToPlain(x, y, z int) int64

func EnableWAL

func EnableWAL(db *sql.DB) error

func MigrateAuthDB

func MigrateAuthDB(db *sql.DB, dbtype DatabaseType) error

func MigrateBlockDB

func MigrateBlockDB(db *sql.DB, dbtype DatabaseType) error

func MigrateModStorageDB

func MigrateModStorageDB(db *sql.DB, dbtype DatabaseType) error

func MigratePlayerDB

func MigratePlayerDB(db *sql.DB, dbtype DatabaseType) error

func PlainToCoord

func PlainToCoord(i int64) (x, y, z int)

Types

type AuthEntry

type AuthEntry struct {
	ID        *int64 `json:"id"`
	Name      string `json:"name"`
	Password  string `json:"password"`
	LastLogin int    `json:"last_login"`
}

type AuthRepository

type AuthRepository struct {
	// contains filtered or unexported fields
}

func NewAuthRepository

func NewAuthRepository(db *sql.DB, dbtype DatabaseType) *AuthRepository

func (*AuthRepository) Count

func (repo *AuthRepository) Count(s *AuthSearch) (int, error)

func (*AuthRepository) Create

func (repo *AuthRepository) Create(entry *AuthEntry) error

func (*AuthRepository) Delete

func (repo *AuthRepository) Delete(id int64) error

func (*AuthRepository) GetByUsername

func (repo *AuthRepository) GetByUsername(username string) (*AuthEntry, error)

func (*AuthRepository) Search

func (repo *AuthRepository) Search(s *AuthSearch) ([]*AuthEntry, error)

func (*AuthRepository) Update

func (repo *AuthRepository) Update(entry *AuthEntry) error

type AuthSearch

type AuthSearch struct {
	Usernamelike *string `json:"usernamelike"`
	Username     *string `json:"username"`
}

type Block

type Block struct {
	PosX int
	PosY int
	PosZ int
	Data []byte
}

type BlockRepository

type BlockRepository interface {
	GetByPos(x, y, z int) (*Block, error)
	Update(block *Block) error
	Delete(x, y, z int) error
}

func NewBlockRepository

func NewBlockRepository(db *sql.DB, dbtype DatabaseType) BlockRepository

type Context

type Context struct {
	Auth       *AuthRepository
	Privs      *PrivRepository
	Player     *PlayerRepository
	Blocks     BlockRepository
	ModStorage ModStorageRepository
	// contains filtered or unexported fields
}

Example

package main

import (
	"fmt"

	"github.com/minetest-go/mtdb"
)

func main() {
	// create a new context (an object with all repositories) from a minetest world-directory
	ctx, err := mtdb.New("/xy")
	if err != nil {
		panic(err)
	}

	// retrieve an auth entry of the "admin" user
	entry, err := ctx.Auth.GetByUsername("admin")
	if err != nil {
		panic(err)
	}

	fmt.Printf("Admin password-entry: %s\n", entry.Password)

	// retrieve admin's privileges
	privs, err := ctx.Privs.GetByID(*entry.ID)
	for _, priv := range privs {
		fmt.Printf(" + %s\n", priv.Privilege)
	}

	// get a mapblock from the database
	block, err := ctx.Blocks.GetByPos(0, 0, 0)
	if err != nil {
		panic(err)
	}
	// dump the raw and unparsed binary data
	// use the github.com/minetest-go/mapparser project to parse the actual content
	fmt.Printf("Mapblock content: %s\n", block.Data)
}

func New

func New(world_dir string) (*Context, error)

parses the "world.mt" file in the world-dir and creates a new context

func (*Context) Close

func (ctx *Context) Close()

closes all database connections

type DatabaseType

type DatabaseType string

const (
	DATABASE_SQLITE   DatabaseType = "sqlite"
	DATABASE_POSTGRES DatabaseType = "postgres"
)

type ModStorageEntry

type ModStorageEntry struct {
	ModName string `json:"modname"`
	Key     []byte `json:"key"`
	Value   []byte `json:"value"`
}

internal name: "entries"

type ModStorageRepository

type ModStorageRepository interface {
	Get(modname string, key []byte) (*ModStorageEntry, error)
	Create(entry *ModStorageEntry) error
	Update(entry *ModStorageEntry) error
	Delete(modname string, key []byte) error
}

func NewModStorageRepository

func NewModStorageRepository(db *sql.DB, dbtype DatabaseType) ModStorageRepository

type Player

type Player struct {
	Name             string  `json:"name"`
	Pitch            float64 `json:"pitch"`
	Yaw              float64 `json:"yaw"`
	PosX             float64 `json:"posx"`
	PosY             float64 `json:"posy"`
	PosZ             float64 `json:"posz"`
	HP               int     `json:"hp"`
	Breath           int     `json:"breath"`
	CreationDate     int64   `json:"creation_date"`
	ModificationDate int64   `json:"modification_date"`
}

type PlayerInventories

type PlayerInventories struct {
	Player   string `json:"player"`
	InvID    int    `json:"inv_id"`
	InvWidth int    `json:"inv_width"`
	InvName  string `json:"inv_name"`
	InvSize  int    `json:"inv_size"`
}

type PlayerInventoryItems

type PlayerInventoryItems struct {
	Player string `json:"player"`
	InvID  int    `json:"inv_id"`
	SlotID int    `json:"slot_id"`
	Item   string `json:"item"`
}

type PlayerMetadata

type PlayerMetadata struct {
	Player   string `json:"player"`
	Metadata string `json:"metadata"`
	Value    string `json:"value"`
}

type PlayerRepository

type PlayerRepository struct {
	// contains filtered or unexported fields
}

func NewPlayerRepository

func NewPlayerRepository(db *sql.DB, dbtype DatabaseType) *PlayerRepository

func (*PlayerRepository) GetPlayer

func (r *PlayerRepository) GetPlayer(name string) (*Player, error)

type PrivRepository

type PrivRepository struct {
	// contains filtered or unexported fields
}

func NewPrivilegeRepository

func NewPrivilegeRepository(db *sql.DB, dbtype DatabaseType) *PrivRepository

func (*PrivRepository) Create

func (repo *PrivRepository) Create(entry *PrivilegeEntry) error

func (*PrivRepository) Delete

func (repo *PrivRepository) Delete(id int64, privilege string) error

func (*PrivRepository) GetByID

func (repo *PrivRepository) GetByID(id int64) ([]*PrivilegeEntry, error)

type PrivilegeEntry

type PrivilegeEntry struct {
	ID        int64  `json:"id"`
	Privilege string `json:"privilege"`
}